You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by di...@apache.org on 2001/01/12 16:31:35 UTC
cvs commit: xml-cocoon/src/org/apache/cocoon/util ClassUtils.java
dims 01/01/12 07:31:35
Modified: src/org/apache/cocoon/components/language/markup Tag:
xml-cocoon2 AbstractMarkupLanguage.java
src/org/apache/cocoon/components/language/markup/sitemap
Tag: xml-cocoon2 SitemapMarkupLanguage.java
src/org/apache/cocoon/components/language/markup/xsp Tag:
xml-cocoon2 XSPMarkupLanguage.java
src/org/apache/cocoon/environment/http Tag: xml-cocoon2
HttpRequest22.java
src/org/apache/cocoon/transformation Tag: xml-cocoon2
AbstractDOMTransformer.java
src/org/apache/cocoon/util Tag: xml-cocoon2 ClassUtils.java
Log:
Cleaning up comments for JavaDoc Generation.
Revision Changes Path
No revision
No revision
1.1.2.16 +11 -15 xml-cocoon/src/org/apache/cocoon/components/language/markup/Attic/AbstractMarkupLanguage.java
Index: AbstractMarkupLanguage.java
===================================================================
RCS file: /home/cvs/xml-cocoon/src/org/apache/cocoon/components/language/markup/Attic/AbstractMarkupLanguage.java,v
retrieving revision 1.1.2.15
retrieving revision 1.1.2.16
diff -u -r1.1.2.15 -r1.1.2.16
--- AbstractMarkupLanguage.java 2000/12/11 17:09:43 1.1.2.15
+++ AbstractMarkupLanguage.java 2001/01/12 15:31:17 1.1.2.16
@@ -50,7 +50,7 @@
* be decoupled from this context!!!
*
* @author <a href="mailto:ricardo@apache.org">Ricardo Rocha</a>
- * @version CVS $Revision: 1.1.2.15 $ $Date: 2000/12/11 17:09:43 $
+ * @version CVS $Revision: 1.1.2.16 $ $Date: 2001/01/12 15:31:17 $
*/
public abstract class AbstractMarkupLanguage
implements MarkupLanguage, Composer, Configurable
@@ -235,17 +235,13 @@
/**
* Add a dependency on an external file to the document for inclusion in
- * generated code. This is used by <code>AbstractServerPagesGenerator</code>
- * to populate a list of <code>File</code>'s tested for change on each
- * invocation; this information, in turn, is used by
- * <code>ServerPagesLoaderImpl</code> to assert whether regeneration is
- * necessary.
- *
- * @param PARAM_NAME Param description
- * @return the value
- * @exception EXCEPTION_NAME If an error occurs
- * @see ServerPages <code>AbstractServerPagesGenerator</code>
- * and <code>ServerPagesLoaderImpl</code>
+ * generated code. This is used to populate a list of <code>File</code>'s
+ * tested for change on each invocation; this information is used to assert
+ * whether regeneration is necessary.
+ *
+ * @param location The file path of the dependent file
+ * @see <code>AbstractMarkupLanguage</code>, <code>ServerPagesGenerator</code>
+ * and <code>AbstractServerPage</code>
*/
protected abstract void addDependency(String location);
@@ -593,7 +589,7 @@
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void startDocument () throws SAXException {
isRootElem=true;
@@ -601,7 +597,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void startPrefixMapping(String prefix, String uri) throws SAXException {
if(!isRootElem) {
@@ -616,7 +612,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void startElement (
String namespaceURI, String localName,
No revision
No revision
1.1.2.9 +12 -14 xml-cocoon/src/org/apache/cocoon/components/language/markup/sitemap/Attic/SitemapMarkupLanguage.java
Index: SitemapMarkupLanguage.java
===================================================================
RCS file: /home/cvs/xml-cocoon/src/org/apache/cocoon/components/language/markup/sitemap/Attic/SitemapMarkupLanguage.java,v
retrieving revision 1.1.2.8
retrieving revision 1.1.2.9
diff -u -r1.1.2.8 -r1.1.2.9
--- SitemapMarkupLanguage.java 2000/12/08 20:38:54 1.1.2.8
+++ SitemapMarkupLanguage.java 2001/01/12 15:31:23 1.1.2.9
@@ -39,7 +39,7 @@
* <a href="http://xml.apache.org/cocoon/sitemap.html">Sitemap</a>.
*
* @author <a href="mailto:Giacomo.Pati@pwr.ch">Giacomo Pati</a>
- * @version CVS $Revision: 1.1.2.8 $ $Date: 2000/12/08 20:38:54 $
+ * @version CVS $Revision: 1.1.2.9 $ $Date: 2001/01/12 15:31:23 $
*/
public class SitemapMarkupLanguage extends AbstractMarkupLanguage {
@@ -101,15 +101,13 @@
/**
* Add a dependency on an external file to the document for inclusion in
- * generated code. This is used by <code>AbstractServerPagesGenerator</code>
- * to populate a list of <code>File</code>'s tested for change on each
- * invocation; this information, in turn, is used by
- * <code>ServerPagesLoaderImpl</code> to assert whether regeneration is
- * necessary.
+ * generated code. This is used to populate a list of <code>File</code>'s
+ * tested for change on each invocation; this information is used to assert
+ * whether regeneration is necessary.
*
* @param location The file path of the dependent file
- * @see ServerPages <code>AbstractServerPagesGenerator</code>
- * and <code>ServerPagesLoaderImpl</code>
+ * @see <code>AbstractMarkupLanguage</code>, <code>ServerPagesGenerator</code>
+ * and <code>AbstractServerPage</code>
*/
protected void addDependency(String location) {
dependencies.add(location);
@@ -256,7 +254,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void startDocument () throws SAXException {
isRootElem=true;
@@ -267,7 +265,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void processingInstruction(String target, String data) throws SAXException {
// Retrieve logicsheets declared by processing-instruction
@@ -298,7 +296,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void startElement (String namespaceURI, String localName,
String qName, Attributes atts) throws SAXException {
@@ -392,7 +390,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void endElement (String namespaceURI, String localName,
String qName) throws SAXException {
@@ -404,7 +402,7 @@
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void characters(char[] ch, int start, int length) throws SAXException {
if (finished) {
@@ -418,7 +416,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void startPrefixMapping(String prefix, String uri) throws SAXException {
if(finished) {
No revision
No revision
1.1.2.8 +18 -19 xml-cocoon/src/org/apache/cocoon/components/language/markup/xsp/Attic/XSPMarkupLanguage.java
Index: XSPMarkupLanguage.java
===================================================================
RCS file: /home/cvs/xml-cocoon/src/org/apache/cocoon/components/language/markup/xsp/Attic/XSPMarkupLanguage.java,v
retrieving revision 1.1.2.7
retrieving revision 1.1.2.8
diff -u -r1.1.2.7 -r1.1.2.8
--- XSPMarkupLanguage.java 2000/12/08 20:39:02 1.1.2.7
+++ XSPMarkupLanguage.java 2001/01/12 15:31:26 1.1.2.8
@@ -41,7 +41,7 @@
*
* @author <a href="mailto:ricardo@apache.org">Ricardo Rocha</a>
* @author <a href="mailto:ssahuc@apache.org">Sebastien Sahuc</a>
- * @version CVS $Revision: 1.1.2.7 $ $Date: 2000/12/08 20:39:02 $
+ * @version CVS $Revision: 1.1.2.8 $ $Date: 2001/01/12 15:31:26 $
*/
public class XSPMarkupLanguage extends AbstractMarkupLanguage {
@@ -105,15 +105,14 @@
/**
* Add a dependency on an external file to the document for inclusion in
- * generated code. This is used by <code>AbstractServerPagesGenerator</code>
- * to populate a list of <code>File</code>'s tested for change on each
- * invocation; this information, in turn, is used by
- * <code>ServerPagesLoaderImpl</code> to assert whether regeneration is
- * necessary. XSP uses <xsp:dependency> elements for this purpose
+ * generated code. This is used to populate a list of <code>File</code>'s
+ * tested for change on each invocation; this information is used to assert
+ * whether regeneration is necessary. XSP uses <xsp:dependency>
+ * elements for this purpose.
*
* @param location The file path of the dependent file
- * @see ServerPages <code>AbstractServerPagesGenerator</code>
- * and <code>ServerPagesLoaderImpl</code>
+ * @see <code>AbstractMarkupLanguage</code>, <code>ServerPagesGenerator</code>
+ * and <code>AbstractServerPage</code>
*/
protected void addDependency(String location) {
dependencies.add(location);
@@ -209,7 +208,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void startDocument() throws SAXException {
super.startDocument();
@@ -218,7 +217,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void processingInstruction(String target, String data) throws SAXException {
if (!"xml-logicsheet".equals(target)) {
@@ -228,7 +227,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void startElement (String namespaceURI, String localName,
String qName, Attributes atts) throws SAXException {
@@ -255,7 +254,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void endElement (String namespaceURI, String localName,
String qName) throws SAXException {
@@ -264,7 +263,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void characters(char[] ch, int start, int length) throws SAXException {
String[] tag = (String[]) stack.peek();
@@ -333,7 +332,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void processingInstruction(String target, String data) throws SAXException {
// Retrieve logicsheets declared by processing-instruction
@@ -365,7 +364,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void startDocument () throws SAXException {
isRootElem=true;
@@ -376,7 +375,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void startElement (String namespaceURI, String localName,
String qName, Attributes atts ) throws SAXException {
@@ -462,7 +461,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void endElement (String namespaceURI, String localName,
String qName) throws SAXException {
@@ -473,7 +472,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void characters(char[] ch, int start, int length) throws SAXException {
if (finished) {
@@ -487,7 +486,7 @@
}
/**
- * @see ContentHandler
+ * @see org.xml.sax.ContentHandler
*/
public void startPrefixMapping(String prefix, String uri) throws SAXException {
if(finished) {
No revision
No revision
1.1.2.3 +1 -1 xml-cocoon/src/org/apache/cocoon/environment/http/Attic/HttpRequest22.java
Index: HttpRequest22.java
===================================================================
RCS file: /home/cvs/xml-cocoon/src/org/apache/cocoon/environment/http/Attic/HttpRequest22.java,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- HttpRequest22.java 2000/12/30 21:38:33 1.1.2.2
+++ HttpRequest22.java 2001/01/12 15:31:29 1.1.2.3
@@ -238,7 +238,7 @@
/**
* @deprecated As of Version 2.1 of the Java Servlet API,
- * use {@link ServletContext#getRealPath} instead.
+ * use {@link javax.servlet.ServletContext#getRealPath} instead.
*/
public String getRealPath(String path) {
return this.req.getRealPath(path);
No revision
No revision
1.1.2.5 +1 -1 xml-cocoon/src/org/apache/cocoon/transformation/Attic/AbstractDOMTransformer.java
Index: AbstractDOMTransformer.java
===================================================================
RCS file: /home/cvs/xml-cocoon/src/org/apache/cocoon/transformation/Attic/AbstractDOMTransformer.java,v
retrieving revision 1.1.2.4
retrieving revision 1.1.2.5
diff -u -r1.1.2.4 -r1.1.2.5
--- AbstractDOMTransformer.java 2000/11/10 22:38:55 1.1.2.4
+++ AbstractDOMTransformer.java 2001/01/12 15:31:31 1.1.2.5
@@ -87,7 +87,7 @@
/**
* This method is called when the Document is finished.
* @param doc The DOM Document object representing this SAX stream
- * @see DOMBuilder.Listener
+ * @see org.apache.cocoon.xml.dom.DOMBuilder.Listener
*/
public void notify(Document doc) throws SAXException {
// Call the user's transform method
No revision
No revision
1.1.2.8 +2 -3 xml-cocoon/src/org/apache/cocoon/util/Attic/ClassUtils.java
Index: ClassUtils.java
===================================================================
RCS file: /home/cvs/xml-cocoon/src/org/apache/cocoon/util/Attic/ClassUtils.java,v
retrieving revision 1.1.2.7
retrieving revision 1.1.2.8
diff -u -r1.1.2.7 -r1.1.2.8
--- ClassUtils.java 2000/12/18 21:17:28 1.1.2.7
+++ ClassUtils.java 2001/01/12 15:31:34 1.1.2.8
@@ -21,7 +21,7 @@
*
* @author <a href="mailto:ricardo@apache.org">Ricardo Rocha</a>
* @author <a href="mailto:stefano@apache.org">Stefano Mazzocchi</a>
- * @version CVS $Revision: 1.1.2.7 $ $Date: 2000/12/18 21:17:28 $
+ * @version CVS $Revision: 1.1.2.8 $ $Date: 2001/01/12 15:31:34 $
*/
public class ClassUtils {
@@ -61,7 +61,7 @@
* the ClassLoader.
*
* @return The context classloader.
- * @exception Exception If a loading error occurs
+ * @exception MalformedURLException If a loading error occurs
*/
public static URL getResource(String resource) throws MalformedURLException {
return ClassUtils.getClassLoader().getResource(resource);
@@ -74,7 +74,6 @@
* the ClassLoader.
*
* @return The context classloader.
- * @exception Exception If a loading error occurs
*/
public static ClassLoader getClassLoader() {
if (ClassUtils.loader == null) {