DocsType

interface DocsType : Named(source)

Attributes to qualify the type of documentation.

This attribute is usually found on variants that have the Category attribute valued at documentation.

Since

5.6

Properties

Link copied to clipboard
Link copied to clipboard
val DOXYGEN: String = "doxygen"
The typical documentation for native APIs
Link copied to clipboard
val JAVADOC: String = "javadoc"
The typical documentation for Java APIs
Link copied to clipboard
val SAMPLES: String = "samples"
Samples illustrating how to use the software module
Link copied to clipboard
val SOURCES: String = "sources"
The source files of the module
Link copied to clipboard
val USER_MANUAL: String = "user-manual"
A user manual

Functions

Link copied to clipboard
abstract fun getName(): String