Author: ajaquith
Date: Sat Mar 8 11:02:57 2008
New Revision: 635043
URL: http://svn.apache.org/viewvc?rev=635043&view=rev
Log:
Tweaks to Javadoc so that they build cleanly. No functionality changes.
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiPage.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/diff/ContextualDiffProvider.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/filters/SpamFilter.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/preferences/Preferences.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/providers/CachingAttachmentProvider.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rss/RSSGenerator.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/GenericHTTPHandler.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/InputValidator.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/TemplateManager.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/admin/beans/CoreBean.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressManager.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/DefaultURLConstructor.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/ShortViewURLConstructor.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/util/CommentedProperties.java
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiPage.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiPage.java?rev=635043&r1=635042&r2=635043&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiPage.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiPage.java Sat Mar 8
11:02:57 2008
@@ -107,7 +107,7 @@
/**
* Sets an metadata attribute.
*
- * @see #getAttribute()
+ * @see #getAttribute(String)
* @param key The key for the attribute used to fetch the attribute later
on.
* @param attribute The attribute value
*/
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/diff/ContextualDiffProvider.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/diff/ContextualDiffProvider.java?rev=635043&r1=635042&r2=635043&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/diff/ContextualDiffProvider.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/diff/ContextualDiffProvider.java
Sat Mar 8 11:02:57 2008
@@ -124,8 +124,7 @@
/**
* Do a colored diff of the two regions. This. is. serious. fun. ;-)
*
- * @see com.ecyrd.jspwiki.diff.DiffProvider#makeDiffHtml(java.lang.String,
- * java.lang.String)
+ * @see com.ecyrd.jspwiki.diff.DiffProvider#makeDiffHtml(WikiContext,
String, String)
*/
public synchronized String makeDiffHtml( WikiContext ctx, String wikiOld,
String wikiNew )
{
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/filters/SpamFilter.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/filters/SpamFilter.java?rev=635043&r1=635042&r2=635043&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/filters/SpamFilter.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/filters/SpamFilter.java Sat
Mar 8 11:02:57 2008
@@ -948,7 +948,7 @@
* Checks whether the UserProfile matches certain checks.
*
* @param profile
- * @return
+ * @return the result of the check
* @since 2.6.1
*/
public boolean isValidUserProfile( WikiContext context, UserProfile
profile )
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/preferences/Preferences.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/preferences/Preferences.java?rev=635043&r1=635042&r2=635043&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/preferences/Preferences.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/preferences/Preferences.java
Sat Mar 8 11:02:57 2008
@@ -115,7 +115,7 @@
*
* @param wikiContext
* @param name
- * @return
+ * @return the preference value
*/
public static String getPreference( WikiContext wikiContext, String name )
{
@@ -132,7 +132,7 @@
*
* @param pageContext
* @param name
- * @return
+ * @return the preference value
*/
public static String getPreference( PageContext pageContext, String name )
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/providers/CachingAttachmentProvider.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/providers/CachingAttachmentProvider.java?rev=635043&r1=635042&r2=635043&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/providers/CachingAttachmentProvider.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/providers/CachingAttachmentProvider.java
Sat Mar 8 11:02:57 2008
@@ -356,7 +356,7 @@
}
/**
- * [EMAIL PROTECTED]
+ * Returns the WikiAttachmentProvider that this caching provider delegates
to.
*/
public WikiAttachmentProvider getRealProvider()
{
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rss/RSSGenerator.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rss/RSSGenerator.java?rev=635043&r1=635042&r2=635043&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rss/RSSGenerator.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rss/RSSGenerator.java Sat Mar
8 11:02:57 2008
@@ -389,7 +389,7 @@
* @param wikiContext
* @param changed
* @param feed
- * @return
+ * @return the RSS representation of the wiki context
*/
protected String generateWikiPageRSS( WikiContext wikiContext, List
changed, Feed feed )
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/GenericHTTPHandler.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/GenericHTTPHandler.java?rev=635043&r1=635042&r2=635043&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/GenericHTTPHandler.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/GenericHTTPHandler.java
Sat Mar 8 11:02:57 2008
@@ -34,7 +34,7 @@
* Get an identifier for this particular AdminBean. This id MUST
* conform to URI rules. The ID must also be unique across all
HTTPHandlers.
*
- * @return
+ * @return the identifier for the bean
*/
public String getId();
@@ -42,14 +42,14 @@
* Return basic HTML.
*
* @param context
- * @return
+ * @return the HTML for the bean
*/
public String doGet( WikiContext context );
/**
* Handles a POST response.
* @param context
- * @return
+ * @return the response string resulting from the POST
*/
public String doPost( WikiContext context );
}
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/InputValidator.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/InputValidator.java?rev=635043&r1=635042&r2=635043&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/InputValidator.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/InputValidator.java Sat
Mar 8 11:02:57 2008
@@ -93,7 +93,7 @@
* [EMAIL PROTECTED] #validate(String, String, int)}.
* @param input the string to validate
* @param label the label for the string or field ("E-mail address")
- * @param type the pattern type to use (<em>e.g.</em>, [EMAIL PROTECTED]
#STANDARD, #EMAIL}.
+ * @param type the pattern type to use (<em>e.g.</em>, [EMAIL PROTECTED]
#STANDARD}, [EMAIL PROTECTED] #EMAIL}.
* @return returns <code>true</code> if valid, <code>false</code>
* otherwise
*/
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/TemplateManager.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/TemplateManager.java?rev=635043&r1=635042&r2=635043&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/TemplateManager.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/TemplateManager.java Sat
Mar 8 11:02:57 2008
@@ -411,7 +411,7 @@
* Returns the include resources marker for a given type. This is in a
* HTML or Javascript comment format.
*
- * @param wiki context
+ * @param context the wiki context
* @param type the marker
* @return the generated marker comment
*/
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/admin/beans/CoreBean.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/admin/beans/CoreBean.java?rev=635043&r1=635042&r2=635043&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/admin/beans/CoreBean.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/admin/beans/CoreBean.java
Sat Mar 8 11:02:57 2008
@@ -45,7 +45,7 @@
/**
* Return the page count in the Wiki.
*
- * @return
+ * @return the page content
*/
public int getPages()
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressManager.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressManager.java?rev=635043&r1=635042&r2=635043&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressManager.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressManager.java
Sat Mar 8 11:02:57 2008
@@ -98,7 +98,7 @@
* Get the progress in percents.
*
* @param id The progress identifier.
- * @return A value between 0 to 100 indicating the progress.
+ * @return a value between 0 to 100 indicating the progress
* @throws IllegalArgumentException If no such progress item exists.
*/
public int getProgress( String id )
@@ -123,8 +123,8 @@
{
/**
* Returns upload progress in percents so far.
- * @param uploadId
- * @return
+ * @param progressId
+ * @return a value between 0 to 100 indicating the progress
*/
public int getProgress( String progressId )
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/DefaultURLConstructor.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/DefaultURLConstructor.java?rev=635043&r1=635042&r2=635043&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/DefaultURLConstructor.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/DefaultURLConstructor.java
Sat Mar 8 11:02:57 2008
@@ -298,8 +298,9 @@
/**
* This method is not needed for the DefaultURLConstructor.
*
- * @return [EMAIL PROTECTED]
- * @param [EMAIL PROTECTED]
+ * @param request The HTTP Request that was used to end up in this page.
+ * @return "Wiki.jsp", "PageInfo.jsp", etc. Just return the name,
+ * JSPWiki will figure out the page.
*/
public String getForwardPage( HttpServletRequest request )
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/ShortViewURLConstructor.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/ShortViewURLConstructor.java?rev=635043&r1=635042&r2=635043&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/ShortViewURLConstructor.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/ShortViewURLConstructor.java
Sat Mar 8 11:02:57 2008
@@ -100,10 +100,10 @@
* Since we're only called from WikiServlet, where we get the VIEW
requests,
* we can safely return this.
*
- * @param [EMAIL PROTECTED]
- * @return [EMAIL PROTECTED]
+ * @param request The HTTP Request that was used to end up in this page.
+ * @return always returns "Wiki.jsp"
*/
- public String getForwardPage( HttpServletRequest req )
+ public String getForwardPage( HttpServletRequest request )
{
return "Wiki.jsp";
}
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/util/CommentedProperties.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/util/CommentedProperties.java?rev=635043&r1=635042&r2=635043&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/util/CommentedProperties.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/util/CommentedProperties.java
Sat Mar 8 11:02:57 2008
@@ -74,7 +74,7 @@
}
/**
- * [EMAIL PROTECTED]
+ * Loads properties from a file opened by a supplied Reader.
*/
public synchronized void load( Reader in ) throws IOException
{
