Add Documentation attributes

part of https://github.com/oqtane/oqtane.framework/issues/570
This commit is contained in:
ijungleboy
2020-10-15 10:38:25 +02:00
parent 81475fd835
commit 06c041dd4e
5 changed files with 107 additions and 0 deletions

View File

@ -0,0 +1,7 @@
# Oqtane API Decorator Attributes
This folder contains special attributes for the API Code Generator.
The idea is that only items marked with special attributes are valide public APIs, and only these will be documented in the public docs
As of 2020, all APIs are documented, and only these marked as `[PrivateApi]` will be excluded. In future, we may reverse this to only document things marked as `[PublicApi]`.