Package io.github.sandydunlop.markista.doclet
This package contains the main doclet classes.
The Markista doclet has3 main functions:
- Collecting API and documentation infomation from the Java compiler
- Arranging the infomation into an API tree using model.* classes
- Outputting the documentation from the API tree as Markdown
| Class | Description |
|---|---|
| MarkdownTable | A utility class for creating tables in Markdown documents. |
| MarkdownDoclet | A doclet that renders javadoc comments as Markdown |
| MarkdownWriter | A class that outputs API documentation as Markdown. |
| ApiCollector | A class that scans code and generates an API tree representing code and Javadoc comments. |