Skip to content

Commit a654cc6

Browse files
elharomichael-opzygielo
authored
Assorted minor FAQ edits (#176)
* Assorted minor updates Sun --> Oracle Update some URLs * Update src/site/fml/faq.fml Co-authored-by: Piotrek Żygieło <[email protected]> * Update faq.fml * remove outdated FAQ entry Co-authored-by: Michael Osipov <[email protected]> Co-authored-by: Piotrek Żygieło <[email protected]>
1 parent 73557e3 commit a654cc6

File tree

1 file changed

+9
-133
lines changed

1 file changed

+9
-133
lines changed

‎src/site/fml/faq.fml

+9-133
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ under the License.
2929
<question>What are the Javadoc options supported by the Maven Javadoc Plugin?</question>
3030
<answer>
3131
<p>
32-
All options provided by Sun on the Javadoc homepages are wrapped in the Maven Javadoc Plugin. This
33-
plugin supports Javadoc 1.4, 1.5 and 6.0 options. Refer you to the
32+
All options provided by Oracle on the Javadoc homepages are wrapped in the Maven Javadoc Plugin. This
33+
plugin supports Javadoc 1.4, 1.5 and 6.0 options. Refer to the
3434
<a href="./apidocs/org/apache/maven/plugins/javadoc/package-summary.html">Javadoc Package Summary</a>
3535
for more information and to the <a href="./javadoc-mojo.html">Javadoc Plugin Documentation</a>.
3636
</p>
@@ -73,7 +73,7 @@ under the License.
7373
<answer>
7474
<p>
7575
The Javadoc Plugin calls the Javadoc tool with
76-
<a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#argumentfiles">argument files</a>,
76+
<a href="https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#argumentfiles">argument files</a>,
7777
i.e. files called 'options', 'packages' and 'argfile' (or 'files' with Jdk &lt; 1.4):
7878
<source><![CDATA[
7979
javadoc.exe(or .sh) @options @packages | @argfile]]></source>
@@ -190,7 +190,7 @@ ${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh) \
190190
</p>
191191
<p>
192192
<b>Note</b>: If your proxy needs more JVM
193-
<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/net/properties.html">networking properties</a>
193+
<a href="https://docs.oracle.com/javase/7/docs/technotes/guides/net/properties.html">networking properties</a>
194194
(like NTLM), you could always add JVM options using the <i>&lt;additionalJOption/&gt;</i> parameter
195195
in your Javadoc Plugin configuration, i.e.:
196196
<source><![CDATA[
@@ -273,7 +273,7 @@ mvn deploy:deploy-file \
273273
<p>
274274
If you use the Javadoc report in the aggregate mode, i.e. using the <code>aggregate</code> parameter, and if the
275275
Javadoc report does not include additional source code directories defined using the
276-
<a href="http://mojo.codehaus.org/build-helper-maven-plugin/add-source-mojo.html">build-helper:add-source</a> goal,
276+
<a href="https://www.mojohaus.org/build-helper-maven-plugin/add-source-mojo.html">build-helper:add-source</a> goal,
277277
you need to use the <code>javadoc:aggregate</code> goal instead of <code>javadoc:javadoc</code> goal. Read the
278278
<a href="examples/aggregate.html">Aggregating Javadocs for Multi-Projects</a> part for more information.
279279
</p>
@@ -287,9 +287,9 @@ mvn deploy:deploy-file \
287287
should correctly write references in your Javadoc, i.e.:
288288
</p>
289289
<ul>
290-
<li><code>@see MyMojo</code> or <code>{@link MyMojo}</code> will <b>NOT work</b>.</li>
290+
<li><code>@see MyMojo</code> or <code>{@link MyMojo}</code> will <strong>NOT work</strong>.</li>
291291
<li><code>@see com.mycompany.plugin.myplugin.MyMojo</code> or <code>{@link com.mycompany.myplugin.MyMojo}</code>
292-
will <b>work</b>.</li>
292+
will <strong>work</strong>.</li>
293293
</ul>
294294
</answer>
295295
</faq>
@@ -301,132 +301,8 @@ mvn deploy:deploy-file \
301301
</p>
302302
</answer>
303303
</faq>
304-
<faq id="On Windows with Sun JDK, why javadoc:javadoc goal blows up due to an IllegalArgumentException in sun.net.www.ParseUtil.decode()">
305-
<question>On Windows with Sun JDK, why <i>javadoc:javadoc</i> goal blows up due to an IllegalArgumentException in <i>sun.net.www.ParseUtil.decode()</i>?</question>
306-
<answer>
307-
<p>
308-
You are on Windows XP with Sun JDK 5 or JDK 6 freshly installed, and when you run <i>mvn javadoc:javadoc</i>,
309-
you are stick by an <i>sun.net.www.ParseUtil.decode()</i> exception like this
310-
<a href="javascript:;" onclick="toggleException( '_6219854' );" style="cursor: pointer;vertical-align:text-bottom;">one</a>.
311-
</p>
312-
<div id="_6219854" style="display:none">
313-
<source><![CDATA[
314-
...
315-
[INFO] ------------------------------------------------------------------------
316-
[ERROR] BUILD ERROR
317-
[INFO] ------------------------------------------------------------------------
318-
[INFO] An error has occurred in Javadoc report generation:Exit code: 1 - java.lang.IllegalArgumentException
319-
at sun.net.www.ParseUtil.decode(ParseUtil.java:189)
320-
at sun.misc.URLClassPath$FileLoader.&lt;init&gt;(URLClassPath.java:953)
321-
at sun.misc.URLClassPath$3.run(URLClassPath.java:326)
322-
at java.security.AccessController.doPrivileged(Native Method)
323-
at sun.misc.URLClassPath.getLoader(URLClassPath.java:320)
324-
at sun.misc.URLClassPath.getLoader(URLClassPath.java:297)
325-
at sun.misc.URLClassPath.findResource(URLClassPath.java:144)
326-
at java.net.URLClassLoader$2.run(URLClassLoader.java:362)
327-
at java.security.AccessController.doPrivileged(Native Method)
328-
at java.net.URLClassLoader.findResource(URLClassLoader.java:359)
329-
at java.lang.ClassLoader.getResource(ClassLoader.java:977)
330-
at java.lang.ClassLoader.getResourceAsStream(ClassLoader.java:1159)
331-
at javax.xml.parsers.SecuritySupport$4.run(SecuritySupport.java:96)
332-
at java.security.AccessController.doPrivileged(Native Method)
333-
at javax.xml.parsers.SecuritySupport.getResourceAsStream(SecuritySupport.java:89)
334-
at javax.xml.parsers.FactoryFinder.findJarServiceProvider(FactoryFinder.java:250)
335-
at javax.xml.parsers.FactoryFinder.find(FactoryFinder.java:223)
336-
at javax.xml.parsers.SAXParserFactory.newInstance(SAXParserFactory.java:128)
337-
at com.sun.tools.doclets.internal.toolkit.builders.LayoutParser.parseXML(LayoutParser.java:72)
338-
at com.sun.tools.doclets.internal.toolkit.builders.ClassBuilder.build(ClassBuilder.java:108)
339-
at com.sun.tools.doclets.formats.html.HtmlDoclet.generateClassFiles(HtmlDoclet.java:155)
340-
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.generateClassFiles(AbstractDoclet.java:164)
341-
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.startGeneration(AbstractDoclet.java:106)
342-
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.start(AbstractDoclet.java:64)
343-
at com.sun.tools.doclets.formats.html.HtmlDoclet.start(HtmlDoclet.java:42)
344-
at com.sun.tools.doclets.standard.Standard.start(Standard.java:23)
345-
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
346-
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
347-
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
348-
at java.lang.reflect.Method.invoke(Method.java:597)
349-
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:215)
350-
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:91)
351-
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
352-
at com.sun.tools.javadoc.Start.begin(Start.java:128)
353-
at com.sun.tools.javadoc.Main.execute(Main.java:41)
354-
at com.sun.tools.javadoc.Main.main(Main.java:31)
355-
com.sun.tools.doclets.internal.toolkit.util.DocletAbortException
356-
at com.sun.tools.doclets.internal.toolkit.builders.LayoutParser.parseXML(LayoutParser.java:79)
357-
at com.sun.tools.doclets.internal.toolkit.builders.ClassBuilder.build(ClassBuilder.java:108)
358-
at com.sun.tools.doclets.formats.html.HtmlDoclet.generateClassFiles(HtmlDoclet.java:155)
359-
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.generateClassFiles(AbstractDoclet.java:164)
360-
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.startGeneration(AbstractDoclet.java:106)
361-
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.start(AbstractDoclet.java:64)
362-
at com.sun.tools.doclets.formats.html.HtmlDoclet.start(HtmlDoclet.java:42)
363-
at com.sun.tools.doclets.standard.Standard.start(Standard.java:23)
364-
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
365-
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
366-
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
367-
at java.lang.reflect.Method.invoke(Method.java:597)
368-
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:215)
369-
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:91)
370-
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
371-
at com.sun.tools.javadoc.Start.begin(Start.java:128)
372-
at com.sun.tools.javadoc.Main.execute(Main.java:41)
373-
at com.sun.tools.javadoc.Main.main(Main.java:31)
374-
com.sun.tools.doclets.internal.toolkit.util.DocletAbortException
375-
at com.sun.tools.doclets.formats.html.HtmlDoclet.generateClassFiles(HtmlDoclet.java:159)
376-
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.generateClassFiles(AbstractDoclet.java:164)
377-
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.startGeneration(AbstractDoclet.java:106)
378-
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.start(AbstractDoclet.java:64)
379-
at com.sun.tools.doclets.formats.html.HtmlDoclet.start(HtmlDoclet.java:42)
380-
at com.sun.tools.doclets.standard.Standard.start(Standard.java:23)
381-
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
382-
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
383-
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
384-
at java.lang.reflect.Method.invoke(Method.java:597)
385-
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:215)
386-
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:91)
387-
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
388-
at com.sun.tools.javadoc.Start.begin(Start.java:128)
389-
at com.sun.tools.javadoc.Main.execute(Main.java:41)
390-
at com.sun.tools.javadoc.Main.main(Main.java:31)
391-
392-
Command line was:C:\Java\jdk1.6.0_03\jre\..\bin\javadoc.exe @options @packages
393-
...]]></source>
394-
</div>
395-
<p>
396-
Your <i>CLASSPATH</i> environement variable is probably corrupted, i.e. something like:
397-
<source>CLASSPATH=.;C:\Java\jdk1.6.0_03\jre\lib\ext\QTJava.zip;%JAVAHOME%</source>
398-
with <code>%JAVAHOME%</code> not a valid environment variable.
399-
</p>
400-
<p>
401-
To resolve it, just reset the <i>CLASSPATH</i> environement variable, i.e.: <source>set CLASSPATH=</source>
402-
or set a new <i>CLASSPATH</i> environement variable, i.e.:
403-
<source>set CLASSPATH=C:\Java\jdk1.6.0_03\jre\lib\ext\QTJava.zip</source>
404-
or fix the wrong environment variable.
405-
</p>
406-
<p>
407-
Refer you to
408-
<a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6219854">http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6219854</a>
409-
from Sun for more details.
410-
</p>
411-
412-
<script language="javascript" type="text/javascript">
413-
function toggleException( divId )
414-
{
415-
var div = document.getElementById( divId );
416-
if( div.style.display == '' )
417-
{
418-
div.style.display = 'none';
419-
}
420-
else
421-
{
422-
div.style.display = '';
423-
}
424-
}
425-
</script>
426-
</answer>
427-
</faq>
428-
<faq id="What are the values of encoding, docencoding and charset parameters">
429-
<question>What are the values of <code>&lt;encoding/&gt;</code>, <code>&lt;docencoding/&gt;</code> and <code>&lt;charset/&gt;</code> parameters?</question>
304+
<faq id="What are the values of the encoding, docencoding, and charset parameters">
305+
<question>What are the values of the <code>&lt;encoding/&gt;</code>, <code>&lt;docencoding/&gt;</code>, and <code>&lt;charset/&gt;</code> parameters?</question>
430306
<answer>
431307
<p>
432308
By default, these parameters have the following values:

0 commit comments

Comments
 (0)