roller-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From snoopd...@apache.org
Subject svn commit: r777932 - in /roller/trunk/apps/weblogger: nbproject/ src/java/org/apache/roller/weblogger/business/ src/java/org/apache/roller/weblogger/pojos/ src/java/org/apache/roller/weblogger/ui/rendering/servlets/ src/java/org/apache/roller/weblogge...
Date Sat, 23 May 2009 14:11:26 GMT
Author: snoopdave
Date: Sat May 23 14:11:25 2009
New Revision: 777932

URL: http://svn.apache.org/viewvc?rev=777932&view=rev
Log:
Dozen or so Javadoc fixes , see ROL-1810
  https://issues.apache.org/jira/browse/ROL-1810

Modified:
    roller/trunk/apps/weblogger/nbproject/project.xml
    roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/BookmarkManager.java
    roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/UserManager.java
    roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/WeblogEntryManager.java
    roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/WeblogManager.java
    roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/pojos/Resource.java
    roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/pojos/ThemeResource.java
    roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/ui/rendering/servlets/PageServlet.java
    roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/util/GenericThrottle.java

Modified: roller/trunk/apps/weblogger/nbproject/project.xml
URL: http://svn.apache.org/viewvc/roller/trunk/apps/weblogger/nbproject/project.xml?rev=777932&r1=777931&r2=777932&view=diff
==============================================================================
--- roller/trunk/apps/weblogger/nbproject/project.xml (original)
+++ roller/trunk/apps/weblogger/nbproject/project.xml Sat May 23 14:11:25 2009
@@ -4,7 +4,7 @@
     <configuration>
         <general-data xmlns="http://www.netbeans.org/ns/freeform-project/1">
             <!-- Do not use Project Properties customizer when editing this file manually.
-->
-            <name>workspace - roller_weblogger_trunk</name>
+            <name>roller_weblogger_trunk</name>
             <properties>
                 <property name="ant.script">build.xml</property>
             </properties>

Modified: roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/BookmarkManager.java
URL: http://svn.apache.org/viewvc/roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/BookmarkManager.java?rev=777932&r1=777931&r2=777932&view=diff
==============================================================================
--- roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/BookmarkManager.java
(original)
+++ roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/BookmarkManager.java
Sat May 23 14:11:25 2009
@@ -71,7 +71,7 @@
      * Lookup a folder by ID.
      *
      * @param id The id of the folder to lookup.
-     * @returns FolderData The folder, or null if not found.
+     * @return FolderData The folder, or null if not found.
      * @throws WebloggerException If there is a problem.
      */
     public WeblogBookmarkFolder getFolder(String id) throws WebloggerException;
@@ -81,7 +81,7 @@
      * Get all folders for a weblog.
      *
      * @param weblog The weblog we want the folders from.
-     * @returns List The list of FolderData objects from the weblog.
+     * @return List The list of FolderData objects from the weblog.
      * @throws WebloggerException If there is a problem.
      */
     public List getAllFolders(Weblog weblog) throws WebloggerException;
@@ -92,7 +92,7 @@
      * All weblogs should have only 1 root folder.
      *
      * @param weblog The weblog we want the root folder from.
-     * @returns FolderData The root folder, or null if not found.
+     * @return FolderData The root folder, or null if not found.
      * @throws WebloggerException If there is a problem.
      */
     public WeblogBookmarkFolder getRootFolder(Weblog weblog) throws WebloggerException;
@@ -103,7 +103,7 @@
      *
      * @param weblog The weblog we want the folder from.
      * @param path The full path of the folder.
-     * @returns FolderData The folder from the given path, or null if not found.
+     * @return FolderData The folder from the given path, or null if not found.
      * @throws WebloggerException If there is a problem.
      */
     public WeblogBookmarkFolder getFolder(Weblog weblog, String path)
@@ -132,7 +132,7 @@
      * Lookup a Bookmark by ID.
      *
      * @param id The id of the bookmark to lookup.
-     * @returns BookmarkData The bookmark, or null if not found.
+     * @return BookmarkData The bookmark, or null if not found.
      * @throws WebloggerException If there is a problem.
      */
     public WeblogBookmark getBookmark(String id) throws WebloggerException;
