hyde
hyde copied to clipboard
A front-end to Jekyll that parses C++ sources to produce and enforce out-of-line documentation
The brief and owner fields in `index.md` for a class and the file that contains it should be inherited (somehow) from the class documentation itself. When there's a single class...
e.g., what we do for "(implicit)" etc.
This behavior should be consistent.
make it optional?
It is useful to override Hyde's access filter command line setting on a per-class basis. Provide a command that can be used for classes and structs that extend or contract...
nested classes within a class don't "see" their parent class hyde directives. e.g., `@hyde-owner` at the parent class level does not propagate down into the nested class. This needs to...
We need a command that can be used in-source that tells hyde to ignore whatever AST node the clang driver has found. This would likely be recursive (e.g., ignore a...
To quote `README.md`: > Out-of-line: Many tools rely on documentation placed inline within source as long-form comments. While these seem appealing at first blush, they suffer from two big drawbacks....