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

Unified Diff: chrome/browser/extensions/api/README.txt

Issue 11747025: Run the JSON Schema Compiler's bundle compilation on JSON files. Previously it (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: fix ms release build Created 7 years, 11 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 side-by-side diff with in-line comments
Download patch
Index: chrome/browser/extensions/api/README.txt
diff --git a/chrome/browser/extensions/api/README.txt b/chrome/browser/extensions/api/README.txt
index 74d72d6295f00b1c89765b8cf3522bab77941de0..8f767ef0f51cd956d14a9f92ea10c8c9d2097a5a 100644
--- a/chrome/browser/extensions/api/README.txt
+++ b/chrome/browser/extensions/api/README.txt
@@ -19,23 +19,15 @@ Create "chrome/common/extensions/api/experimental_foo.json". For inspiration
look at the "app" API. Include descriptions fields to generate the
documentation.
-2) Add your API specification to extensions_api_resources.grd.
-Add an "<include ...>" line with your JSON specification file to
-"chrome/common/extensions_api_resources.grd".
-
-3) Add your API specification to api.gyp.
-Add "experimental_foo.json" to the "json_schema_files" section in
+2) Add your API specification to api.gyp.
+Add "experimental_foo.json" to the "schema_files" section in
"chrome/common/extensions/api/api.gyp".
-4) Write the API function handlers.
+3) Write the API function handlers.
Create foo_api.cc and foo_api.h under "chrome/browser/extensions/api/foo". You
should use the JSON Schema Compiler. Look at the "permissions_api.cc" for
details on how to do that.
-5) Register function handlers.
-In "chrome/browser/extensions/extension_function_registry.cc" include foo_api.h
-and instantiate a RegisterFunction for each function you created in (3).
-
--------------------------------------------------------------------------------
APPROACH 2: IDL FILES
@@ -45,7 +37,7 @@ at "alarms.idl". Include comments, they will be used to automatically generate
the documentation.
2) Add your API specification to api.gyp.
-Add "experimental_foo.idl" to the "idl_schema_files" section in
+Add "experimental_foo.idl" to the "schema_files" section in
"chrome/common/extensions/api/api.gyp".
3) Write the API function handlers.
@@ -53,8 +45,6 @@ Create foo_api.cc and foo_api.h under "chrome/browser/extensions/api/foo". You
should use the JSON Schema Compiler. Look at the "alarms_api.cc" for details on
how to do that.
-4-5) Nothing to do! Function handlers are automatically registered for you.
-
--------------------------------------------------------------------------------
STEPS COMMON TO BOTH APPROACHES
@@ -70,32 +60,10 @@ The files you created in (3) and (5) should be added to
--------------------------------------------------------------------------------
GENERATING DOCUMENTATION
-8) Build the project. (Only required if you used IDL files.)
-If you used IDL files, you need to build the project once in order for the
-documentation to be properly generated. Do this now. (This is required in order
-to generate the JSON file used to generate documentation.)
-
-9) Add your JSON file to the documentation controller
-Open "chrome/common/extensions/docs/js/api_page_generator.js" and add a line
-referring to "../api/experimental_foo.json". Do this even if you used the IDL
-approach as this JSON file has been generated in (7).
-
-10) Write the static HTML page.
-Write a small snippet of static HTML describing your API in
-"chrome/common/extensions/docs/static/experimental.foo.html". For the moment,
-just include the following in this file, adjusting it to describe your API:
-
- <div id="pageData-name" class="pageData">Experimental Foo APIs</div>
-
- <!-- BEGIN AUTHORED CONTENT -->
- <p>The current methods allow applications to...</p>
- <!-- END AUTHORED CONTENT -->
+8) Add a stub template in ../docs/templates/public corresponding to your API.
+See other templates for inspiration.
-11) Build the documentation.
-You will need to build DumpRenderTree once before you can build the
-documentation. Once this is done, from "chrome/common/extensions/docs" run
-"build/build.py". For more information on building documentation see README.txt
-in "chrome/common/extensions/docs".
+9) Run ../docs/templates/server2/preview.py to view the generated documentation.
--------------------------------------------------------------------------------
WRITING TESTS

Powered by Google App Engine
This is Rietveld 408576698