lucene-solr-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Erik Hatcher (JIRA)" <>
Subject [jira] Commented: (SOLR-555) Autogenerate "user" docs about "plugins" from code
Date Thu, 05 Jun 2008 15:33:45 GMT


Erik Hatcher commented on SOLR-555:

Hoss - have you tried XDoclet?   I'm not sure where the state of that project is, but I used
to do a lot of work with it.  I even used it to generate an Ant task reference once upon a
time.   Been a long long time since I've tinkered with it though, not sure if XDoclet2 is
the better starting point or not either.  

XDoclet can make generating stuff from Java code a lot easier than writing your own doclet.

> Autogenerate "user" docs about "plugins" from code
> --------------------------------------------------
>                 Key: SOLR-555
>                 URL:
>             Project: Solr
>          Issue Type: Improvement
>            Reporter: Hoss Man
>            Assignee: Hoss Man
>         Attachments: SOLR-555.patch
> Our current strategy of using javadocs for "developer" documentation and the wiki for
documenting "user" features only gets us so far -- among other things, it makes it hard to
include the "user" documentation in our releases, but it also results in a disconnect between
when code changes and when documentation gets updated.
> in an ideal world, "user" documentation would live in the code right along side the implementation,
just like with javadocs -- but the standard set of information displayed by javadocs isn't
very user friendly.  we should find a better way to allow us to "edit" the info about how
to use a plugin right along side the code for that plugin and generate user friendly documentation
from that.

This message is automatically generated by JIRA.
You can reply to this email to add a comment to the issue online.

View raw message