svn commit: r680866 - /maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml

[vs...@apache.org]

Author: vsiveton
Date: Tue Jul 29 15:40:12 2008
New Revision: 680866

URL: http://svn.apache.org/viewvc?rev=680866&view=rev
Log:
o improved faq for links option

Modified:
    maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml

Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml?rev=680866&r1=680865&r2=680866&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml Tue Jul 29 15:40:12 2008
@@ -242,6 +242,19 @@
         </p>
       </answer>
     </faq>
+    <faq id="How to use links option in Standard Doclet">
+      <question>How to use links option in Standard Doclet?</question>
+      <answer>
+        <p>
+          You need to configure the <i>&lt;links/&gt;</i> parameter. Also, you need to correctly write references in
+          your Javadoc, i.e.:
+          <ul>
+            <li><code>@see MyMojo</code> or <code>{@link MyMojo}</code> will <b>NOT work</b>.</li>
+            <li><code>@see com.mycompany.plugin.myplugin.MyMojo</code> or <code>{@link com.mycompany.myplugin.MyMojo}</code> will <b>work</b>.</li>
+          </ul>
+        </p>
+      </answer>
+    </faq>
     <faq id="On Sun JDK, why javadoc:javadoc goal blows up due to an IllegalArgumentException in sun.net.www.ParseUtil.decode()">
       <question>On Sun JDK, why <i>javadoc:javadoc</i> goal blows up due to an IllegalArgumentException in <i>sun.net.www.ParseUtil.decode()</i>?</question>
       <answer>