On 09/11/2014 01:31, Nick Wellnhofer wrote:
If there aren't any
objections, I'd be happy to work on switching our "DocuComments" over to
CommonMark.
I made the necessary changes for both Lucy and Clownfish in the `markdown`
branches. Man pages and HTML documentation for the C bindings, as well as Perl
POD are now autogenerated from Markdown DocuComments.
I also uploaded a sample of the new HTML documentation for the C APIs:
http://lucy.apache.org/docs/c/
http://lucy.apache.org/docs/c/cfish.html
http://lucy.apache.org/docs/c/lucy.html
C API docs are only generated for public classes. Since not all classes are
marked public yet, some pages are missing and some links are dead.
The Markdown documentation supports links to classes with a custom `clownfish`
URI scheme. A link like
[RegexTokenizer](clownfish:class:lucy:RegexTokenizer)
will be automatically converted to point to right location depending on the
host language. This can also be (ab)used for other language-dependent stuff.
Nick
