mpoeschl 2003/08/29 13:33:10
Modified: src/java/org/apache/turbine/util/template
TemplateLinkWithSlash.java
RelativeTemplateLink.java TemplateLink.java
src/java/org/apache/turbine/services/avaloncomponent
TurbineAvalonComponentService.java
src/java/org/apache/turbine/services package.html
src/java/org/apache/turbine/util/uri TurbineURI.java
src/java/org/apache/turbine/util
TurbineRuntimeException.java ServerData.java
Log:
fix javadoc warnings
Revision Changes Path
1.7 +2 -2
jakarta-turbine-2/src/java/org/apache/turbine/util/template/TemplateLinkWithSlash.java
Index: TemplateLinkWithSlash.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/template/TemplateLinkWithSlash.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- TemplateLinkWithSlash.java 7 May 2003 14:34:38 -0000 1.6
+++ TemplateLinkWithSlash.java 29 Aug 2003 20:33:09 -0000 1.7
@@ -74,7 +74,7 @@
extends TemplateLink
{
/**
- * Default constructor
+ * Default constructor.
* <p>
* The init method must be called before use.
*/
1.8 +2 -2
jakarta-turbine-2/src/java/org/apache/turbine/util/template/RelativeTemplateLink.java
Index: RelativeTemplateLink.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/template/RelativeTemplateLink.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- RelativeTemplateLink.java 7 May 2003 14:34:38 -0000 1.7
+++ RelativeTemplateLink.java 29 Aug 2003 20:33:09 -0000 1.8
@@ -83,7 +83,7 @@
private String template = null;
/**
- * Default constructor
+ * Default constructor.
* <p>
* The init method must be called before use.
*/
1.8 +2 -2
jakarta-turbine-2/src/java/org/apache/turbine/util/template/TemplateLink.java
Index: TemplateLink.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/template/TemplateLink.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- TemplateLink.java 7 May 2003 14:34:38 -0000 1.7
+++ TemplateLink.java 29 Aug 2003 20:33:09 -0000 1.8
@@ -88,7 +88,7 @@
private String template = null;
/**
- * Default constructor
+ * Default constructor.
* <p>
* The init method must be called before use.
*/
1.17 +2 -2
jakarta-turbine-2/src/java/org/apache/turbine/services/avaloncomponent/TurbineAvalonComponentService.java
Index: TurbineAvalonComponentService.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/services/avaloncomponent/TurbineAvalonComponentService.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- TurbineAvalonComponentService.java 27 Jun 2003 22:28:27 -0000 1.16
+++ TurbineAvalonComponentService.java 29 Aug 2003 20:33:10 -0000 1.17
@@ -79,7 +79,7 @@
/**
* An implementation of AvalonComponentService which loads all the
- * components given in the TurbineResources.properties File
+ * components given in the TurbineResources.properties File.
* <p>
* For component which require the location of the application or
* context root, there are two ways to get it.
1.3 +1 -3
jakarta-turbine-2/src/java/org/apache/turbine/services/package.html
Index: package.html
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/services/package.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- package.html 8 Dec 2002 17:34:34 -0000 1.2
+++ package.html 29 Aug 2003 20:33:10 -0000 1.3
@@ -5,8 +5,6 @@
<body>
Contains the Service framework for Turbine.
-<!-- description that appears in API overview and at the top of package overview -->
-<!-- it is terminated by the first '.' in the body part -->
<p>
Services are singletons that have pluggable implementation
and can participate in Turbine startup and shutdown.
1.7 +25 -37
jakarta-turbine-2/src/java/org/apache/turbine/util/uri/TurbineURI.java
Index: TurbineURI.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/uri/TurbineURI.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- TurbineURI.java 27 May 2003 22:28:24 -0000 1.6
+++ TurbineURI.java 29 Aug 2003 20:33:10 -0000 1.7
@@ -104,7 +104,6 @@
/**
* Empty C'tor. Uses Turbine.getDefaultServerData().
- *
*/
public TurbineURI()
{
@@ -113,7 +112,7 @@
}
/**
- * Constructor with a RunData object
+ * Constructor with a RunData object.
*
* @param runData A RunData object
*/
@@ -124,7 +123,7 @@
}
/**
- * Constructor, set explicit redirection
+ * Constructor, set explicit redirection.
*
* @param runData A RunData object
* @param redirect True if redirection allowed.
@@ -136,7 +135,7 @@
}
/**
- * Constructor, set Screen
+ * Constructor, set Screen.
*
* @param runData A RunData object
* @param screen A Screen Name
@@ -148,7 +147,7 @@
}
/**
- * Constructor, set Screen, set explicit redirection
+ * Constructor, set Screen, set explicit redirection.
*
* @param runData A RunData object
* @param screen A Screen Name
@@ -161,7 +160,7 @@
}
/**
- * Constructor, set Screen and Action
+ * Constructor, set Screen and Action.
*
* @param runData A RunData object
* @param screen A Screen Name
@@ -174,7 +173,7 @@
}
/**
- * Constructor, set Screen and Action, set explicit redirection
+ * Constructor, set Screen and Action, set explicit redirection.
*
* @param runData A RunData object
* @param screen A Screen Name
@@ -188,7 +187,7 @@
}
/**
- * Constructor with a ServerData object
+ * Constructor with a ServerData object.
*
* @param serverData A ServerData object
*/
@@ -199,7 +198,7 @@
}
/**
- * Constructor, set explicit redirection
+ * Constructor, set explicit redirection.
*
* @param serverData A ServerData object
* @param redirect True if redirection allowed.
@@ -211,7 +210,7 @@
}
/**
- * Constructor, set Screen
+ * Constructor, set Screen.
*
* @param serverData A ServerData object
* @param screen A Screen Name
@@ -223,7 +222,7 @@
}
/**
- * Constructor, set Screen, set explicit redirection
+ * Constructor, set Screen, set explicit redirection.
*
* @param serverData A ServerData object
* @param screen A Screen Name
@@ -236,7 +235,7 @@
}
/**
- * Constructor, set Screen and Action
+ * Constructor, set Screen and Action.
*
* @param serverData A ServerData object
* @param screen A Screen Name
@@ -249,7 +248,7 @@
}
/**
- * Constructor, set Screen and Action, set explicit redirection
+ * Constructor, set Screen and Action, set explicit redirection.
*
* @param serverData A ServerData object
* @param screen A Screen Name
@@ -264,7 +263,7 @@
}
/**
- * Constructor, user Turbine.getDefaultServerData(), set Screen and Action
+ * Constructor, user Turbine.getDefaultServerData(), set Screen and Action.
*
* @param screen A Screen Name
* @param action An Action Name
@@ -287,7 +286,6 @@
/**
* Init the TurbineURI.
- *
*/
private void init()
{
@@ -339,7 +337,6 @@
/**
* Clears the action= value for this URL.
- *
*/
public void clearAction()
{
@@ -369,7 +366,6 @@
/**
* Clears the screen= value for this URL.
- *
*/
public void clearScreen()
{
@@ -529,8 +525,7 @@
}
/**
- * Adds an existing List of URIParam objects to
- * the query data.
+ * Adds an existing List of URIParam objects to the query data.
*
* @param list A list with URIParam objects.
*/
@@ -543,7 +538,6 @@
* Is Path Info data set in this URI?
*
* @return true if Path Info has values
- *
*/
public boolean hasPathInfo()
{
@@ -572,7 +566,6 @@
* Is Query data set in this URI?
*
* @return true if Query data has values
- *
*/
public boolean hasQueryData()
{
@@ -674,8 +667,7 @@
}
/**
- * Add everything needed for a relative link to
- * the passed StringBuffer
+ * Add everything needed for a relative link to the passed StringBuffer.
*
* @param output A Stringbuffer
*/
@@ -751,7 +743,7 @@
}
/**
- * toString() simply calls getAbsoluteLink. You should not use this in your
+ * Simply calls getAbsoluteLink(). You should not use this in your
* code unless you have to. Use getAbsoluteLink.
*
* @return This URI as a String
@@ -772,10 +764,9 @@
*/
/**
- * Returns the Path Info data as a String
+ * Returns the Path Info data as a String.
*
* @param output The StringBuffer that should hold the path info.
- *
*/
private void getPathInfoAsString(StringBuffer output)
{
@@ -783,10 +774,9 @@
}
/**
- * Returns the Query data as a String
+ * Returns the Query data as a String.
*
* @param output The StringBuffer that should hold the query data.
- *
*/
private void getQueryDataAsString(StringBuffer output)
{
@@ -794,13 +784,12 @@
}
/**
- * Does the actual encoding for pathInfoAsString and queryDataAsString
+ * Does the actual encoding for pathInfoAsString and queryDataAsString.
*
* @param output The Stringbuffer that should contain the information.
* @param list A Collection
* @param fieldDelim A char which is used to separate key/value pairs
* @param valueDelim A char which is used to separate key and value
- *
*/
private void doEncode(StringBuffer output, Collection list, char fieldDelim,
char valueDelim)
{
@@ -835,10 +824,10 @@
}
/**
- * <p>If the type is PATH_INFO, then add name/value to the pathInfo
+ * If the type is PATH_INFO, then add name/value to the pathInfo
* hashtable.
- *
- * <p>If the type is QUERY_DATA, then add name/value to the queryData
+ * <p>
+ * If the type is QUERY_DATA, then add name/value to the queryData
* hashtable.
*
* @param type Type (PATH_INFO or QUERY_DATA) of insertion.
@@ -888,7 +877,7 @@
/**
* Method for a quick way to add all the parameters in a
- * List with URIParam objects
+ * List with URIParam objects.
*
* <p>If the type is P (0), then add name/value to the pathInfo
* hashtable.
@@ -899,7 +888,6 @@
* @param type Type of insertion (@see #add(char type, String name, String
value))
* @param list A List of URIParam objects
*/
-
protected void add(int type,
List list)
{
@@ -914,7 +902,7 @@
}
/**
- * <p>If the type is P (0), then remove name/value from the
+ * If the type is P (0), then remove name/value from the
* pathInfo hashtable.
*
* <p>If the type is Q (1), then remove name/value from the
1.5 +2 -3
jakarta-turbine-2/src/java/org/apache/turbine/util/TurbineRuntimeException.java
Index: TurbineRuntimeException.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/TurbineRuntimeException.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TurbineRuntimeException.java 9 Mar 2003 02:54:11 -0000 1.4
+++ TurbineRuntimeException.java 29 Aug 2003 20:33:10 -0000 1.5
@@ -60,9 +60,8 @@
* This is a base class of runtime exeptions thrown by Turbine.
*
* This class represents a non-checked type exception (see
- * [EMAIL PROTECTED] java.lang.RuntimeException}). It has the nested stack trace
- * functionality found in the [EMAIL PROTECTED] TurbineException} class.
- *
+ * [EMAIL PROTECTED] java.lang.RuntimeException}). It has the nested stack trace
+ * functionality found in the [EMAIL PROTECTED] TurbineException} class.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Rafal Krzewski</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Daniel Rall</a>
1.9 +11 -16
jakarta-turbine-2/src/java/org/apache/turbine/util/ServerData.java
Index: ServerData.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/ServerData.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ServerData.java 18 Jul 2003 09:10:23 -0000 1.8
+++ ServerData.java 29 Aug 2003 20:33:10 -0000 1.9
@@ -109,7 +109,6 @@
String scriptName,
String contextPath)
{
-
if (log.isDebugEnabled())
{
StringBuffer sb = new StringBuffer();
@@ -138,7 +137,6 @@
* Copy-Constructor
*
* @param serverData A ServerData Object
- *
*/
public ServerData(ServerData serverData)
{
@@ -170,7 +168,6 @@
* generates a new Object with the same values as this one.
*
* @return A cloned object.
- *
*/
public Object clone()
{
@@ -191,7 +188,7 @@
/**
* Sets the cached serverName.
*
- * @param sn A String.
+ * @param serverName the server name.
*/
public void setServerName(String serverName)
{
@@ -202,7 +199,7 @@
/**
* Get the server port.
*
- * @return An int.
+ * @return the server port.
*/
public int getServerPort()
{
@@ -212,7 +209,7 @@
/**
* Sets the cached serverPort.
*
- * @param port An int.
+ * @param serverPort the server port.
*/
public void setServerPort(int serverPort)
{
@@ -223,7 +220,7 @@
/**
* Get the server scheme.
*
- * @return A String.
+ * @return the server scheme.
*/
public String getServerScheme()
{
@@ -233,7 +230,7 @@
/**
* Sets the cached serverScheme.
*
- * @param ss A String.
+ * @param serverScheme the server scheme.
*/
public void setServerScheme(String serverScheme)
{
@@ -244,7 +241,7 @@
/**
* Get the script name
*
- * @return A String.
+ * @return the script name.
*/
public String getScriptName()
{
@@ -254,7 +251,7 @@
/**
* Set the script name.
*
- * @param sname A String.
+ * @param scriptName the script name.
*/
public void setScriptName(String scriptName)
{
@@ -265,7 +262,7 @@
/**
* Get the context path.
*
- * @return A String.
+ * @return the context path.
*/
public String getContextPath()
{
@@ -283,9 +280,8 @@
this.contextPath = contextPath;
}
-
/**
- * Appends the Host URL to the supplied StringBuffer
+ * Appends the Host URL to the supplied StringBuffer.
*
* @param url A StringBuffer object
*/
@@ -306,9 +302,8 @@
}
}
-
/**
- * Returns this object as an URL
+ * Returns this object as an URL.
*
* @return The contents of this object as a String
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
