Harbored-mod (doc generator) 0.2: Cross-referencing, methods/fields no longer in separate files

Kiith-Sa via Digitalmars-d-announce digitalmars-d-announce at puremagic.com
Sat Jan 31 07:31:36 PST 2015


Harbored-mod (https://github.com/kiith-sa/harbored-mod) is a
documentation generator based on Brian Schott's Harbored that
supports both DDoc and Markdown in documentation comments.

--------------------------
Examples of generated docs
--------------------------

* Public imports in a package.d:
   http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity.html
* Class with a template parameter, member functions and aliases:
   
http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/entitymanager/EntityManager.html
* Simple DDoc See_Also: section:
   
http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/componenttypeinfo/ImmutableRawComponent.html
* Note: DDoc section with some markdown:
   
http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/processtypeinfo.html#prioritizeProcessOverloads


------------------
Release highlights
------------------

* Automatic cross-referencing in code blocks and inline code

* New (and now default) output format: "aggregated" HTML;
   generate documentation files only for aggregates (modules,
   structs, classes, etc.) and document non-aggregate members
   (functions, variables, etc.) in these files.

   The previous, DDox compatible format, where a separate file
   is generated for every symbol, is still supported through
   the `--format=html-simple` option.

* Various style and usability improvements
* Major refactoring
* Many bugfixes


Full changelog:
https://github.com/kiith-sa/harbored-mod/releases/tag/v0.2.0


More information about the Digitalmars-d-announce mailing list