note: very work-in-progress
Documentation generator and source code analysis system for nim.
- Command-line tool to generate documentation in different formats (html/xml)
- Documentation extractor-as-a-libary. Provide API for writing documentation extraction, analysis and generation tools.
- Use unit tests as use examples for library.
- Extracting additional semantic information from haxorg documentation
comments (metadata information like
@ingroup{}annotations, documentation for comments, fields and so on). - User-defined higlighting logic (special side effects, exceptions that developer might want to make accent on)
- Show resolved links in documentation in sourcetrail tool. Index
.org(.md,.rstetc.) documents as well to allow full interoperability between source code in documentation. It is somewhat annoying that =sourcetrail= does not allow to open two split panes, or edit source code directly in the same window, but this could be mitigated with support for suchronization between editors and sourcetrail viewers.
- Basic implementation of simple documentation - no pretty configuration, can be just bare HTML
- Search implementation - can use fulltext search like flexsearch in addition to something closer to hogle for API/error search.
- Automatic change detection for API/implementation
- Automatic changelog documentation