@@ -143,7 +143,7 @@
      *
      * @param folder The folder to get the bookmarks from.
      * @param recurse True if bookmarks should be included.
-     * @returns List The list of bookmarks found.
+     * @return List The list of bookmarks found.
      * @throws WebloggerException If there is a problem.
      */
     public List getBookmarks(WeblogBookmarkFolder folder, boolean recurse)

Modified: roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/UserManager.java
URL: http://svn.apache.org/viewvc/roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/UserManager.java?rev=777932&r1=777931&r2=777932&view=diff
==============================================================================
--- roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/UserManager.java
(original)
+++ roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/UserManager.java
Sat May 23 14:11:25 2009
@@ -93,7 +93,7 @@
      * should return null if the user is found but is not enabled.
      * 
      * @param userName User Name of user to lookup.
-     * @returns UsUserhe user, or null if not found or is disabled.
+     * @return UsUserhe user, or null if not found or is disabled.
      * @throws WebloggerException If there is a problem.
      */
     public User getUserByUserName(String userName) throws WebloggerException;
@@ -102,7 +102,7 @@
      * Lookup a user by UserName with the given enabled status.
      * 
      * @param userName User Name of user to lookup.
-     * @returns The user, or null if not found or doesn't match the proper enabled status.
+     * @return The user, or null if not found or doesn't match the proper enabled status.
      * @throws WebloggerException If there is a problem.
      */
     public User getUserByUserName(String userName, Boolean enabled)
@@ -122,7 +122,7 @@
      * @param endDate Restrict to those created before startDate (or null for all)
      * @param offset The index of the first result to return.
      * @param length The number of results to return.
