Skip to content

Commit 0658d56

Browse files
petebacondarwinmhevery
authored andcommitted
chore(doc-gen): ignore exports marked as @Private
Closes angular#1363
1 parent 458213d commit 0658d56

File tree

4 files changed

+16
-7
lines changed

4 files changed

+16
-7
lines changed

docs/dgeni-package/index.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ module.exports = new Package('angular', [jsdocPackage, nunjucksPackage])
6868

6969
.config(function(parseTagsProcessor, getInjectables) {
7070
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/public'));
71+
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/private'));
7172
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/exportedAs'));
7273
})
7374

docs/dgeni-package/processors/generateNavigationDoc.js

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,15 @@ module.exports = function generateNavigationDoc() {
2727
modulesDoc.value.sections.push(moduleNavItem);
2828

2929
_.forEach(doc.exports, function(exportDoc) {
30-
var exportNavItem = {
31-
path: exportDoc.path,
32-
partial: exportDoc.outputPath,
33-
name: exportDoc.name,
34-
type: exportDoc.docType
35-
};
36-
moduleNavItem.pages.push(exportNavItem);
30+
if (!exportDoc.private) {
31+
var exportNavItem = {
32+
path: exportDoc.path,
33+
partial: exportDoc.outputPath,
34+
name: exportDoc.name,
35+
type: exportDoc.docType
36+
};
37+
moduleNavItem.pages.push(exportNavItem);
38+
}
3739
});
3840
}
3941
});
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module.exports = {
2+
name: 'private',
3+
transforms: function(doc, tag) { return true; }
4+
};

docs/dgeni-package/templates/module.template.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ <h1 class="id">{$ doc.id $} <span class="type">module</span></h1>
99
<h2>Exports</h2>
1010
<ul>
1111
{%- for exportDoc in doc.exports %}
12+
{% if not exportDoc.private -%}
1213
<li><a href="/{$ exportDoc.path $}"><strong>{$ exportDoc.name $}</strong> {$ exportDoc.docType $}</a></li>
14+
{%- endif %}
1315
{%- endfor %}
1416
</ul>
1517
{% endif %}

0 commit comments

Comments
 (0)