From 6cd4b1b41c6c3af2e4baeae3b56243778b426082 Mon Sep 17 00:00:00 2001 From: Peter Bacon Darwin Date: Thu, 14 Dec 2017 19:52:41 +0000 Subject: [PATCH] build(aio): add `@nodoc` alias to the `@internal` tag (#21024) The `@internal` tag prevents code items from appearing in the docs and the typings files. You can now use `@nodoc` if you only want it to be excluded from the docs and not the typings files. Closes #20990 PR Close #21024 --- .../angular-api-package/tag-defs/internal.js | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/aio/tools/transforms/angular-api-package/tag-defs/internal.js b/aio/tools/transforms/angular-api-package/tag-defs/internal.js index f981361298..39be3e5389 100644 --- a/aio/tools/transforms/angular-api-package/tag-defs/internal.js +++ b/aio/tools/transforms/angular-api-package/tag-defs/internal.js @@ -1,5 +1,16 @@ +/** + * Use this tag to ensure that dgeni does not include this code item + * in the rendered docs. + * + * The `@internal` tag indicates to the compiler not to include the + * item in the public typings file. + * Use the `@nodoc` alias if you only want to hide the item from the + * docs but not from the typings file. + */ module.exports = function() { return { - name: 'internal', transforms: function() { return true; } + name: 'internal', + aliases: ['nodoc'], + transforms: function() { return true; } }; };