[qdox-scm] [1439] trunk/qdox/src/main/java/com/thoughtworks/qdox/model: Javadoc + code formatting

Sat, 22 Oct 2011 15:04:10 -0700

Title: [1439] trunk/qdox/src/main/java/com/thoughtworks/qdox/model: Javadoc + code formatting
Revision
1439
Author
rfscholte
Date
2011-10-22 17:04:05 -0500 (Sat, 22 Oct 2011)

Log Message

Javadoc + code formatting

Modified Paths

Diff

Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DocletTag.java (1438 => 1439)

--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DocletTag.java	2011-10-22 21:51:50 UTC (rev 1438)
+++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DocletTag.java	2011-10-22 22:04:05 UTC (rev 1439)
@@ -28,20 +28,28 @@
  * @author Aslak Hellesøy
  * @version $Revision$
  */
-public interface DocletTag extends Serializable {
+public interface DocletTag
+    extends Serializable
+{
 
     /**
+     * The name of the doclet tag.
+     * 
      * @return the tag name
      */
     String getName();
 
     /**
+     * The full value of the doclet tag. 
+     * 
      * @return the full tag-value
      */
     String getValue();
 
     /**
-     * @return an array of whitespace-separatedtag parameters
+     * 
+     * 
+     * @return a list of whitespace-separated tag parameters
      */
     List<String> getParameters();
 
@@ -49,22 +57,26 @@
      * @param key name of a named-parameter
      * @return the matching value, otherwise <code>null</code>
      */
-    String getNamedParameter(String key);
+    String getNamedParameter( String key );
 
     /**
      * @return a Map containing all the named-parameters, never <code>null</code>
      */
     Map<String, String> getNamedParameterMap();
-    
+
     /**
-     * @return the line-number where the tag occurred
+     * The line number of the source where this tag occurred.
+     * 
+     * @return the line number where the tag occurred, otherwise <code>-1</code>
      */
     int getLineNumber();
 
     /**
-     * @return the language element to which this tag applies
+     * The element to which this tag applies.
+     * 
+     * @return the annotated element, should never be <code>null</code>
      * @since 1.4
      */
     JavaAnnotatedElement getContext();
 
-}
+}
\ No newline at end of file

Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/impl/DefaultDocletTag.java (1438 => 1439)

--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/impl/DefaultDocletTag.java	2011-10-22 21:51:50 UTC (rev 1438)
+++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/impl/DefaultDocletTag.java	2011-10-22 22:04:05 UTC (rev 1439)
@@ -26,19 +26,23 @@
 import com.thoughtworks.qdox.model.JavaAnnotatedElement;
 import com.thoughtworks.qdox.model.util.TagParser;
 
-public class DefaultDocletTag implements DocletTag {
+public class DefaultDocletTag
+    implements DocletTag
+{
 
     private final String name;
+
     private final String value;
+
     private final int lineNumber;
 
     private List<String> parameters;
+
     private Map<String, String> namedParameters;
+
     private JavaAnnotatedElement context;
 
-    public DefaultDocletTag(String name, String value, 
-                            JavaAnnotatedElement context, 
-                            int lineNumber) 
+    public DefaultDocletTag( String name, String value, JavaAnnotatedElement context, int lineNumber )
     {
         this.name = name;
         this.value = value;
@@ -46,43 +50,58 @@
         this.lineNumber = lineNumber;
     }
 
-    public DefaultDocletTag(String name, String value) {
-        this(name, value, null, 0);
+    public DefaultDocletTag( String name, String value )
+    {
+        this( name, value, null, 0 );
     }
 
-    public String getName() {
+    /** {@inheritDoc} */
+    public String getName()
+    {
         return name;
     }
 
-    public String getValue() {
+    /** {@inheritDoc} */
+    public String getValue()
+    {
         return value;
     }
 
-    public List<String> getParameters() {
-        if (parameters == null) {
-            parameters = TagParser.parseParameters(value);
+    /** {@inheritDoc} */
+    public List<String> getParameters()
+    {
+        if ( parameters == null )
+        {
+            parameters = TagParser.parseParameters( value );
         }
         return parameters;
     }
 
-    public Map<String, String> getNamedParameterMap() {
-        if (namedParameters == null) {
-            namedParameters = TagParser.parseNamedParameters(value);
+    /** {@inheritDoc} */
+    public Map<String, String> getNamedParameterMap()
+    {
+        if ( namedParameters == null )
+        {
+            namedParameters = TagParser.parseNamedParameters( value );
         }
         return namedParameters;
     }
-    
-    public String getNamedParameter(String key) {
-        return (String) getNamedParameterMap().get(key);
+
+    /** {@inheritDoc} */
+    public String getNamedParameter( String key )
+    {
+        return (String) getNamedParameterMap().get( key );
     }
 
-    public final JavaAnnotatedElement getContext() {
+    /** {@inheritDoc} */
+    public final JavaAnnotatedElement getContext()
+    {
         return context;
     }
 
-    public int getLineNumber() {
+    /** {@inheritDoc} */
+    public int getLineNumber()
+    {
         return lineNumber;
     }
-}
-
-
+}
\ No newline at end of file

To unsubscribe from this list please visit:

http://xircles.codehaus.org/manage_email

Reply via email to