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.org/ 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.com/facebook/react/blob/master/src/classic/element/ReactElement.js
The typescript compiler can use this tag to exclude stuff from the d.ts definition.
See the --stripInternal option for more information.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With