-     * @returns List A list of UserDatUsers which match the criteria.
+     * @return List A list of UserDatUsers which match the criteria.
      * @throws WebloggerException If there is a problem.
      */
     public List getUsers(

Modified: roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/WeblogEntryManager.java
URL: http://svn.apache.org/viewvc/roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/WeblogEntryManager.java?rev=777932&r1=777931&r2=777932&view=diff
==============================================================================
--- roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/WeblogEntryManager.java
(original)
+++ roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/WeblogEntryManager.java
Sat May 23 14:11:25 2009
@@ -162,7 +162,7 @@
      * @param endDate    End date or null for no end date.
      * @param offset     Offset into results for paging
      * @param length     Max comments to return (or -1 for no limit)
-     * @returns List of WeblogEntryData objects.
+     * @return List of WeblogEntryData objects.
      */
     public List getMostCommentedWeblogEntries(
             Weblog website,             

Modified: roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/WeblogManager.java
URL: http://svn.apache.org/viewvc/roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/WeblogManager.java?rev=777932&r1=777931&r2=777932&view=diff
==============================================================================
--- roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/WeblogManager.java
(original)
+++ roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/business/WeblogManager.java
Sat May 23 14:11:25 2009
@@ -81,7 +81,7 @@
      * @param endDate   Restrict to those created before (or null for all)
      * @param offset    Offset into results (for paging)
      * @param length    Maximum number of results to return (for paging)
-     * @returns List of WebsiteData objects.
+     * @return List of WebsiteData objects.
      */
     public List getWeblogs(
             Boolean  enabled,
@@ -97,7 +97,7 @@
      * Get websites of a user.
      * @param user        Get all weblogs for this user
      * @param enabledOnly Include only enabled weblogs?
-     * @returns List of WebsiteData objects.
+     * @return List of WebsiteData objects.
      */
     public List getUserWeblogs(User user, boolean enabledOnly) throws WebloggerException;
     
@@ -106,7 +106,7 @@
      * Get users of a weblog.
      * @param user        Get all users for this weblog
      * @param enabledOnly Include only enabled users?
-     * @returns List of WebsiteData objects.
+     * @return List of WebsiteData objects.
      */
     public List getWeblogUsers(Weblog weblog, boolean enabledOnly) throws WebloggerException;
     
@@ -117,7 +117,7 @@
      * @param endDate Restrict to those created before (or null for all)
      * @param offset    Offset into results (for paging)
      * @param len       Maximum number of results to return (for paging)
-     * @returns List of WebsiteData objects.
+     * @return List of WebsiteData objects.
      */
     public List getMostCommentedWeblogs(
             Date startDate,

Modified: roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/pojos/Resource.java
URL: http://svn.apache.org/viewvc/roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/pojos/Resource.java?rev=777932&r1=777931&r2=777932&view=diff
==============================================================================
--- roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/pojos/Resource.java (original)
+++ roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/pojos/Resource.java Sat
May 23 14:11:25 2009
@@ -31,7 +31,7 @@
      * The short name of this resource.
      * i.e. "some.jpg"
      *
-     * @returns The short name for the resource.
+     * @return The short name for the resource.
      */
     public String getName();
     
@@ -40,7 +40,7 @@
      * The path to this resource, relative to its container.
      * i.e. "images/some.jpg"
      *
-     * @returns The path to the resource, relative to its container.
+     * @return The path to the resource, relative to its container.
      */
     public String getPath();
     
@@ -48,7 +48,7 @@
     /**
      * The last-modified time for this resource.
      *
-     * @returns The last time the resource changed, as a long value.
+     * @return The last time the resource changed, as a long value.
      */
     public long getLastModified();
     
@@ -56,7 +56,7 @@
     /**
      * The length of this resource, in bytes.
      *
-     * @returns The length of the resource in bytes.
+     * @return The length of the resource in bytes.
      */
     public long getLength();
     
@@ -64,7 +64,7 @@
     /**
      * An InputStream that the resource can be read from.
      *
-     * @returns an InputStream for the resource.
+     * @return an InputStream for the resource.
      */
     public InputStream getInputStream();
     

Modified: roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/pojos/ThemeResource.java
URL: http://svn.apache.org/viewvc/roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/pojos/ThemeResource.java?rev=777932&r1=777931&r2=777932&view=diff
==============================================================================
--- roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/pojos/ThemeResource.java
(original)
+++ roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/pojos/ThemeResource.java
Sat May 23 14:11:25 2009
@@ -27,7 +27,7 @@
     /**
      * Does this resource represent a directory?  True if yes, False otherwise.
      *
-     * @returns True if the resource is a directory, False otherwise.
+     * @return True if the resource is a directory, False otherwise.
      */
     public boolean isDirectory();
     
@@ -35,7 +35,7 @@
     /**
      * Does this resource represent a file?  True if yes, False otherwise.
      *
-     * @returns True if the resource is a file, False otherwise.
+     * @return True if the resource is a file, False otherwise.
      */
     public boolean isFile();
     
@@ -46,7 +46,7 @@
      * The children returned by this method should only be actual files.  No
      * directories should be returned by this method.
      *
-     * @returns null if resource is not a directory, otherwise a WeblogResource[].
+     * @return null if resource is not a directory, otherwise a WeblogResource[].
      */
     public ThemeResource[] getChildren();
     

Modified: roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/ui/rendering/servlets/PageServlet.java
URL: http://svn.apache.org/viewvc/roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/ui/rendering/servlets/PageServlet.java?rev=777932&r1=777931&r2=777932&view=diff
==============================================================================
--- roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/ui/rendering/servlets/PageServlet.java
(original)
+++ roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/ui/rendering/servlets/PageServlet.java
Sat May 23 14:11:25 2009
@@ -510,7 +510,7 @@
      * Process the incoming request to extract referrer info and pass it on
      * to the referrer processing queue for tracking.
      *
-     * @returns true if referrer was spam, false otherwise
+     * @return true if referrer was spam, false otherwise
      */
     private boolean processReferrer(HttpServletRequest request) {
 

Modified: roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/util/GenericThrottle.java
URL: http://svn.apache.org/viewvc/roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/util/GenericThrottle.java?rev=777932&r1=777931&r2=777932&view=diff
==============================================================================
--- roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/util/GenericThrottle.java
(original)
+++ roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/util/GenericThrottle.java
Sat May 23 14:11:25 2009
@@ -136,7 +136,7 @@
      * A client is considered abusive if the number of hits from the client
      * within the configured interval is greater than the set threshold.
      *
-     * @returns true if client is abusive, false otherwise.
+     * @return true if client is abusive, false otherwise.
      */
     public boolean isAbusive(String clientId) {
         



Mime
View raw message