lucene-solr-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ryan McKinley (JIRA)" <>
Subject [jira] Commented: (SOLR-555) Autogenerate "user" docs about "plugins" from code
Date Fri, 02 May 2008 03:52:55 GMT


Ryan McKinley commented on SOLR-555:

but as a proof of concept i think it's pretty cool and worth pursuing

Yes!  This looks great chris.  You discussed this a while back and I sort of ignored it as
a real option (having messed with doclet configuration before)

Thanks for doing the leg work to get something working,

> 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