harbored-mod

harbored-mod copied to clipboard

Diagrams and graphs

6

What about generation [PlantUML](http://plantuml.sourceforge.net/) with some settings ( for example show fields or not )? It can be a good part of documentation. It's planed?

deviator

Single-page output

1

Single-file HTML output. - No sidebar by default, just a TOC on top - Optional fixed-pos sidebar Once done, we can consider PDF (and maybe other formats?) using `wkhtmltopdf` or...

kiith-sa

Enabling/disabling documentation based on protection attributes

1

Currently we generate docs for everything with a doc comment regardless of protection attribute. Allow teh user to disable private/package/protected. By default, only `public` and `protected` members of non-`final` classes...

kiith-sa

Cross-referencing does not handle function and template parameters at the moment. Parameters should be considered children of their function/class/template/whatever so e.g. methods of a templated class can refer to its...

kiith-sa

Links to parent/derived classes.

1

Documentation of a class should point to its parent class/interfaces with links, and also point to all its derived classes, including indirectly derived (but make it evident they're derived indirectly;...

kiith-sa

Pass through all files to collect data before generating documentation

1

Collect all functions, classes and other items (reuse/modify `visitor.Item`), together with their source locations, fully qualified names, how many times each item is referenced, etc. (Keep the AST node of...

kiith-sa

9il

Inherited methods should point to their docs in their parent classes, and should show up in some way even if they don't have a documentation comment in the derived class....

kiith-sa

Currently, TOC tree folding is reset when changing page. It should be possible to make it persistent using [localStorage](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage) (I know little about JS, so not sure about how easy/difficult...

kiith-sa

Currently, every package in the TOC tree is folded by default (if JavaScript is not disabled). This is not always user-friendly, e.g. when using a few nested packages in a...

kiith-sa