diff options
author | kalman@chromium.org <kalman@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2012-02-13 23:21:44 +0000 |
---|---|---|
committer | kalman@chromium.org <kalman@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2012-02-13 23:21:44 +0000 |
commit | 0e9e1dc7b36fbc803e21544493e23e1c319f3f69 (patch) | |
tree | 3f6dc53f728f5dd753c47a325b9f9a886ae002b4 /chrome/common/extensions/docs/js/api_page_generator.js | |
parent | 4bd6a2899b9c1c0f1e20cbd171b8b10694ffabcb (diff) | |
download | chromium_src-0e9e1dc7b36fbc803e21544493e23e1c319f3f69.zip chromium_src-0e9e1dc7b36fbc803e21544493e23e1c319f3f69.tar.gz chromium_src-0e9e1dc7b36fbc803e21544493e23e1c319f3f69.tar.bz2 |
Allow "internal" APIs to be specified in extension API schemas, and specify the Declarative API as internal.
BUG=
TEST=browser_tests
Review URL: https://chromiumcodereview.appspot.com/9309114
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@121757 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/common/extensions/docs/js/api_page_generator.js')
-rw-r--r-- | chrome/common/extensions/docs/js/api_page_generator.js | 27 |
1 files changed, 12 insertions, 15 deletions
diff --git a/chrome/common/extensions/docs/js/api_page_generator.js b/chrome/common/extensions/docs/js/api_page_generator.js index 71ccc11..13f7d85 100644 --- a/chrome/common/extensions/docs/js/api_page_generator.js +++ b/chrome/common/extensions/docs/js/api_page_generator.js @@ -260,10 +260,9 @@ function fetchContent(url, onSuccess, onError) { function renderTemplate() { schema.forEach(function(mod) { if (mod.namespace == pageBase) { - // Do not render page for modules which are marked as "nodoc": true. - if (mod.nodoc) { + // Do not render page for modules which have documentation disabled. + if (disableDocs(mod)) return; - } // This page is an api page. Setup types and apiDefinition. module = mod; apiModuleName = API_MODULE_PREFIX + module.namespace; @@ -425,7 +424,8 @@ function selectCurrentPageOnLeftNav() { function stableAPIs() { return schema.filter(function(module) { - return !module.nodoc && module.namespace.indexOf('experimental') < 0; + return !disableDocs(module) && + module.namespace.indexOf('experimental') < 0; }).map(function(module) { return module.namespace; }).sort(); @@ -433,15 +433,8 @@ function stableAPIs() { function experimentalAPIs() { return schema.filter(function(module) { - return !module.nodoc && module.namespace.indexOf('experimental') == 0; - }).map(function(module) { - return module.namespace; - }).sort(); -} - -function devtoolsAPIs() { - return schema.filter(function(module) { - return !module.nodoc && module.namespace.indexOf('devtools.') === 0; + return !disableDocs(module) && + module.namespace.indexOf('experimental') == 0; }).map(function(module) { return module.namespace; }).sort(); @@ -603,8 +596,8 @@ function getPropertyListFromObject(object) { } for (var p in properties) { var prop = properties[p]; - // Do not render properties marked as "nodoc": true. - if (prop.nodoc) { + // Do not render properties with documentation disabled. + if (disableDocs(prop)) { continue; } prop.name = p; @@ -672,3 +665,7 @@ function sortByName(a, b) { } return 0; } + +function disableDocs(obj) { + return !!obj.nodoc || !!obj.internal; +} |