Author: jalkanen
Date: Tue Jun 24 14:09:24 2008
New Revision: 671345
URL: http://svn.apache.org/viewvc?rev=671345&view=rev
Log:
Improved documentation.
Added:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/preferences/package.html
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/providers/package.html
Modified:
incubator/jspwiki/trunk/build.properties
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/providers/CachingAttachmentProvider.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rpc/atom/AtomAPIServlet.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rss/AtomFeed.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/search/BasicSearchProvider.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ContentEncodingTag.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ContentTag.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/CookieTag.java
Modified: incubator/jspwiki/trunk/build.properties
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/build.properties?rev=671345&r1=671344&r2=671345&view=diff
==============================================================================
--- incubator/jspwiki/trunk/build.properties (original)
+++ incubator/jspwiki/trunk/build.properties Tue Jun 24 14:09:24 2008
@@ -52,4 +52,4 @@
#
# Which browser to use?
-webtests.browser=*firefox
+webtests.browser=*safari
Added: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/preferences/package.html
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/preferences/package.html?rev=671345&view=auto
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/preferences/package.html
(added)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/preferences/package.html Tue
Jun 24 14:09:24 2008
@@ -0,0 +1,14 @@
+<body>
+
+Preferences storage.
+
+<h2>Package Specification</h2>
+
+Provides storage for the user preferences that JSPWiki uses.
+
+<h2>Related Documentation</h2>
+
+TBD.
+
+<hr>
+</body>
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=671345&r1=671344&r2=671345&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/providers/CachingAttachmentProvider.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/providers/CachingAttachmentProvider.java
Tue Jun 24 14:09:24 2008
@@ -438,9 +438,9 @@
/**
* Returns a clone of the set - you cannot manipulate this.
*
- * @return
+ * @return A list of all items.
*/
- public List getAllItems()
+ public List<Attachment> getAllItems()
{
List<Attachment> ret = new LinkedList<Attachment>();
ret.addAll( m_allItems.values() );
Added: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/providers/package.html
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/providers/package.html?rev=671345&view=auto
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/providers/package.html (added)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/providers/package.html Tue
Jun 24 14:09:24 2008
@@ -0,0 +1,15 @@
+<body>
+
+Provides storage for JSPWiki.
+
+<h2>Package Specification</h2>
+
+Contains all things which actually take care of the storage of the page and
attachments content on the disk
+/ database wherever.
+
+<h2>Related Documentation</h2>
+
+TBD.
+
+<hr>
+</body>
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rpc/atom/AtomAPIServlet.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rpc/atom/AtomAPIServlet.java?rev=671345&r1=671344&r2=671345&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rpc/atom/AtomAPIServlet.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rpc/atom/AtomAPIServlet.java
Tue Jun 24 14:09:24 2008
@@ -48,6 +48,7 @@
*
* @since 2.1.97
*/
+// FIXME: Rewrite using some other library
public class AtomAPIServlet extends HttpServlet
{
static final Logger log = Logger.getLogger( AtomAPIServlet.class );
@@ -57,7 +58,7 @@
private WikiEngine m_engine;
/**
- * Initializes the servlet.
+ * [EMAIL PROTECTED]
*/
public void init( ServletConfig config )
throws ServletException
@@ -96,6 +97,10 @@
* <li>Only fetches the first content. All other contents are ignored.
* <li>Assumes that incoming code is plain text or WikiMarkup, not html.
* </ul>
+ *
+ * @param request [EMAIL PROTECTED]
+ * @param response [EMAIL PROTECTED]
+ * @throws ServletException [EMAIL PROTECTED]
*/
public void doPost( HttpServletRequest request, HttpServletResponse
response )
throws ServletException
@@ -169,6 +174,8 @@
/**
* Handles HTTP GET. However, we do not respond to GET requests,
* other than to show an explanatory text.
+ *
+ * [EMAIL PROTECTED]
*/
public void doGet( HttpServletRequest request, HttpServletResponse
response )
throws ServletException
@@ -313,7 +320,7 @@
}
/**
- *
+ * [EMAIL PROTECTED]
*/
public void doDelete( HttpServletRequest request, HttpServletResponse
response )
throws ServletException
@@ -322,7 +329,7 @@
}
/**
- *
+ * [EMAIL PROTECTED]
*/
public void doPut( HttpServletRequest request, HttpServletResponse
response )
throws ServletException
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rss/AtomFeed.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rss/AtomFeed.java?rev=671345&r1=671344&r2=671345&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rss/AtomFeed.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/rss/AtomFeed.java Tue Jun 24
14:09:24 2008
@@ -69,7 +69,7 @@
* This is a bit complicated right now, as there is no proper metadata
* store in JSPWiki.
*
- * @return
+ * @return An unique feed ID.
*/
private String getFeedID()
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/search/BasicSearchProvider.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/search/BasicSearchProvider.java?rev=671345&r1=671344&r2=671345&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/search/BasicSearchProvider.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/search/BasicSearchProvider.java
Tue Jun 24 14:09:24 2008
@@ -52,16 +52,31 @@
private WikiEngine m_engine;
+ /**
+ * [EMAIL PROTECTED]
+ */
public void initialize(WikiEngine engine, Properties props)
throws NoRequiredPropertyException, IOException
{
m_engine = engine;
}
+ /**
+ * [EMAIL PROTECTED]
+ */
public void pageRemoved(WikiPage page) {}
+ /**
+ * [EMAIL PROTECTED]
+ */
public void reindexPage(WikiPage page) {}
+ /**
+ * Parses a query into something that we can use.
+ *
+ * @param query A query string.
+ * @return A parsed array.
+ */
public QueryItem[] parseQuery(String query)
{
StringTokenizer st = new StringTokenizer( query, " \t," );
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ContentEncodingTag.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ContentEncodingTag.java?rev=671345&r1=671344&r2=671345&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ContentEncodingTag.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ContentEncodingTag.java
Tue Jun 24 14:09:24 2008
@@ -34,6 +34,9 @@
{
private static final long serialVersionUID = 0L;
+ /**
+ * [EMAIL PROTECTED]
+ */
public final int doWikiStartTag()
throws IOException
{
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ContentTag.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ContentTag.java?rev=671345&r1=671344&r2=671345&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ContentTag.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ContentTag.java Tue Jun
24 14:09:24 2008
@@ -42,56 +42,109 @@
private Map<String, String> m_mappings = new HashMap<String, String>();
+ /**
+ * Set the template for the VIEW context.
+ *
+ * @param s The template name.
+ */
public void setView( String s )
{
m_mappings.put( WikiContext.VIEW, s );
}
+ /**
+ * Set the template for the DIFF context.
+ *
+ * @param s The template name.
+ */
public void setDiff( String s )
{
m_mappings.put( WikiContext.DIFF, s );
}
+ /**
+ * Set the template for the INFO context.
+ *
+ * @param s The template name.
+ */
public void setInfo( String s )
{
m_mappings.put( WikiContext.INFO, s );
}
+ /**
+ * Set the template for the PREVIEW context.
+ *
+ * @param s The template name.
+ */
public void setPreview( String s )
{
m_mappings.put( WikiContext.PREVIEW, s );
}
+ /**
+ * Set the template for the CONFLICT context.
+ *
+ * @param s The template name.
+ */
public void setConflict( String s )
{
m_mappings.put( WikiContext.CONFLICT, s );
}
+ /**
+ * Set the template for the FIND context.
+ *
+ * @param s The template name.
+ */
public void setFind( String s )
{
m_mappings.put( WikiContext.FIND, s );
}
+ /**
+ * Set the template for the PREFS context.
+ *
+ * @param s The template name.
+ */
public void setPrefs( String s )
{
m_mappings.put( WikiContext.PREFS, s );
}
+ /**
+ * Set the template for the ERROR context.
+ *
+ * @param s The template name.
+ */
public void setError( String s )
{
m_mappings.put( WikiContext.ERROR, s );
}
+ /**
+ * Set the template for the EDIT context.
+ *
+ * @param s The template name.
+ */
public void setEdit( String s )
{
m_mappings.put( WikiContext.EDIT, s );
}
+ /**
+ * Set the template for the COMMENT context.
+ *
+ * @param s The template name.
+ */
public void setComment( String s )
{
m_mappings.put( WikiContext.COMMENT, s );
}
+ /**
+ * [EMAIL PROTECTED]
+ */
public final int doWikiStartTag()
throws IOException,
ProviderException
@@ -99,6 +152,9 @@
return SKIP_BODY;
}
+ /**
+ * [EMAIL PROTECTED]
+ */
public final int doEndTag()
throws JspException
{
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/CookieTag.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/CookieTag.java?rev=671345&r1=671344&r2=671345&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/CookieTag.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/CookieTag.java Tue Jun
24 14:09:24 2008
@@ -114,37 +114,69 @@
/** Name of a cookie or a cookie nvp to clear. */
private String m_clear;
+ /**
+ * Set the "name" parameter.
+ *
+ * @param s The name.
+ */
public void setName( String s )
{
m_name = s;
}
+ /**
+ * Set the "item" parameter.
+ *
+ * @param s The item.
+ */
public void setItem( String s )
{
m_item = s;
}
+ /**
+ * Set the "value" parameter.
+ *
+ * @param s The value.
+ */
public void setValue( String s )
{
m_value = s;
}
+ /**
+ * Set the "var" parameter.
+ *
+ * @param s The parameter.
+ */
public void setVar( String s )
{
m_scope = s;
}
+ /**
+ * Set the "clear" parameter.
+ *
+ * @param s The parameter.
+ */
public void setClear( String s )
{
m_clear = s;
}
+ /**
+ * Set the "scope" parameter.
+ *
+ * @param s The scope.
+ */
public void setScope( String s )
{
m_scope = s;
}
-
+ /**
+ * [EMAIL PROTECTED]
+ */
public void release()
{
m_name = m_item = m_var = m_value = m_clear = m_scope = null;
@@ -179,7 +211,9 @@
return PageContext.REQUEST_SCOPE;
}
-
+ /**
+ * [EMAIL PROTECTED]
+ */
public int doEndTag()
{
String out = null;
