User: rinkrank
Date: 02/04/03 16:27:47
Modified: core/src/xdoclet/doc/tags DocumentationTagsHandler.java
Log:
Re-enabled the beautifier (which I turned off during xjavadoc refactoring)
Revision Changes Path
1.3 +102 -60 xdoclet/core/src/xdoclet/doc/tags/DocumentationTagsHandler.java
Index: DocumentationTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/doc/tags/DocumentationTagsHandler.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -w -r1.2 -r1.3
--- DocumentationTagsHandler.java 24 Mar 2002 17:44:18 -0000 1.2
+++ DocumentationTagsHandler.java 4 Apr 2002 00:27:47 -0000 1.3
@@ -1,3 +1,38 @@
+/*
+ * Copyright (c) 2001, Aslak Helles�y, BEKK Consulting
+ * 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.tags;
import xdoclet.XDocletTagSupport;
@@ -18,12 +53,15 @@
/**
* @author Ara Abrahamian ([EMAIL PROTECTED])
* @created Nov 30, 2001
- * @version $Revision: 1.2 $
+ * @version $Revision: 1.3 $
+ */
+public class DocumentationTagsHandler extends XDocletTagSupport {
+ /**
+ * @todo-javadoc Describe the field
*/
-public class DocumentationTagsHandler extends XDocletTagSupport
-{
private DocumentTagsSubTask.Namespace currentNamespace;
+
/**
* Iterates over all template namespaces registered in /tagmappings.properties
* file and evaluates the body of the tag for each namespace.
@@ -32,10 +70,8 @@
* @exception XDocletException Description of Exception
* @doc:tag type="block"
*/
- public void forAllNamespaces( String template ) throws XDocletException
- {
- for( Iterator iterator =
getActiveDocumentTagsSubTask().getNamespaces().iterator(); iterator.hasNext(); )
- {
+ public void forAllNamespaces(String template) throws XDocletException {
+ for (Iterator iterator =
getActiveDocumentTagsSubTask().getNamespaces().iterator(); iterator.hasNext(); ) {
currentNamespace = ( DocumentTagsSubTask.Namespace )
iterator.next();
setCurrentClass( XJavaDoc.getInstance().getXClass(
currentNamespace.getTagsHandlerClassName() ) );
@@ -43,6 +79,7 @@
}
}
+
/**
* Returns current namespace name. Use inside forAllNamespaces only.
*
@@ -50,11 +87,11 @@
* @exception XDocletException Description of Exception
* @doc:tag type="content"
*/
- public String namespace() throws XDocletException
- {
+ public String namespace() throws XDocletException {
return currentNamespace.getName();
}
+
/**
* Returns current namespace tags handler class name. Use inside
* forAllNamespaces only.
@@ -63,11 +100,11 @@
* @exception XDocletException Description of Exception
* @doc:tag type="content"
*/
- public String namespaceTagsHandlerClassName() throws XDocletException
- {
+ public String namespaceTagsHandlerClassName() throws XDocletException {
return currentNamespace.getTagsHandlerClassName();
}
+
/**
* Returns current namespace name from current class name.
*
@@ -75,19 +112,19 @@
* @exception XDocletException Description of Exception
* @doc:tag type="content"
*/
- public String namespaceFromClassName() throws XDocletException
- {
- for( Iterator iterator =
getActiveDocumentTagsSubTask().getNamespaces().iterator(); iterator.hasNext(); )
- {
+ public String namespaceFromClassName() throws XDocletException {
+ for (Iterator iterator =
getActiveDocumentTagsSubTask().getNamespaces().iterator(); iterator.hasNext(); ) {
DocumentTagsSubTask.Namespace temp_namespace = (
DocumentTagsSubTask.Namespace ) iterator.next();
- if( temp_namespace.getTagsHandlerClassName().equals(
getCurrentClass().qualifiedName() ) )
+ if
(temp_namespace.getTagsHandlerClassName().equals(getCurrentClass().qualifiedName())) {
return temp_namespace.getName();
}
+ }
return null;
}
+
/**
* Returns current namespace. Used for tags_toc.j.
*
@@ -95,11 +132,11 @@
* @exception XDocletException Description of Exception
* @doc:tag type="content"
*/
- public String currentNamespace() throws XDocletException
- {
+ public String currentNamespace() throws XDocletException {
return getActiveDocumentTagsSubTask().getCurrentNamespace().getName();
}
+
/**
* Returns current namespace tags handler class name. Used for <namespace>.html
* files.
@@ -107,30 +144,35 @@
* @return Current namespace name
* @exception XDocletException Description of Exception
* @doc:tag type="content"
- * @doc:param name="namespace" optional="false"
- * description="The namesapce name we lookup the handler."
+ * @doc:param name="namespace" optional="false" description="The namesapce name
+ * we lookup the handler."
*/
- public String currentNamespaceTagsHandlerClassName() throws XDocletException
- {
+ public String currentNamespaceTagsHandlerClassName() throws XDocletException {
return
getActiveDocumentTagsSubTask().getCurrentNamespace().getTagsHandlerClassName();
}
+
/**
* Returns current namespace name. Use inside forAllNamespaces only.
*
* @return Current namespace name
* @exception XDocletException Description of Exception
* @doc:tag type="content"
- * @doc:param name="namespace" optional="false"
- * description="The namesapce name we lookup the handler."
+ * @doc:param name="namespace" optional="false" description="The namesapce name
+ * we lookup the handler."
*/
- public String currentNamespaceTagsHandlerClassNameAsDirStructure() throws
XDocletException
- {
+ public String currentNamespaceTagsHandlerClassNameAsDirStructure() throws
XDocletException {
return currentNamespaceTagsHandlerClassName().replace( '.', '/' );
}
- private DocumentTagsSubTask getActiveDocumentTagsSubTask()
- {
+
+ /**
+ * Gets the ActiveDocumentTagsSubTask attribute of the DocumentationTagsHandler
+ * object
+ *
+ * @return The ActiveDocumentTagsSubTask value
+ */
+ private DocumentTagsSubTask getActiveDocumentTagsSubTask() {
return ( DocumentTagsSubTask ) getDocletContext().getActiveSubTask();
}
}
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
