I like this idea: on a related note maybe this would encourage us
to add more examples to our javadocs, which I think is really helpful for users.

Any idea what it takes to integrate this with an ant task for javadocs?

on a related note maybe this would encourage us to add more examples to our javadocs, which I think is really helpful for users.

I agree.

Any idea what it takes to integrate this with an ant task for javadocs?

Nothing special at this moment. So the author of javadoc should know where prettify script is:

<script src="../../../../prettify.js" type="text/javascript"></script>

He should write it in another javadoc:

<script src="../../../../../../../prettify.js" type="text/javascript"></script>

I don't like it...

(where prettify.js needs to be copied from somewhere (dev-tools? for example) to output dir of javadoc by ant task.)

could probably solve this in the general case using a combination of javadocs "-header" option, combined with the "

http://download.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#unprocessed

...then it should be available in every generated HTML file

First draft for the review. Try ant clean javadoc-core under solr directory and see StopFilterFactory javadoc.

In this draft, I used @

(thanks Hoss!), and wrote the following lines in javadoc comment:

<script src="{@docRoot}/prettify/prettify.js" type="text/javascript"></script>
<script language="JavaScript">window.onload=function(){windowTitle();prettyPrint();}</script>

but, they probably can be omitted if "-header" option as Hoss mentioned.

New patch that uses "-header" option.

TODO:

• Support not only javadoc-core, but also javadoc-solrj, javadoc-all, javadoc-contrib. They should share a common prettify.
• Support lucene javadocs.
• Support modules javadocs?

Support not only javadoc-core, but also javadoc-solrj, javadoc-all, javadoc-contrib. They should share a common prettify.

Done in the attached patch.

New patch that supports lucene javadocs.

I'd like to commit at the moment so that someone/volunteers can improve javadocs (e.g. TokenFilterFactories in Solr).

trunk: Committed revision 1067551.
3x: Committed revision 1067552.

Reopening the issue.

Lucene javadoc on hudson looks fine (syntax highlighting works correctly):

https://hudson.apache.org/hudson/job/Lucene-trunk/javadoc/all/overview-summary.html

but Solr javadoc on hudson looks not good:

https://hudson.apache.org/hudson/job/Solr-trunk/javadoc/org/apache/solr/handler/component/TermsComponent.html

Building of both javadocs on my local is working fine.

On my mac, there is prettify correctly under api directory after ant package:

$ cd solr
$ ant clean set-fsdir package
$ ls build/docs/api/
allclasses-frame.html          deprecated-list.html           package-list
allclasses-noframe.html        help-doc.html                  prettify
constant-values.html           index-all.html                 resources
contrib-solr-analysis-extras   index.html                     serialized-form.html
contrib-solr-cell              org                            solr
contrib-solr-clustering        overview-frame.html            solrj
contrib-solr-dataimporthandler overview-summary.html          stylesheet+prettify.css
contrib-solr-uima              overview-tree.html

Both of the nightly Hudson Maven builds failed because javadoc jars were not produced by the Ant build (scroll down to the bottom to see the error about javadoc jars not being available to deploy):

https://hudson.apache.org/hudson/job/Lucene-Solr-Maven-trunk/17/consoleText
https://hudson.apache.org/hudson/job/Lucene-Solr-Maven-3.x/16/consoleText

but Solr javadoc on hudson looks not good:

https://hudson.apache.org/hudson/job/Solr-trunk/javadoc/org/apache/solr/handler/component/TermsComponent.html

The problem was gone.

solr.analysis classes(A to H) are implemented by google-code-prettify.Please confirm the patch.

Looks fine. Thanks, Abe-san!
I'll look into them and commit tonight.

solr.analysis classes(A to H) are implemented by google-code-prettify.Please confirm the patch.

trunk: Committed revision 1073336.
3x: Committed revision 1073344.

Solr.analysis classes(I to Z) have been implemented by google-code-prettify.

Solr.analysis classes(I to Z) have been implemented by google-code-prettify.

I just wanted to say thank you for adding these examples to all of the analysis factories!
This is a really great start towards improving the documentation in this area.

This is a really great start towards improving the documentation in this area.

I agree.

I've committed I-to-N in r1073806 (trunk) and r1073810 (3x). I'll check and commit the rest of patches tomorrow.
Thanks again, Abe-san!

Committed S-to-Z in r1074009 (trunk) and r1074011 (3x).

Committed O-to-R in r1074017 (trunk) and r1074023 (3x).

Abe-san, ReversedWildcardFilterFactory should be applied only index time analysis, I've fixed your patch. Please see schema.xml for example. Thanks anyway for your great contribution!

some more improvements: the CollationKeyFilter's example uses KeywordTokenizer, since its usually for sorting.

The various stemmers have standardtokenizer + lowercasefilter, most of these will not work correctly unless input is lowercased.

The thaiwordfilter should not use n-gram tokenizer, because thaiwordfilter is word segmentation, so i changed it to use StandardTokenizer.

Sounds reasonable, thanks for reviewing and correcting them, Robert! Please commit the patch.

attached is a patch that applies the stylesheet to some more code samples in various overview.html and package.html files.

reopen as the lucene-only javadocs are broken

setting to blocker, i don't think the prettify directory should be in dev-tools as it breaks the lucene-only build.

dev-tools was just supposed to be some developer-only/maintained on as-is/optional stuff to help developers.

in this case i would recommend moving the prettify stuff to under lucene/

in this case i would recommend moving the prettify stuff to under lucene/

Do you mean Solr javadocs see the prettify stuff under lucene/ also?
(Sorry if I missed something in community these days.)

Do you mean Solr javadocs see the prettify stuff under lucene/ also?

Yep, seems reasonable.

Bulk close for 3.1