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 SteveRowe
Date Thu, 24 Jan 2013 07:04:26 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 SteveRowe:
http://wiki.apache.org/lucene-java/HowToGenerateNiceJavadocs?action=diff&rev1=2&rev2=3

Comment:
'ant javadocs' -> 'ant documentation'; rt.jar is called classes.jar in Apple Java5 and
Java6 JDKs

  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
+ 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
+ (e.g. java6 or whatever) so you can set your {{{bootclasspath}}} to its {{{rt.jar}}} (Apple's
Java5 and Java6 JDKs
+ call this file {{{Classes/classes.jar}}} instead - substitute in the cmdlines given below).
 This way the javadocs
- include any bogus java7 interfaces like AutoCloseable that don't actually apply.
+ won't include any bogus java7 interfaces like {{{AutoCloseable}}} that don't actually apply.
  
+ In order to produce all of the documentation for a release, including a top level index,
javadocs, changes, etc.,
+ use {{{ant documentation}}} under both {{{lucene/}}} and {{{solr}}}. 
-  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 -Djavadoc.noindex=false -Dbootclasspath=/path/to/the/minimum/java/jre/lib/rt.jar
javadocs}}}
-  1. under solr: {{{ant -Dversion=X.Y.Z -Djavadoc.noindex=false -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)
  
+  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 lucene/build/docs}}}
+  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 -Djavadoc.noindex=false -Dbootclasspath=/path/to/the/minimum/java/jre/lib/rt.jar
documentation}}}
+  1. Under {{{solr/}}}: {{{ant -Dversion=X.Y.Z -Djavadoc.noindex=false -Dspecversion=X.Y.Z
-Dbootclasspath=/path/to/the/minimum/java/jre/lib/rt.jar documentation}}}
+  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