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

Issue 10082038: Hack together a quick doc generator for IDL files. (Closed)

Created:
8 years, 8 months ago by Matt Perry
Modified:
8 years, 8 months ago
CC:
chromium-reviews, Aaron Boodman, pam+watch_chromium.org, mihaip+watch_chromium.org
Visibility:
Public.

Description

Hack together a quick doc generator for IDL files. - Changed the IDL parser to mine the Comment nodes, and process them for parameter comments. - Added hacks to the doc builder to parse the IDL files and spit out a generated JSON file before running the generator. BUG=no TEST=no Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=132474

Patch Set 1 #

Total comments: 2

Patch Set 2 : asargent #

Patch Set 3 : separate alarms change #

Unified diffs Side-by-side diffs Delta from patch set Stats (+299 lines, -79 lines) Patch
M chrome/common/extensions/docs/build/build.py View 4 chunks +10 lines, -1 line 0 comments Download
M chrome/common/extensions/docs/build/directory.py View 4 chunks +67 lines, -15 lines 0 comments Download
M chrome/common/extensions/docs/experimental.alarms.html View 1 15 chunks +162 lines, -60 lines 0 comments Download
M chrome/common/extensions/docs/samples.json View 1 3 chunks +24 lines, -0 lines 0 comments Download
M tools/json_schema_compiler/idl_schema.py View 1 3 chunks +36 lines, -3 lines 0 comments Download

Messages

Total messages: 3 (0 generated)
Matt Perry
8 years, 8 months ago (2012-04-14 01:30:41 UTC) #1
asargent_no_longer_on_chrome
LGTM, thanks for doing this. http://codereview.chromium.org/10082038/diff/1/tools/json_schema_compiler/idl_schema.py File tools/json_schema_compiler/idl_schema.py (right): http://codereview.chromium.org/10082038/diff/1/tools/json_schema_compiler/idl_schema.py#newcode29 tools/json_schema_compiler/idl_schema.py:29: '': "The processed comment, ...
8 years, 8 months ago (2012-04-16 17:34:11 UTC) #2
Matt Perry
8 years, 8 months ago (2012-04-16 19:19:15 UTC) #3
http://codereview.chromium.org/10082038/diff/1/tools/json_schema_compiler/idl...
File tools/json_schema_compiler/idl_schema.py (right):

http://codereview.chromium.org/10082038/diff/1/tools/json_schema_compiler/idl...
tools/json_schema_compiler/idl_schema.py:29: '': "The processed comment, minus
all |parameter| mentions.",
On 2012/04/16 17:34:11, Antony Sargent wrote:
> nit: using the empty string as a key makes the code a little hard to read. Can
> you use something like 'SUMMARY' or 'OVERVIEW' or '_SUMMARY_' instead?

I had it return a tuple of (summary_comment, parsed_comments) instead.

Powered by Google App Engine
This is Rietveld 408576698