Author: jalkanen
Date: Sat Jun 14 14:10:18 2008
New Revision: 667885
URL: http://svn.apache.org/viewvc?rev=667885&view=rev
Log:
Javadoc fixes.
Modified:
incubator/jspwiki/trunk/ChangeLog
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/auth/login/AbstractLoginModule.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/auth/user/AbstractUserDatabase.java
Modified: incubator/jspwiki/trunk/ChangeLog
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/ChangeLog?rev=667885&r1=667884&r2=667885&view=diff
==============================================================================
--- incubator/jspwiki/trunk/ChangeLog (original)
+++ incubator/jspwiki/trunk/ChangeLog Sat Jun 14 14:10:18 2008
@@ -24,6 +24,9 @@
* JSPWIKI-57: Should resolve NotSerializableExceptions when container
goes up or down.
+ * JSPWIKI-292: Comment.jsp didn't compile. Oops! Thanks to Harry
Metske
+ for the patch.
+
2007-06-14 Dirk Frederickx <[EMAIL PROTECTED]>
* 2.7.0-svn-41 Many template fixes, added ajaxed edit preview,
improved IE6/IE7 compat.
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/auth/login/AbstractLoginModule.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/auth/login/AbstractLoginModule.java?rev=667885&r1=667884&r2=667885&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/auth/login/AbstractLoginModule.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/auth/login/AbstractLoginModule.java
Sat Jun 14 14:10:18 2008
@@ -240,7 +240,7 @@
* Returns <code>true</code> if the number of principals
* contained in [EMAIL PROTECTED] #m_principals} is non-zero;
* <code>false</code> otherwise.
- * @return
+ * @return True, if a login has succeeded.
*/
private final boolean succeeded()
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/auth/user/AbstractUserDatabase.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/auth/user/AbstractUserDatabase.java?rev=667885&r1=667884&r2=667885&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/auth/user/AbstractUserDatabase.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/auth/user/AbstractUserDatabase.java
Sat Jun 14 14:10:18 2008
@@ -119,21 +119,25 @@
}
/**
+ * [EMAIL PROTECTED]
* @see
com.ecyrd.jspwiki.auth.user.UserDatabase#findByEmail(java.lang.String)
*/
public abstract UserProfile findByEmail( String index ) throws
NoSuchPrincipalException;
/**
+ * [EMAIL PROTECTED]
* @see
com.ecyrd.jspwiki.auth.user.UserDatabase#findByFullName(java.lang.String)
*/
public abstract UserProfile findByFullName( String index ) throws
NoSuchPrincipalException;
/**
+ * [EMAIL PROTECTED]
* @see
com.ecyrd.jspwiki.auth.user.UserDatabase#findByLoginName(java.lang.String)
*/
public abstract UserProfile findByLoginName( String index ) throws
NoSuchPrincipalException;
/**
+ * [EMAIL PROTECTED]
* @see
com.ecyrd.jspwiki.auth.user.UserDatabase#findByWikiName(java.lang.String)
*/
public abstract UserProfile findByWikiName( String index ) throws
NoSuchPrincipalException;
@@ -151,6 +155,7 @@
* [EMAIL PROTECTED] UserProfile#getLoginName()}method.
* @return the array of Principals representing the user
* @see
com.ecyrd.jspwiki.auth.user.UserDatabase#getPrincipals(java.lang.String)
+ * @throws [EMAIL PROTECTED]
*/
public Principal[] getPrincipals( String identifier ) throws
NoSuchPrincipalException
{
@@ -179,6 +184,7 @@
}
/**
+ * [EMAIL PROTECTED]
* @see
com.ecyrd.jspwiki.auth.user.UserDatabase#initialize(com.ecyrd.jspwiki.WikiEngine,
java.util.Properties)
*/
public abstract void initialize( WikiEngine engine, Properties props )
throws NoRequiredPropertyException;
@@ -186,6 +192,8 @@
/**
* Factory method that instantiates a new DefaultUserProfile with a new,
distinct
* unique identifier.
+ *
+ * @return A new, empty profile.
*/
public UserProfile newProfile()
{
@@ -193,6 +201,7 @@
}
/**
+ * [EMAIL PROTECTED]
* @see
com.ecyrd.jspwiki.auth.user.UserDatabase#save(com.ecyrd.jspwiki.auth.user.UserProfile)
*/
public abstract void save( UserProfile profile ) throws
WikiSecurityException;
@@ -268,7 +277,9 @@
/**
* Generates a new random user identifier (uid) that is guaranteed to be
unique.
- * @return
+ *
+ * @param db The database for which the UID should be generated.
+ * @return A random, unique UID.
*/
protected static long generateUid( UserDatabase db )
{
