From a654cc647a06d7f36cea8918ffa05d05489bd5a1 Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Thu, 22 Dec 2022 18:56:06 +0000 Subject: [PATCH] Assorted minor FAQ edits (#176) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Assorted minor updates Sun --> Oracle Update some URLs * Update src/site/fml/faq.fml Co-authored-by: Piotrek Żygieło <11896137+pzygielo@users.noreply.github.com> * Update faq.fml * remove outdated FAQ entry Co-authored-by: Michael Osipov Co-authored-by: Piotrek Żygieło <11896137+pzygielo@users.noreply.github.com> --- src/site/fml/faq.fml | 142 +++---------------------------------------- 1 file changed, 9 insertions(+), 133 deletions(-) diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml index 0f83ff575..c4a4c7774 100644 --- a/src/site/fml/faq.fml +++ b/src/site/fml/faq.fml @@ -29,8 +29,8 @@ under the License. What are the Javadoc options supported by the Maven Javadoc Plugin?

- All options provided by Sun on the Javadoc homepages are wrapped in the Maven Javadoc Plugin. This - plugin supports Javadoc 1.4, 1.5 and 6.0 options. Refer you to the + All options provided by Oracle on the Javadoc homepages are wrapped in the Maven Javadoc Plugin. This + plugin supports Javadoc 1.4, 1.5 and 6.0 options. Refer to the Javadoc Package Summary for more information and to the Javadoc Plugin Documentation.

@@ -73,7 +73,7 @@ under the License.

The Javadoc Plugin calls the Javadoc tool with - argument files, + argument files, i.e. files called 'options', 'packages' and 'argfile' (or 'files' with Jdk < 1.4): @@ -190,7 +190,7 @@ ${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh) \

Note: If your proxy needs more JVM - networking properties + networking properties (like NTLM), you could always add JVM options using the <additionalJOption/> parameter in your Javadoc Plugin configuration, i.e.: If you use the Javadoc report in the aggregate mode, i.e. using the aggregate parameter, and if the Javadoc report does not include additional source code directories defined using the - build-helper:add-source goal, + build-helper:add-source goal, you need to use the javadoc:aggregate goal instead of javadoc:javadoc goal. Read the Aggregating Javadocs for Multi-Projects part for more information.

@@ -287,9 +287,9 @@ mvn deploy:deploy-file \ should correctly write references in your Javadoc, i.e.:

    -
  • @see MyMojo or {@link MyMojo} will NOT work.
    • +
  • @see MyMojo or {@link MyMojo} will NOT work.
  • @see com.mycompany.plugin.myplugin.MyMojo or {@link com.mycompany.myplugin.MyMojo} - will work.
    • + will work.
@@ -301,132 +301,8 @@ mvn deploy:deploy-file \

- - On Windows with Sun JDK, why javadoc:javadoc goal blows up due to an IllegalArgumentException in sun.net.www.ParseUtil.decode()? - -

- You are on Windows XP with Sun JDK 5 or JDK 6 freshly installed, and when you run mvn javadoc:javadoc, - you are stick by an sun.net.www.ParseUtil.decode() exception like this - one. -

- -

- Your CLASSPATH environement variable is probably corrupted, i.e. something like: - CLASSPATH=.;C:\Java\jdk1.6.0_03\jre\lib\ext\QTJava.zip;%JAVAHOME% - with %JAVAHOME% not a valid environment variable. -

-

- To resolve it, just reset the CLASSPATH environement variable, i.e.: set CLASSPATH= - or set a new CLASSPATH environement variable, i.e.: - set CLASSPATH=C:\Java\jdk1.6.0_03\jre\lib\ext\QTJava.zip - or fix the wrong environment variable. -

-

- Refer you to - http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6219854 - from Sun for more details. -

- - - - - - What are the values of <encoding/>, <docencoding/> and <charset/> parameters? + + What are the values of the <encoding/>, <docencoding/>, and <charset/> parameters?

By default, these parameters have the following values: