You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jspwiki.apache.org by me...@apache.org on 2008/12/21 14:03:56 UTC
svn commit: r728435 - in
/incubator/jspwiki/trunk/src/org/apache/jspwiki/api: PageFilter.java
PluginException.java WikiContext.java WikiEngine.java WikiPage.java
WikiSession.java
Author: metskem
Date: Sun Dec 21 05:03:56 2008
New Revision: 728435
URL: http://svn.apache.org/viewvc?rev=728435&view=rev
Log:
a few typo corrections for the api package
Modified:
incubator/jspwiki/trunk/src/org/apache/jspwiki/api/PageFilter.java
incubator/jspwiki/trunk/src/org/apache/jspwiki/api/PluginException.java
incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiContext.java
incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiEngine.java
incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiPage.java
incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiSession.java
Modified: incubator/jspwiki/trunk/src/org/apache/jspwiki/api/PageFilter.java
URL: http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/org/apache/jspwiki/api/PageFilter.java?rev=728435&r1=728434&r2=728435&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/org/apache/jspwiki/api/PageFilter.java (original)
+++ incubator/jspwiki/trunk/src/org/apache/jspwiki/api/PageFilter.java Sun Dec 21 05:03:56 2008
@@ -30,7 +30,7 @@
* <p>
* Note that the WikiContext.getPage() method always returns the context
* in which text is rendered, i.e. the original request. Thus the content
- * may actually be different content than what what the wikiContext.getPage()
+ * may actually be different content than what the wikiContext.getPage()
* implies! This happens often if you are for example including multiple
* pages on the same page.
* <p>
@@ -47,7 +47,7 @@
* Is called whenever the a new PageFilter is instantiated and
* reset.
*
- * @param engine The WikiEngine whic owns this PageFilter
+ * @param engine The WikiEngine which owns this PageFilter
* @param properties The properties ripped from filters.xml.
* @throws FilterException If the filter could not be initialized. If this is thrown,
* the filter is not added to the internal queues.
@@ -107,13 +107,13 @@
* @param wikiContext The WikiContext
* @param content The content which was just stored.
* @throws FilterException If something goes wrong. As the page is already saved,
- * This is just logged.
+ * this is just logged.
*/
public void postSave( WikiContext wikiContext, String content )
throws FilterException;
/**
- * Called for every filter, e.g. on wiki eingine shutdown. Use this if you have to
+ * Called for every filter, e.g. on wiki engine shutdown. Use this if you have to
* clean up or close global resources you allocated in the initialize() method.
*
* @param engine The WikiEngine which owns this filter.
Modified: incubator/jspwiki/trunk/src/org/apache/jspwiki/api/PluginException.java
URL: http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/org/apache/jspwiki/api/PluginException.java?rev=728435&r1=728434&r2=728435&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/org/apache/jspwiki/api/PluginException.java (original)
+++ incubator/jspwiki/trunk/src/org/apache/jspwiki/api/PluginException.java Sun Dec 21 05:03:56 2008
@@ -22,7 +22,7 @@
/**
* Provides a generic PluginException. This is the kind of
- * an exception that the plugins should throw.
+ * exception that the plugins should throw.
*/
public class PluginException
extends WikiException
Modified: incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiContext.java
URL: http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiContext.java?rev=728435&r1=728434&r2=728435&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiContext.java (original)
+++ incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiContext.java Sun Dec 21 05:03:56 2008
@@ -45,7 +45,7 @@
* {@link WikiSession} object with the user's HttpSession. The
* WikiSession contains information about the user's authentication
* status, and is consulted by {@link #getCurrentUser()}.
- * object</p>
+ * method</p>
* <p>Do not cache the page object that you get from the WikiContext; always
* use getPage()!</p>
*
@@ -287,7 +287,7 @@
* A shortcut to generate a VIEW url.
*
* @param page The page to which to link.
- * @return An URL to the page. This honours the current absolute/relative setting.
+ * @return A URL to the page. This honours the current absolute/relative setting.
*/
public String getViewURL( String page );
@@ -296,7 +296,7 @@
*
* @param context e.g. WikiContext.EDIT
* @param page The page to which to link
- * @return An URL to the page, honours the absolute/relative setting in jspwiki.properties
+ * @return A URL to the page, honours the absolute/relative setting in jspwiki.properties
*/
public String getURL( String context,
String page );
@@ -310,7 +310,7 @@
* @param page The page to which to link
* @param params A list of parameters, separated with "&"
*
- * @return An URL to the given context and page.
+ * @return A URL to the given context and page.
*/
public String getURL( String context,
String page,
Modified: incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiEngine.java
URL: http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiEngine.java?rev=728435&r1=728434&r2=728435&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiEngine.java (original)
+++ incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiEngine.java Sun Dec 21 05:03:56 2008
@@ -47,7 +47,7 @@
public WikiRenderer getRenderer( String type );
/**
- * Get a configuration parameter.
+ * Gets a configuration parameter.
*/
public String getConfigParameter( String key );
Modified: incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiPage.java
URL: http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiPage.java?rev=728435&r1=728434&r2=728435&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiPage.java (original)
+++ incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiPage.java Sun Dec 21 05:03:56 2008
@@ -73,7 +73,7 @@
* on-the-fly. A provider is not required to save them, but they
* can do that if they really want.
*
- * @param key The key using which the attribute is fetched
+ * @param key The key to use for fetching the attribute
* @return The attribute. If the attribute has not been set, returns null.
*/
public Object getAttribute( String key );
@@ -162,7 +162,7 @@
public Acl getAcl();
/**
- * Sets the Acl for this page. Note that method does <em>not</em>
+ * Sets the Acl for this page. Note that this method does <em>not</em>
* persist the Acl itself to back-end storage or in page markup;
* it merely sets the internal field that stores the Acl. To
* persist the Acl, callers should invoke
@@ -186,7 +186,7 @@
public String getAuthor();
/**
- * Returns the wiki nanme for this page
+ * Returns the wiki name for this page
*
* @return The name of the wiki.
*/
Modified: incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiSession.java
URL: http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiSession.java?rev=728435&r1=728434&r2=728435&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiSession.java (original)
+++ incubator/jspwiki/trunk/src/org/apache/jspwiki/api/WikiSession.java Sun Dec 21 05:03:56 2008
@@ -136,7 +136,7 @@
* with type designator <code>WIKI_NAME</code> or (alternatively)
* <code>FULL_NAME</code> is the primary Principal.</li>
* <li>For all other cases, the first Principal in the Subject's principal
- * collection that that isn't of type Role or GroupPrincipal is the primary.</li>
+ * collection that isn't of type Role or GroupPrincipal is the primary.</li>
* </ol>
* If no primary user Principal is found, this method returns
* {@link com.ecyrd.jspwiki.auth.WikiPrincipal#GUEST}.
@@ -229,7 +229,7 @@
/**
* Returns <code>true</code> if the WikiSession's Subject
- * possess a supplied Principal. This method eliminates the need
+ * possesses the supplied Principal. This method eliminates the need
* to externally request and inspect the JAAS subject.
* @param principal the Principal to test
* @return the result