maven-doxia-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ltheu...@apache.org
Subject svn commit: r636680 - in /maven/doxia/doxia/trunk: doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/docbook/ doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/ doxia-core/src/main/java/org/apache/maven/do...
Date Thu, 13 Mar 2008 09:40:57 GMT
Author: ltheussl
Date: Thu Mar 13 02:40:55 2008
New Revision: 636680

URL: http://svn.apache.org/viewvc?rev=636680&view=rev
Log:
Fix some javadoc warnings

Modified:
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/docbook/DocBookBookSink.java
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/SectionXdocBookSink.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/XhtmlBaseSink.java
    maven/doxia/doxia/trunk/doxia-core/src/main/mdo/document.mdo
    maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BlockParser.java
    maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/GenericListBlockParser.java

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/docbook/DocBookBookSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/docbook/DocBookBookSink.java?rev=636680&r1=636679&r2=636680&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/docbook/DocBookBookSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/docbook/DocBookBookSink.java
Thu Mar 13 02:40:55 2008
@@ -44,7 +44,6 @@
      * Construct a new DocBookSink.
      *
      * @param out the writer for the sink.
-     * @param context the RenderingContext.
      */
     public DocBookBookSink( Writer out )
     {

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/SectionXdocBookSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/SectionXdocBookSink.java?rev=636680&r1=636679&r2=636680&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/SectionXdocBookSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/SectionXdocBookSink.java
Thu Mar 13 02:40:55 2008
@@ -126,7 +126,7 @@
      * Add parent/up link.
      *
      * @param parent the parent IndexEntry.
-     * @see org.apache.maven.doxia.book.services.renderer.xdoc.ChapterXdocBookSink#up(org.apache.maven.doxia.book.context.IndexEntry)
+     * @see org.apache.maven.doxia.book.services.renderer.xdoc.ChapterXdocBookSink#up()
      */
     protected void up( IndexEntry parent )
     {

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java?rev=636680&r1=636679&r2=636680&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java
Thu Mar 13 02:40:55 2008
@@ -573,7 +573,7 @@
     /**
      * {@inheritDoc}
      *
-     * Just calls {@link baseStartTag(XmlPullParser,Sink)}, this should be
+     * Just calls {@link #baseStartTag(XmlPullParser,Sink)}, this should be
      * overridden by implementing parsers to include additional tags.
      */
     protected void handleStartTag( XmlPullParser parser, Sink sink )
@@ -595,7 +595,7 @@
     /**
      * {@inheritDoc}
      *
-     * Just calls {@link baseEndTag(XmlPullParser,Sink)}, this should be
+     * Just calls {@link #baseEndTag(XmlPullParser,Sink)}, this should be
      * overridden by implementing parsers to include additional tags.
      */
     protected void handleEndTag( XmlPullParser parser, Sink sink )

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/XhtmlBaseSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/XhtmlBaseSink.java?rev=636680&r1=636679&r2=636680&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/XhtmlBaseSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/XhtmlBaseSink.java
Thu Mar 13 02:40:55 2008
@@ -712,7 +712,7 @@
     /**
      * {@inheritDoc}
      * @see javax.swing.text.html.HTML.Tag#IMG
-     * @deprecated Use {@link figure(SinkEventAttributes)}, this method is only kept for
+     * @deprecated Use {@link #figure(SinkEventAttributes)}, this method is only kept for
      * backward compatibility. Note that the behavior is different though, as this method
      * writes an img tag, while correctly the img tag should be written by  figureGraphics().
      */
@@ -762,7 +762,7 @@
     }
 
     /** {@inheritDoc}
-     * @deprecated Use {@link figureGraphics(String,SinkEventAttributes)},
+     * @deprecated Use {@link #figureGraphics(String,SinkEventAttributes)},
      * this method is only kept for backward compatibility. Note that the behavior is
      * different though, as this method does not write the img tag, only the src attribute.
      */
@@ -799,7 +799,7 @@
     }
 
     /** {@inheritDoc}
-     * @deprecated Use {@link figureCaption(SinkEventAttributes)},
+     * @deprecated Use {@link #figureCaption(SinkEventAttributes)},
      * this method is only kept for backward compatibility. Note that the behavior is
      * different though, as this method only writes an alt attribute.
      */

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/mdo/document.mdo
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/mdo/document.mdo?rev=636680&r1=636679&r2=636680&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/mdo/document.mdo (original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/mdo/document.mdo Thu Mar 13 02:40:55 2008
@@ -530,6 +530,7 @@
         <field xml.attribute="true">
           <name>targetFrame</name>
           <description><![CDATA[
+            the name of the default target frame.
             <p>
               Specifies the name of the default target frame in which to display
               a document referenced by a hyperlink.

Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BlockParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BlockParser.java?rev=636680&r1=636679&r2=636680&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BlockParser.java
(original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BlockParser.java
Thu Mar 13 02:40:55 2008
@@ -31,14 +31,14 @@
     /**
      * @param line
      * @param source
-     * @return
+     * @return boolean
      */
     boolean accept( String line, ByLineSource source );
 
     /**
      * @param line
      * @param source
-     * @return
+     * @return boolean
      * @throws ParseException
      */
     Block visit( String line, ByLineSource source ) throws ParseException;

Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/GenericListBlockParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/GenericListBlockParser.java?rev=636680&r1=636679&r2=636680&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/GenericListBlockParser.java
(original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/GenericListBlockParser.java
Thu Mar 13 02:40:55 2008
@@ -49,7 +49,7 @@
     private final Pattern [] patterns = new Pattern[TYPES.length];
 
     /**
-     * Creates the GenericListBlockParser. *
+     * Creates the GenericListBlockParser.
      */
     public GenericListBlockParser()
     {



Mime
View raw message