Skip to content

Automatically merge documentation into generated sources #16

@haxscramper

Description

@haxscramper

Current nim doc has very anemic support for any kind of metadata annotations (i.e. there is no support at all), but ideally I want to use haxdoc as a "recommended" documentation generator for wrappers, so it is not problematic.

Most C and C++ libraries use Doxygen, qdoc, mandoc or texinfo for documentation. Right now, I have wrappers for Doxygen XML parsers (dox_compound and dox_index) and somewhat broken wrappers for mandoc format.

An earlier version of qdoc could output XML, but this feature has been removed. There seems to be an available API for working with qdoc AST, though, which makes things noticeably simpler.

Texinfo also has something resembling an API.

Related - haxscramper/haxdoc#6 and haxscramper/haxdoc#5

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions