I noticed that React uses the @internal tag for documentation. What program consumes this tag? Is it jsdoc or something else? Google Closure Compiler? I can't find this tag on / or in the Google Closure Compiler documentation. What is it used for?

Here is an example -

/**
 * Warn for mutations.
 *
 * @internal
 * @param {object} object
 * @param {string} key
 */
function defineWarningProperty(object, key) {

.js

I noticed that React uses the @internal tag for documentation. What program consumes this tag? Is it jsdoc or something else? Google Closure Compiler? I can't find this tag on http://usejsdoc/ or in the Google Closure Compiler documentation. What is it used for?

Here is an example -

/**
 * Warn for mutations.
 *
 * @internal
 * @param {object} object
 * @param {string} key
 */
function defineWarningProperty(object, key) {

https://github./facebook/react/blob/master/src/classic/element/ReactElement.js

• javascript
• reactjs
• google-closure-piler
• google-closure
• jsdoc

• 2 It's not used by Closure-piler: github./google/closure-piler/blob/master/src//google/… – Chad Killingsworth Commented Feb 18, 2015 at 18:11

2 Answers 2

The typescript piler can use this tag to exclude stuff from the d.ts definition.

See the --stripInternal option for more information.

From this, it looks like the documentation is manual.