On 23/11/2014 19:05, Nick Wellnhofer wrote:
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
I just landed a new branch `markdown_v2` with many improvements including
better HTML output and links to methods and functions using fragment
identifiers. Unfortunately, we can't easily link to specific methods in our
Perl POD because information about method parameters appears in the section
headers.
Example page: http://lucy.apache.org/docs/c/lucy_Query.html
The Clownfish URI scheme now supports the following type of links:
clownfish:class:{parcel}:{struct_sym}
clownfish:class:{struct_sym}
clownfish:method:{parcel}:{struct_sym}:{macro_sym}
clownfish:method:{struct_sym}:{macro_sym}
clownfish:method:{macro_sym}
clownfish:function:{parcel}:{struct_sym}:{micro_sym}
clownfish:function:{struct_sym}:{micro_sym}
clownfish:function:{micro_sym}
If the `parcel` or `struct_sym` components are missing, the values of the
current class are used. This allows for shorter URIs. I'm also thinking about
using `cfish` instead of `clownfish` as URI scheme.
I'm also working on a `clownfish:null` pseudo-URI that can be used to fill in
the host language's name for an undefined value. Then all of the old
`perlify_pod` hacks can be eliminated.
I plan to merge this branch in the next days.
Nick
