User: rinkrank
Date: 02/04/03 17:03:09
Modified: core/src/xdoclet/doc DocumentDocletTask.java
DocumentTagsSubTask.java
Log:
The pretty settings from xjavadoc were (are still) applied to xdoclet sources.
It seems JRefactory only loads it once. Since the xdoclet build now invokes xjavadoc
build first, xjavadoc settings are used. I'm sorry if I have messed up the
formatting.
This commit has modified the header (so that BEKK is not included).
Revision Changes Path
1.13 +12 -39 xdoclet/core/src/xdoclet/doc/DocumentDocletTask.java
Index: DocumentDocletTask.java
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/src/xdoclet/doc/DocumentDocletTask.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -w -r1.12 -r1.13
--- DocumentDocletTask.java 4 Apr 2002 00:27:47 -0000 1.12
+++ DocumentDocletTask.java 4 Apr 2002 01:03:08 -0000 1.13
@@ -1,37 +1,6 @@
/*
- * Copyright (c) 2001, Aslak Helles�y, BEKK Consulting
+ * Copyright (c) 2001,2002 The XDoclet team
* All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *
- * - Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- *
- * - Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- *
- * - Neither the name of BEKK Consulting nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
- * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
- * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
- * DAMAGE.
- */
-
-/*
- * Change log
- *
*/
package xdoclet.doc;
@@ -44,7 +13,7 @@
/**
* @author Ara Abrahamian ([EMAIL PROTECTED])
* @created June 19, 2001
- * @version $Revision: 1.12 $
+ * @version $Revision: 1.13 $
*/
public class DocumentDocletTask extends DocletTask {
/**
@@ -58,10 +27,11 @@
/**
- * Describe what the method does @todo-javadoc Write javadocs for method
+ * Describe what the method does
*
- * @return Describe the return value @todo-javadoc Write javadocs for return
- * value
+ * @return Describe the return value
+ * @todo-javadoc Write javadocs for method
+ * @todo-javadoc Write javadocs for return value
*/
public DocumentTagsSubTask createDocumenttags() {
documentTagsSubTask = new DocumentTagsSubTask();
@@ -70,13 +40,15 @@
/**
- * Describe what the method does @todo-javadoc Write javadocs for method
+ * Describe what the method does
*
- * @return Describe the return value @todo-javadoc Write javadocs for return
- * value
+ * @return Describe the return value
+ * @todo-javadoc Write javadocs for method
+ * @todo-javadoc Write javadocs for return value
*/
public InfoSubTask createInfo() {
InfoSubTask infoSubTask = new InfoSubTask(this);
+
infoSubTasks.add(infoSubTask);
return infoSubTask;
}
@@ -89,6 +61,7 @@
*/
protected List getSubTasks() {
List subtasks = super.getSubTasks();
+
if (documentTagsSubTask != null) {
subtasks.add(documentTagsSubTask);
}
1.16 +34 -61 xdoclet/core/src/xdoclet/doc/DocumentTagsSubTask.java
Index: DocumentTagsSubTask.java
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/src/xdoclet/doc/DocumentTagsSubTask.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -w -r1.15 -r1.16
--- DocumentTagsSubTask.java 4 Apr 2002 00:27:47 -0000 1.15
+++ DocumentTagsSubTask.java 4 Apr 2002 01:03:08 -0000 1.16
@@ -1,37 +1,6 @@
/*
- * Copyright (c) 2001, Aslak Helles�y, BEKK Consulting
+ * Copyright (c) 2001,2002 The XDoclet team
* All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *
- * - Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- *
- * - Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- *
- * - Neither the name of BEKK Consulting nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
- * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
- * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
- * DAMAGE.
- */
-
-/*
- * Change log
- *
*/
package xdoclet.doc;
@@ -57,7 +26,7 @@
*
* @author Ara Abrahamian ([EMAIL PROTECTED])
* @created June 19, 2001
- * @version $Revision: 1.15 $
+ * @version $Revision: 1.16 $
*/
public class DocumentTagsSubTask extends TemplateSubTask {
@@ -165,10 +134,11 @@
/**
- * Describe what the method does @todo-javadoc Write javadocs for method
+ * Describe what the method does
*
- * @exception XDocletException Describe the exception @todo-javadoc Write
- * javadocs for exception
+ * @exception XDocletException Describe the exception
+ * @todo-javadoc Write javadocs for method
+ * @todo-javadoc Write javadocs for exception
*/
public void execute() throws XDocletException {
Properties tag_handler_mappings = loadTagMappings();
@@ -217,11 +187,11 @@
/**
* Gets the GeneratedFileName attribute of the DocumentTagsSubTask object
*
- * @param clazz Describe what the parameter does @todo-javadoc Write javadocs
- * for method parameter
+ * @param clazz Describe what the parameter does
* @return The GeneratedFileName value
- * @exception XDocletException Describe the exception @todo-javadoc Write
- * javadocs for exception
+ * @exception XDocletException Describe the exception
+ * @todo-javadoc Write javadocs for method parameter
+ * @todo-javadoc Write javadocs for exception
*/
protected String getGeneratedFileName(XClass clazz) throws XDocletException {
String dest_file = MessageFormat.format(getDestinationFile(), new
Object[]{currentNamespace.getName()});
@@ -244,10 +214,11 @@
/**
- * Describe what the method does @todo-javadoc Write javadocs for method
+ * Describe what the method does
*
- * @exception XDocletException Describe the exception @todo-javadoc Write
- * javadocs for exception
+ * @exception XDocletException Describe the exception
+ * @todo-javadoc Write javadocs for method
+ * @todo-javadoc Write javadocs for exception
*/
protected void engineStarted() throws XDocletException {
}
@@ -257,8 +228,8 @@
* Sets the CurrentNamespace attribute of the DocumentTagsSubTask object
*
* @param clazz The new CurrentNamespace value
- * @exception XDocletException Describe the exception @todo-javadoc Write
- * javadocs for exception
+ * @exception XDocletException Describe the exception
+ * @todo-javadoc Write javadocs for exception
*/
private void setCurrentNamespace(XClass clazz) throws XDocletException {
for (int i = 0; i < namespaces.size(); i++) {
@@ -273,12 +244,13 @@
/**
- * Describe what the method does @todo-javadoc Write javadocs for method
+ * Describe what the method does
*
- * @return Describe the return value @todo-javadoc Write javadocs for return
- * value
- * @exception XDocletException Describe the exception @todo-javadoc Write
- * javadocs for exception
+ * @return Describe the return value
+ * @exception XDocletException Describe the exception
+ * @todo-javadoc Write javadocs for method
+ * @todo-javadoc Write javadocs for return value
+ * @todo-javadoc Write javadocs for exception
*/
private Properties loadTagMappings() throws XDocletException {
//we should reload it here directly, because TemplateEngine may also
have
@@ -309,13 +281,13 @@
/**
- * Describe what the Namespace constructor does @todo-javadoc Write
javadocs
- * for constructor
+ * Describe what the Namespace constructor does
*
- * @param name Describe what the parameter does @todo-javadoc Write
javadocs
- * for method parameter
- * @param tagsHandlerClassName Describe what the parameter does
@todo-javadoc
- * Write javadocs for method parameter
+ * @param name Describe what the parameter does
+ * @param tagsHandlerClassName Describe what the parameter does
+ * @todo-javadoc Write javadocs for constructor
+ * @todo-javadoc Write javadocs for method parameter
+ * @todo-javadoc Write javadocs for method parameter
*/
public Namespace(String name, String tagsHandlerClassName) {
this.name = name;
@@ -364,12 +336,13 @@
/**
- * Describe what the method does @todo-javadoc Write javadocs for
method
+ * Describe what the method does
*
- * @param o Describe what the parameter does @todo-javadoc Write
javadocs for
- * method parameter
- * @return Describe the return value @todo-javadoc Write javadocs for
return
- * value
+ * @param o Describe what the parameter does
+ * @return Describe the return value
+ * @todo-javadoc Write javadocs for method
+ * @todo-javadoc Write javadocs for method parameter
+ * @todo-javadoc Write javadocs for return value
*/
public int compareTo(Object o) {
return this.getName().compareTo(((Namespace)o).getName());
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
