Update of /cvsroot/xdoclet/xjavadoc/src/xjavadoc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv521
Modified Files:
XDoc.java
Log Message:
Docs.
Index: XDoc.java
===================================================================
RCS file: /cvsroot/xdoclet/xjavadoc/src/xjavadoc/XDoc.java,v
retrieving revision 1.59
retrieving revision 1.60
diff -C2 -r1.59 -r1.60
*** XDoc.java 10 Jun 2003 13:25:54 -0000 1.59
--- XDoc.java 5 Sep 2004 23:50:53 -0000 1.60
***************
*** 49,53 ****
/**
! * Contains all the tags in the doc, in order of occurrance
*/
private List _tags;
--- 49,53 ----
/**
! * Contains all the tags in the doc, in order of occurrence.
*/
private List _tags;
***************
*** 72,75 ****
--- 72,76 ----
* @param javadocToken Describe what the parameter does
* @param owner Describe what the parameter does
+ * @param tagFactory Describe what the parameter does
*/
public XDoc( Token javadocToken, XProgramElement owner, XTagFactory tagFactory
)
***************
*** 93,96 ****
--- 94,103 ----
}
+ /**
+ * Convert a tag name from the old colon-separated form to the new preferred
dot-separated form.
+ *
+ * @param tagName The name of the tag
+ * @return Preferred form of the tag
+ */
public static String dotted( final String tagName )
{
***************
*** 208,216 ****
/**
! * Returns all the tags with the specified tagName. If No tags are found, an
! * empty Collection is returned.
*
* @param superclasses if this is true, return tags from superclasses too.
! * @return A Collection of XTag
*/
public List getTags( boolean superclasses )
--- 215,223 ----
/**
! * Returns all the tags. If no tags are found, an
! * empty List is returned.
*
* @param superclasses if this is true, return tags from superclasses too.
! * @return A List of XTag
*/
public List getTags( boolean superclasses )
***************
*** 268,275 ****
/**
! * Describe what the method does
*
! * @param tagName Describe what the parameter does
! * @return Describe the return value
*/
public XTag getTag( String tagName )
--- 275,282 ----
/**
! * Get the first tag of name tagName from this doc. Superclasses are not
searched.
*
! * @param tagName the name of the tag
! * @return the tag
*/
public XTag getTag( String tagName )
***************
*** 279,286 ****
/**
! * Get the first tag of name tagName
*
! * @param tagName the name of the tag to get.
! * @param superclasses Describe what the parameter does
* @return the first XTag with name equal to tagName
*/
--- 286,293 ----
/**
! * Get the first tag of name tagName.
*
! * @param tagName the name of the tag to get (without the 'at')
! * @param superclasses if this is true, return tags from superclasses too.
* @return the first XTag with name equal to tagName
*/
***************
*** 316,320 ****
/**
* Returns the tag attribute value. If superclasses is true, the first
! * occurrance is returned when walking up the class hierarchy. If nothing is
* found, null is returned.
*
--- 323,327 ----
/**
* Returns the tag attribute value. If superclasses is true, the first
! * occurrence is returned when walking up the class hierarchy. If nothing is
* found, null is returned.
*
***************
*** 328,332 ****
tagName = dotted( tagName );
! // Get all the tags, loop over them and return the first occurrance of
the attribute.
for( Iterator tags = getTags( tagName ).iterator(); tags.hasNext(); )
{
--- 335,339 ----
tagName = dotted( tagName );
! // Get all the tags, loop over them and return the first occurrence of
the attribute.
for( Iterator tags = getTags( tagName ).iterator(); tags.hasNext(); )
{
***************
*** 392,398 ****
/**
! * Describe what the method does
*
! * @return Describe the return value
*/
public String getFirstSentence()
--- 399,405 ----
/**
! * Return the first sentence of the text of the comment for this doc item.
*
! * @return First sentence
*/
public String getFirstSentence()
***************
*** 431,435 ****
}
! // We did'n found a proper first sentence separator. So we
only have
// one sentence.
if( _firstSentence == null )
--- 438,442 ----
}
! // We didn't find a proper first sentence separator. So we
only have
// one sentence.
if( _firstSentence == null )
***************
*** 443,449 ****
/**
! * set comment text
*
! * @param commentText The new CommentText value
*/
public void setCommentText( String commentText )
--- 450,456 ----
/**
! * Set the text of the comment for this doc item.
*
! * @param commentText The new comment text
*/
public void setCommentText( String commentText )
***************
*** 462,466 ****
*
* @param tagName The name of the tag to look for (without the 'at')
! * @return true is the tag exists
*/
public boolean hasTag( String tagName )
--- 469,473 ----
*
* @param tagName The name of the tag to look for (without the 'at')
! * @return true if the tag exists
*/
public boolean hasTag( String tagName )
***************
*** 474,478 ****
* @param tagName The name of the tag to look for (without the 'at')
* @param superclasses If true, look in superclasses too.
! * @return true is the tag exists
*/
public boolean hasTag( String tagName, boolean superclasses )
--- 481,485 ----
* @param tagName The name of the tag to look for (without the 'at')
* @param superclasses If true, look in superclasses too.
! * @return true if the tag exists
*/
public boolean hasTag( String tagName, boolean superclasses )
***************
*** 525,529 ****
/**
! * add doc listener interested in chages
*
* @param docListener doc listener to register
--- 532,536 ----
/**
! * Add doc listener interested in changes.
*
* @param docListener doc listener to register
***************
*** 628,632 ****
/**
! * Describe the method
*
* @param tagName The name of the tag to add
--- 635,639 ----
/**
! * Add a tag to the doc item.
*
* @param tagName The name of the tag to add
***************
*** 677,681 ****
* source, null is returned.
*
! * @return Describe the return value
*/
private XDoc getSuperDoc()
--- 684,688 ----
* source, null is returned.
*
! * @return the superclass' doc
*/
private XDoc getSuperDoc()
***************
*** 693,696 ****
--- 700,709 ----
}
+ /**
+ * Returns the doc in all the superclasses. If the super element is null, or
not from
+ * source, an empty list is returned.
+ *
+ * @return A List of XDoc
+ */
private List getAllSuperDocs()
{
***************
*** 778,782 ****
}
! // also set containing class tro dirty
if( _owner != null )
{
--- 791,795 ----
}
! // also set containing class to dirty
if( _owner != null )
{
***************
*** 788,795 ****
/**
! * Describe the method
*
! * @param sb Describe the method parameter
! * @return Describe the return value
*/
private StringBuffer appendWhiteSpaces( StringBuffer sb )
--- 801,808 ----
/**
! * Add some white space to the string being built up in toString().
*
! * @param sb StringBuffer that the text is being built in
! * @return the StringBuffer
*/
private StringBuffer appendWhiteSpaces( StringBuffer sb )
-------------------------------------------------------
This SF.Net email is sponsored by BEA Weblogic Workshop
FREE Java Enterprise J2EE developer tools!
Get your free copy of BEA WebLogic Workshop 8.1 today.
http://ads.osdn.com/?ad_id=5047&alloc_id=10808&op=click
_______________________________________________
xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
