This repository is for active development of the Azure SDK for JavaScript (NodeJS & Browser). For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/javascript/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-js.
MIT License
2.1k
stars
1.21k
forks
source link
[Docs] Fix usage of @internal and @hidden tags - Epic #13459
We should follow these guidelines after recent work done by the docs team to support the @internal tag:
use the @internal tag only for definitions that are not exported by src/index.ts and you do not want to generate documentation for them on docs.microsoft.com
use the @hidden tag only for definitions that are exported by src\index.ts but you still do not want to generate documentation for them on docs.microsoft.com
do not use both @internal and @hidden for one definition
We should follow these guidelines after recent work done by the docs team to support the
@internal
tag:use the
@internal
tag only for definitions that are not exported bysrc/index.ts
and you do not want to generate documentation for them ondocs.microsoft.com
use the
@hidden
tag only for definitions that are exported bysrc\index.ts
but you still do not want to generate documentation for them ondocs.microsoft.com
do not use both
@internal
and@hidden
for one definition[x] textanalytics
[ ] formrecognizer
[x] metricadvisor
[ ] cosmos
[ ] servicebus
[ ] storage
[x] appconfiguration
[x] search
[x] tables
[x] communication
[x] core
[x] schemaregistry
[ ] anomalydetector
[x] digitaltwins
[x] eventgrid
[ ] eventhubs
[ ] identity
[ ] keyvault
[x] monitor