Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically merge documentation into generated sources #16

Open
haxscramper opened this issue Oct 12, 2021 · 1 comment
Open

Automatically merge documentation into generated sources #16

haxscramper opened this issue Oct 12, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@haxscramper
Copy link
Owner

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

@haxscramper
Copy link
Owner Author

Generation of the org-mode/haxdoc comments seems like an optimal solution. I can later add support for nim doc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant