abdera-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jmsn...@apache.org
Subject svn commit: r474587 - in /incubator/abdera/java/trunk: core/src/main/java/org/apache/abdera/model/ core/src/main/java/org/apache/abdera/util/ core/src/main/java/org/apache/abdera/writer/ extensions/src/main/java/org/apache/abdera/ext/history/ security/...
Date Mon, 13 Nov 2006 23:53:09 GMT
Author: jmsnell
Date: Mon Nov 13 15:53:08 2006
New Revision: 474587

URL: http://svn.apache.org/viewvc?view=rev&rev=474587
Log:
Fixing a bunch of Javadoc errors

Modified:
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/AtomDate.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Collection.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/DateTime.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Div.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Document.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Element.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Entry.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/ExtensibleElement.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Feed.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/IRIElement.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Source.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Text.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Workspace.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/util/AbderaConfiguration.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/WriterFactory.java
    incubator/abdera/java/trunk/extensions/src/main/java/org/apache/abdera/ext/history/FeedPagingHelper.java
    incubator/abdera/java/trunk/security/src/main/java/org/apache/abdera/security/Encryption.java

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/AtomDate.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/AtomDate.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/AtomDate.java (original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/AtomDate.java Mon
Nov 13 15:53:08 2006
@@ -236,7 +236,7 @@
   
   /**
    * Create the serialized string form from a java.util.Date
-   * @param Date A java.util.Date
+   * @param d A java.util.Date
    * @return The serialized string form of the date
    */
   public static String format (Date d) {

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Collection.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Collection.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Collection.java
(original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Collection.java
Mon Nov 13 15:53:08 2006
@@ -78,7 +78,7 @@
   
   /**
    * Return the title element
-   * @returns The title element
+   * @return The title element
    */
   Text getTitleElement();
 
@@ -131,7 +131,7 @@
   
   /**
    * Returns true if the collection accepts the given media-type
-   * @param mediatype The media-type to check
+   * @param mediaType The media-type to check
    * @return True if the media-type is acceptable
    */
   boolean accepts(MimeType mediaType);

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/DateTime.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/DateTime.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/DateTime.java (original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/DateTime.java Mon
Nov 13 15:53:08 2006
@@ -85,7 +85,7 @@
   
   /**
    * Sets the content value of the element
-   * @param The serialized string value
+   * @param date The serialized string value
    */
   void setString(String date);
 }

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Div.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Div.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Div.java (original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Div.java Mon Nov
13 15:53:08 2006
@@ -43,19 +43,19 @@
   
   /** 
    * Sets the value of the div element's id attribute
-   * @param The value of the id attribute
+   * @param id The value of the id attribute
    */
   void setId(String id);
   
   /**
    * Set the value of the div element's title attribute
-   * @param The value of the title attribute
+   * @param title The value of the title attribute
    */
   void setTitle(String title);
   
   /**
    * Sets the array of class attribute values on the div
-   * @param A listing of class attribute values
+   * @param classes A listing of class attribute values
    */
   void setXhtmlClass(String[] classes);
   

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Document.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Document.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Document.java (original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Document.java Mon
Nov 13 15:53:08 2006
@@ -97,7 +97,7 @@
   
   /**
    * Sets the charset used for this document
-   * @param The character encoding to use
+   * @param charset The character encoding to use
    */
   void setCharset(String charset);
   

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Element.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Element.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Element.java (original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Element.java Mon
Nov 13 15:53:08 2006
@@ -183,7 +183,7 @@
 
   /**
    * Sets the value of the named attribute
-   * @param name The XML QName of the attribute
+   * @param qname The XML QName of the attribute
    * @param value The value of the attribute
    */
   void setAttributeValue(QName qname, String value);
@@ -201,7 +201,7 @@
   
   /**
    * Set the Text value of this element
-   * @param The text value
+   * @param text The text value
    */
   void setText(String text);
   

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Entry.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Entry.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Entry.java (original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Entry.java Mon
Nov 13 15:53:08 2006
@@ -227,7 +227,7 @@
   /**
    * Sets the content for this entry
    * @param element The element value
-   * @param mediatype The media type of the element
+   * @param mediaType The media type of the element
    * @throws MimeTypeParseException  if the mediaType is malformed
    */
   Content setContent(Element element, String mediaType) throws MimeTypeParseException;
@@ -786,7 +786,7 @@
   
   /**
    * Returns this entries first alternate link
-   * @reurn the Alternate link
+   * @return the Alternate link
    */
   Link getAlternateLink();
   

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/ExtensibleElement.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/ExtensibleElement.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/ExtensibleElement.java
(original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/ExtensibleElement.java
Mon Nov 13 15:53:08 2006
@@ -94,7 +94,7 @@
   /**
    * Adds a simple extension (text content only)
    * @param namespace An XML namespace
-   * @param localName A local name
+   * @param localPart A local name
    * @param prefix A namespace prefix
    * @param value The simple text value
    * @return The newly created extension element

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Feed.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Feed.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Feed.java (original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Feed.java Mon Nov
13 15:53:08 2006
@@ -119,7 +119,7 @@
   
   /**
    * Adds a new Entry to the <i>start</i> of the Feeds collection of entries
-   * @param An atom:entry to insert
+   * @param entry An atom:entry to insert
    */
   void insertEntry(Entry entry);
 

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/IRIElement.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/IRIElement.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/IRIElement.java
(original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/IRIElement.java
Mon Nov 13 15:53:08 2006
@@ -43,7 +43,7 @@
   
   /**
    * Set the value of this element using the normalization as specified in RFC4287
-   * @param id A non-normalized IRI
+   * @param iri A non-normalized IRI
    * @throws IRISyntaxException if the iri is malformed
    */
   void setNormalizedValue(String iri) throws IRISyntaxException;

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Source.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Source.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Source.java (original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Source.java Mon
Nov 13 15:53:08 2006
@@ -82,7 +82,7 @@
   
   /**
    * Adds an individual author to the entry
-   * @param an atom:author element
+   * @param person an atom:author element
    */
   void addAuthor(Person person);
   
@@ -101,7 +101,7 @@
    * @return The newly created atom:author element
    * @throws IRISyntaxException  if the iri is malformed
    */
-  Person addAuthor(String name, String email, String IRI) throws IRISyntaxException;
+  Person addAuthor(String name, String email, String iri) throws IRISyntaxException;
   
   /**
    * Lists the complete set of categories listed for the entry
@@ -167,7 +167,7 @@
    * @return The atom:contributor element
    * @throws IRISyntaxException if the iri is malformed
    */
-  Person addContributor(String name, String email, String IRI) throws IRISyntaxException;
+  Person addContributor(String name, String email, String iri) throws IRISyntaxException;
   
   /**
    * RFC4287: The "atom:generator" element's content identifies the 
@@ -193,7 +193,7 @@
    * @throws IRISyntaxException if the iri is malformed
    */
   Generator setGenerator(
-    String IRI, 
+    String iri, 
     String version, 
     String value) 
       throws IRISyntaxException;
@@ -214,7 +214,7 @@
    *  identification for a feed... The image SHOULD have an aspect ratio 
    *  of one (horizontal) to one (vertical) and SHOULD be suitable for 
    *  presentation at a small size.
-   *  @param The atom:icon element
+   *  @param iri The atom:icon element
    */
   void setIconElement(IRIElement iri);
   
@@ -250,7 +250,7 @@
   /**
    * RFC4287: The "atom:id" element conveys a permanent, universally unique
    * identifier for an entry or feed.
-   * @param A atom:id element
+   * @param id A atom:id element
    */
   void setIdElement(IRIElement id);
   
@@ -293,7 +293,7 @@
   
   /**
    * Adds an individual link to the entry
-   * @param A atom:link element
+   * @param link A atom:link element
    */
   void addLink(Link link);
   
@@ -346,7 +346,7 @@
    * RFC4287: The "atom:logo" element's content is an IRI reference [RFC3987] 
    * that identifies an image that provides visual identification for a feed.
    * The image SHOULD have an aspect ratio of 2 (horizontal) to 1 (vertical).
-   * @param The atom:logo value
+   * @param iri The atom:logo value
    * @return The newly created atom:logo element
    * @throws IRISyntaxException if the iri is malformed
    */
@@ -478,7 +478,7 @@
   /**
    * Sets the value of the subtitle
    * @param value The value of the atom:subtitle element
-   * @param value The atom:subtitle Text.Type
+   * @param type The atom:subtitle Text.Type
    * @return The newly created atom:subtitle element
    */
   Text setSubtitle(String value, Text.Type type);
@@ -597,14 +597,14 @@
   /**
    * Set the atom:updated value
    * @param value The java.util.Date
-   * @param The newly created atom:updated element
+   * @return The newly created atom:updated element
    */
   DateTime setUpdated(Date value);
   
   /**
    * Set the atom:updated value
    * @param value The serialized string date
-   * @param The newly created atom:updated element
+   * @return The newly created atom:updated element
    */
   DateTime setUpdated(String value);
   

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Text.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Text.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Text.java (original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Text.java Mon Nov
13 15:53:08 2006
@@ -130,7 +130,7 @@
   
   /**
    * Set the wrapped value
-   * @param The text value wrapped in a xhtml:div
+   * @param wrappedValue The text value wrapped in a xhtml:div
    */
   void setWrappedValue(String wrappedValue);
   

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Workspace.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Workspace.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Workspace.java
(original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Workspace.java
Mon Nov 13 15:53:08 2006
@@ -99,7 +99,7 @@
   /**
    * Adds an individual collection to this workspace
    * @param title The collection title
-   * @param hreg The collection HREF
+   * @param href The collection HREF
    * @return The newly created app:collection
    * @throws IRISyntaxException if the href is malformed
    */

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/util/AbderaConfiguration.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/util/AbderaConfiguration.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/util/AbderaConfiguration.java
(original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/util/AbderaConfiguration.java
Mon Nov 13 15:53:08 2006
@@ -102,7 +102,7 @@
 
   /**
    * Retrieve the value of the specified configuration option
-   * @returns The configuration option value or null
+   * @return The configuration option value or null
    */
   public String getConfigurationOption(String id) {
     String option = System.getProperty(id);
@@ -120,7 +120,7 @@
   /**
    * Retrieve the value of the specified configuration option or _default
    * if the value is null
-   * @returns The configuration option value of _default
+   * @return The configuration option value of _default
    */
   public String getConfigurationOption(String id, String _default) {
     String value = getConfigurationOption(id);

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/WriterFactory.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/WriterFactory.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/WriterFactory.java
(original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/writer/WriterFactory.java
Mon Nov 13 15:53:08 2006
@@ -20,7 +20,7 @@
 /**
  * The WriterFactory is used a acquire instances of alternative 
  * writers registered with Abdera.  
- * @see org.apache.abdera.writer.WriterParser 
+ * @see org.apache.abdera.writer.Writer
  */
 public interface WriterFactory {
   
@@ -34,7 +34,7 @@
   /**
    * Get the named writer.
    * @param name The name of the writer
-   * @returns The specified writer
+   * @return The specified writer
    */
   Writer getWriter(String name);
   

Modified: incubator/abdera/java/trunk/extensions/src/main/java/org/apache/abdera/ext/history/FeedPagingHelper.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/extensions/src/main/java/org/apache/abdera/ext/history/FeedPagingHelper.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/extensions/src/main/java/org/apache/abdera/ext/history/FeedPagingHelper.java
(original)
+++ incubator/abdera/java/trunk/extensions/src/main/java/org/apache/abdera/ext/history/FeedPagingHelper.java
Mon Nov 13 15:53:08 2006
@@ -104,7 +104,7 @@
    * Adds a next link relation to the feed
    * @param feed The feed 
    * @param iri The IRI of the next feed document
-   * @returns The newly created Link
+   * @return The newly created Link
    */
   public static Link setNext(Feed feed, String iri) throws IRISyntaxException {
     Link link = feed.getLink("next");
@@ -120,7 +120,7 @@
    * Adds a previous link relation to the feed
    * @param feed The feed 
    * @param iri The IRI of the previous feed document
-   * @returns The newly created Link
+   * @return The newly created Link
    */
   public static Link setPrevious(Feed feed, String iri) throws IRISyntaxException {
     Link link = feed.getLink("previous");
@@ -136,7 +136,7 @@
    * Adds a first link relation to the feed
    * @param feed The feed 
    * @param iri The IRI of the first feed document
-   * @returns The newly created Link
+   * @return The newly created Link
    */
   public static Link setFirst(Feed feed, String iri) throws IRISyntaxException {
     Link link = feed.getLink("first");
@@ -152,7 +152,7 @@
    * Adds a last link relation to the feed
    * @param feed The feed 
    * @param iri The IRI of the last feed document
-   * @returns The newly created Link
+   * @return The newly created Link
    */
   public static Link setLast(Feed feed, String iri) throws IRISyntaxException {
     Link link = feed.getLink("last");
@@ -168,7 +168,7 @@
    * Adds a next-archive link relation to the feed
    * @param feed The feed 
    * @param iri The IRI of the next archive feed document
-   * @returns The newly created Link
+   * @return The newly created Link
    */
   public static Link setNextArchive(Feed feed, String iri) throws IRISyntaxException {
     Link link = feed.getLink("next-archive");
@@ -187,7 +187,7 @@
    * Adds a prev-archive link relation to the feed
    * @param feed The feed 
    * @param iri The IRI of the previous archive feed document
-   * @returns The newly created Link
+   * @return The newly created Link
    */
   public static Link setPreviousArchive(Feed feed, String iri) throws IRISyntaxException
{
     Link link = feed.getLink("prev-archive");
@@ -206,7 +206,7 @@
    * Adds a current link relation to the feed
    * @param feed The feed 
    * @param iri The IRI of the current feed document
-   * @returns The newly created Link
+   * @return The newly created Link
    */
   public static Link setCurrent(Feed feed, String iri) throws IRISyntaxException {
     Link link = feed.getLink("current");

Modified: incubator/abdera/java/trunk/security/src/main/java/org/apache/abdera/security/Encryption.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/security/src/main/java/org/apache/abdera/security/Encryption.java?view=diff&rev=474587&r1=474586&r2=474587
==============================================================================
--- incubator/abdera/java/trunk/security/src/main/java/org/apache/abdera/security/Encryption.java
(original)
+++ incubator/abdera/java/trunk/security/src/main/java/org/apache/abdera/security/Encryption.java
Mon Nov 13 15:53:08 2006
@@ -28,7 +28,7 @@
    * Encrypt the document using the specified options
    * @param doc The document to encrypt
    * @param options The encryption options
-   * @returns The encrypted document
+   * @return The encrypted document
    * @throws org.apache.abdera.security.SecurityException if the encryption failed
    */
   Document encrypt(
@@ -40,7 +40,7 @@
    * Decrypt the document using the specified options
    * @param doc The document to decrypt
    * @param options The decryption options
-   * @returns The decrypted document
+   * @return The decrypted document
    * @throws org.apache.abdera.security.SecurityException if the decryption failed
    */
   Document decrypt(



Mime
View raw message