dion 02/04/30 08:58:39
Modified: src/java/org/apache/maven/cvslib CvsChangeLogGenerator.java
Log:
Fix missing javadocs
Revision Changes Path
1.2 +19 -4
jakarta-turbine-maven/src/java/org/apache/maven/cvslib/CvsChangeLogGenerator.java
Index: CvsChangeLogGenerator.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/cvslib/CvsChangeLogGenerator.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- CvsChangeLogGenerator.java 30 Apr 2002 15:33:15 -0000 1.1
+++ CvsChangeLogGenerator.java 30 Apr 2002 15:58:39 -0000 1.2
@@ -85,7 +85,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]";>dIon Gillard</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Stefan Bodewig</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Peter Donald</a>
- * @version $Id: CvsChangeLogGenerator.java,v 1.1 2002/04/30 15:33:15 kaz Exp $
+ * @version $Id: CvsChangeLogGenerator.java,v 1.2 2002/04/30 15:58:39 dion Exp $
*/
public class CvsChangeLogGenerator
implements ChangeLogGenerator, ExecuteStreamHandler
@@ -127,7 +127,11 @@
*/
private Collection entries;
- // doc comment inherited from interface
+ /**
+ * Initialize the generator from the changelog controller
+ * @param changeLog the controller
+ * @see ChangeLogGenerator#init(ChangeLog)
+ */
public void init( ChangeLog changeLog )
{
changeLogExecutor = changeLog;
@@ -144,6 +148,7 @@
/**
* Set the dateRange member based on the number of days obtained from the
* ChangeLog.
+ * @param numDaysString the number of days of log output to generate
*/
private void setDateRange( String numDaysString )
{
@@ -161,7 +166,14 @@
}
- // doc comment inherited from ChangeLogGenerator interface
+ /**
+ * Execute CVS, driving the given parser
+ * @param parser a {@link ChangeLogParser parser} to process the CVS output
+ * @return a collection of {@link ChangeLogEntry entries} parsed from
+ * the CVS output
+ * @throws IOException when there are issues executing CVS
+ * @see ChangeLogGenerator#getEntries(ChangeLogParser)
+ */
public Collection getEntries( ChangeLogParser parser ) throws IOException
{
if (parser == null)
@@ -215,7 +227,10 @@
return entries;
}
- // doc comment inherited from interface - nothing to do
+ /**
+ * Clean up any generated resources for this run
+ * @see ChangeLogGenerator#cleanup()
+ */
public void cleanup()
{
}
