Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(151)

Side by Side Diff: utils/apidoc/mdn/README.txt

Issue 10915125: Allow apidoc to skip MDN database.json entries that are bogus. (Closed) Base URL: http://dart.googlecode.com/svn/branches/bleeding_edge/dart/
Patch Set: Created 8 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « utils/apidoc/apidoc.dart ('k') | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 ***** Current status 1 ***** Current status
2 2
3 Currently it runs all the way through, but the database.json has all 3 Currently it runs all the way through, but the database.json has all
4 members[] lists empty. Most entries are skipped for "Suspect title"; 4 members[] lists empty. Most entries are skipped for "Suspect title";
5 some have ".pageText not found". 5 some have ".pageText not found".
6 6
7 Currently only works on Linux; OS X (or other) will need minor path changes. 7 Currently only works on Linux; OS X (or other) will need minor path changes.
8 8
9 You will need a reasonably modern node.js installed. 9 You will need a reasonably modern node.js installed.
10 0.5.9 is too old; 0.8.8 is not too old. 10 0.5.9 is too old; 0.8.8 is not too old.
11 11
12 I needed to add my own "DumpRenderTree_resources/missingImage.gif", 12 I needed to add my own "DumpRenderTree_resources/missingImage.gif",
13 for some reason. 13 for some reason.
14 14
15 For the reasons above, we're currently just using the checked-in
16 database.json from Feb 2012, but it has some bogus entries. In
17 particular, the one for UnknownElement would inject irrelevant German
18 text into our docs. So a hack in apidoc.dart (_mdnTypeNamesToSkip)
19 works around this.
20
15 ***** Overview 21 ***** Overview
16 22
17 Here's a rough walkthrough of how this works. The ultimate output file is 23 Here's a rough walkthrough of how this works. The ultimate output file is
18 database.filtered.json. 24 database.filtered.json.
19 25
20 full_run.sh executes all of the scripts in the correct order. 26 full_run.sh executes all of the scripts in the correct order.
21 27
22 search.js 28 search.js
23 - read data/domTypes.json 29 - read data/domTypes.json
24 - for each dom type: 30 - for each dom type:
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after
61 - run postProcess.dart 67 - run postProcess.dart
62 - go through the results for each type looking for the best match 68 - go through the results for each type looking for the best match
63 - write output/database.html 69 - write output/database.html
64 - write output/examples.html 70 - write output/examples.html
65 - write output/obsolete.html 71 - write output/obsolete.html
66 - write output/database.filtered.json which is the best matches 72 - write output/database.filtered.json which is the best matches
67 73
68 ***** Process for updating database.json using these scripts. 74 ***** Process for updating database.json using these scripts.
69 75
70 TODO(eub) when I get the scripts to work all the way through. 76 TODO(eub) when I get the scripts to work all the way through.
OLDNEW
« no previous file with comments | « utils/apidoc/apidoc.dart ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698