lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Robert Muir (JIRA)" <j...@apache.org>
Subject [jira] [Created] (LUCENE-4007) many versioned documents could/should be in javadocs instead.
Date Sat, 21 Apr 2012 18:44:35 GMT
Robert Muir created LUCENE-4007:
-----------------------------------

             Summary: many versioned documents could/should be in javadocs instead.
                 Key: LUCENE-4007
                 URL: https://issues.apache.org/jira/browse/LUCENE-4007
             Project: Lucene - Java
          Issue Type: Task
            Reporter: Robert Muir


Looking at our forrested site, and trying to think about how we could move our versioned site
away from it, I think as a first step we should look at what really needs to be there.

I think it easily becomes out of date and we don't have good centralized documentation since
stuff is split between javadocs and forrest.

Couldn't queryparsersyntax.xml simply be in the overview/package for the queryparser?
We could just link to that page from the forrest docs menu, then we could link to the syntax
from
other places in the javadocs. 
Furthermore, in that case we could link to other queryparser impls documentations (e.g. complexphrase)
so it would probably be more useful.

demo/demo2.xml could just be overview for the demo contrib? currently that one is useless:
https://builds.apache.org/job/Lucene-trunk/javadoc/demo/index.html

scoring.xml could be added to the package documentation of search or similarities or somewhere
that 
makes more sense? currently its "almost javadocs" already, except harder to validate none
of these
links are actually out of date: my best bet is a ton of them already are!

i'll leave fileformats.xml aside for now, but with many different codec implementations its
something
to think about for later too.



--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


Mime
View raw message