Add Documentation attributes
part of https://github.com/oqtane/oqtane.framework/issues/570
This commit is contained in:
7
Oqtane.Shared/Documentation/readme.md
Normal file
7
Oqtane.Shared/Documentation/readme.md
Normal 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]`.
|
Reference in New Issue
Block a user