From 97ae3d0ca962b72e529c118523371f2635a39716 Mon Sep 17 00:00:00 2001 From: Alex Eagle Date: Fri, 2 Oct 2015 14:44:57 -0700 Subject: [PATCH] chore(docs): rename @private to @internal This change corresponds to https://github.com/angular/angular/pull/4477 --- public/api-builder/angular.io-package/index.js | 4 ++++ .../processors/addJadeDataDocsProcessor.js | 2 +- .../angular.io-package/templates/class.template.html | 2 +- public/api-builder/docs-package/index.js | 3 +++ .../docs-package/processors/generateNavigationDoc.js | 2 +- .../api-builder/docs-package/templates/class.template.html | 2 +- .../api-builder/docs-package/templates/module.template.html | 2 +- .../services/convertPrivateClassesToInterfaces.js | 4 ++-- .../services/convertPrivateClassesToInterfaces.spec.js | 6 +++--- 9 files changed, 17 insertions(+), 10 deletions(-) diff --git a/public/api-builder/angular.io-package/index.js b/public/api-builder/angular.io-package/index.js index 54b4f841c9..7d2b21dd27 100644 --- a/public/api-builder/angular.io-package/index.js +++ b/public/api-builder/angular.io-package/index.js @@ -16,6 +16,10 @@ module.exports = new Package('angular.io', [basePackage]) .unshift(path.resolve(__dirname, 'templates')); }) +.config(function(parseTagsProcessor) { + parseTagsProcessor.tagDefinitions.push({ name: 'internal', transforms: function() { return true; } }); +}) + .config(function(readTypeScriptModules, writeFilesProcessor, readFilesProcessor) { readTypeScriptModules.sourceFiles = [ diff --git a/public/api-builder/angular.io-package/processors/addJadeDataDocsProcessor.js b/public/api-builder/angular.io-package/processors/addJadeDataDocsProcessor.js index 7eaaeb3241..677098f3c7 100644 --- a/public/api-builder/angular.io-package/processors/addJadeDataDocsProcessor.js +++ b/public/api-builder/angular.io-package/processors/addJadeDataDocsProcessor.js @@ -35,7 +35,7 @@ module.exports = function addJadeDataDocsProcessor() { */ _.forEach(docs, function(doc) { - if (doc.docType === 'module' && !doc.private && doc.exports.length) { + if (doc.docType === 'module' && !doc.internal && doc.exports.length) { modules.push(doc); // GET DATA FOR INDEX PAGE OF MODULE SECTION diff --git a/public/api-builder/angular.io-package/templates/class.template.html b/public/api-builder/angular.io-package/templates/class.template.html index 08a8ee3c08..9db96ff52c 100644 --- a/public/api-builder/angular.io-package/templates/class.template.html +++ b/public/api-builder/angular.io-package/templates/class.template.html @@ -43,7 +43,7 @@ p.location-badge. {% endif -%} -{%- for member in doc.members %}{% if not member.private %} +{%- for member in doc.members %}{% if not member.internal %} .l-sub-section h3#{$ member.name | toId $} {$ member.name $}{% if member.optional %}?{% endif %} diff --git a/public/api-builder/docs-package/index.js b/public/api-builder/docs-package/index.js index 2c408ad299..f931b9dd33 100644 --- a/public/api-builder/docs-package/index.js +++ b/public/api-builder/docs-package/index.js @@ -25,6 +25,9 @@ module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage, log.level = 'info'; }) +.config(function(parseTagsProcessor) { + parseTagsProcessor.tagDefinitions.push({ name: 'internal', transforms: function() { return true; } }); +}) .config(function(renderDocsProcessor, versionInfo) { renderDocsProcessor.extraData.versionInfo = versionInfo; diff --git a/public/api-builder/docs-package/processors/generateNavigationDoc.js b/public/api-builder/docs-package/processors/generateNavigationDoc.js index 5e8ecf7149..c2c75d5533 100644 --- a/public/api-builder/docs-package/processors/generateNavigationDoc.js +++ b/public/api-builder/docs-package/processors/generateNavigationDoc.js @@ -27,7 +27,7 @@ module.exports = function generateNavigationDoc() { modulesDoc.value.sections.push(moduleNavItem); _.forEach(doc.exports, function(exportDoc) { - if (!exportDoc.private) { + if (!exportDoc.internal) { var exportNavItem = { path: exportDoc.path, partial: exportDoc.outputPath, diff --git a/public/api-builder/docs-package/templates/class.template.html b/public/api-builder/docs-package/templates/class.template.html index a015cf5e7e..f0fc6b2801 100644 --- a/public/api-builder/docs-package/templates/class.template.html +++ b/public/api-builder/docs-package/templates/class.template.html @@ -28,7 +28,7 @@ defined in {$ githubViewLink(doc) $} {% endif -%} -{%- for member in doc.members %}{% if not member.private %} +{%- for member in doc.members %}{% if not member.internal %}

{$ member.name $}{% if member.optional %}?{% endif %}{$ paramList(member.params) $} diff --git a/public/api-builder/docs-package/templates/module.template.html b/public/api-builder/docs-package/templates/module.template.html index c016075c48..34ab0f67ab 100644 --- a/public/api-builder/docs-package/templates/module.template.html +++ b/public/api-builder/docs-package/templates/module.template.html @@ -10,7 +10,7 @@

Exports