lucene-java-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Lucene-java Wiki] Update of "HowToGenerateNiceJavadocs" by RobertMuir
Date Thu, 12 Apr 2012 04:13:57 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Lucene-java Wiki" for change notification.

The "HowToGenerateNiceJavadocs" page has been changed by RobertMuir:
http://wiki.apache.org/lucene-java/HowToGenerateNiceJavadocs

New page:
Java 7 gives a nicer javadocs look and feel (less Geocities-like).

So you can optionally generate these nicer javadocs for the website without screwing anything
else up,
if you have the urge. The trick is you must use java7, but *also* have the minimal compiler
version
(e.g. java6 or whatever) so you can set your bootclasspath to its rt.jar. This way the javadocs
won't
include any bogus java7 interfaces like AutoCloseable that don't actually apply.

 1. when making the actual release, please always use the actual minimum compiler version!!!!
   e.g. if its java5, put an actually java5 compiler in your JAVA_HOME and then put $JAVA_HOME/bin
   in the front of your path. Although it *might* be safe to do otherwise, just do this and
you don't
   need to worry.
 1. to make java7 javadocs for the website, first take your checkout of the release tag and
clean old docs:
   {{{rm -rf solr/build/docs/api}}}
   {{{rm -rf lucene/build/docs/api}}}
 1. next put a java7 compiler in your JAVA_HOME and $JAVA_HOME/bin in the front of your path.
 1. under lucene: {{{ant -Dversion=X.Y.Z -Dbootclasspath=/path/to/the/minimum/java/jre/lib/rt.jar
javadocs}}}
 1. under solr: {{{ant -Dversion=X.Y.Z -Dspecversion=X.Y.Z -Dbootclasspath=/path/to/the/minimum/java/jre/lib/rt.jar
javadocs}}}
 1. now you have fancy javadocs under lucene/build/docs/api and solr/build/docs/api, that
otherwise link to the correct java versions and APIs, just look (hopefully) nicer.
 1. deploy these to the website instead of the ones from the RC. (someone could always volunteer
to do that after the release really at any time)

Mime
View raw message