[Nice-commit] Nice/src/nice/tools/doc comment.nice,1.1,1.2

[Francis B. <fb...@us...>]

Update of /cvsroot/nice/Nice/src/nice/tools/doc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24355/Nice/src/nice/tools/doc

Modified Files:
	comment.nice 
Log Message:
Added nicedoc comments.


Index: comment.nice
===================================================================
RCS file: /cvsroot/nice/Nice/src/nice/tools/doc/comment.nice,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** comment.nice	25 Apr 2004 16:25:28 -0000	1.1
--- comment.nice	27 Apr 2004 12:56:52 -0000	1.2
***************
*** 13,16 ****
--- 13,23 ----
  package nice.tools.doc;
  
+ /**
+  * The comment class is an abstraction of a comment block.  It contains an
+  * instance variable <i>tags</i> contains an ArrayList of tuples that map tag
+  * strings to values.  The value <b>null</b> maps to the general comment.
+  * The constructor of this class should be used put a comment block in 
+  * <i>commentStr</i> (the default value is the empty string.
+  */
  class Comment {
      //a list of tuples that maps tags, such as @param, to values
***************
*** 25,28 ****
--- 32,42 ----
  }
  
+ /**
+  * Parses a comment block and returns an ArrayList containing tuples that map
+  * tag string (such as @param) to values.  The value <b>null</b> is used as the
+  * parameter for the general comment heading the block.
+  * @param a comment block beginning with &#47;&#42;&#42; and ending with &#42;&#47;
+  * @return a list of tuples mapping tags to values.
+  */
  ArrayList<(?String,String)> parse(String comments) {
      //an initial capacity of 8 is used becuase I don't expect many values