lucene-solr-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Hoss Man (JIRA)" <>
Subject [jira] Updated: (SOLR-555) Autogenerate "user" docs about "plugins" from code
Date Fri, 18 Jul 2008 00:27:31 GMT


Hoss Man updated SOLR-555:

    Attachment: SOLR-555.patch


includes demo of component info, as well as new code that makes any @link or @see tag which
refer to a plugin become a link to that plugin in the plugin docs (but still a link to the
javadocs in the javadocs) ... this is kind of a hack right now because it uses static info
about which classes are plugins .. just need some refactoring to pass that info along as appropriate.

> 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, SOLR-555.patch, SOLR-555.patch, 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