juanco 02/03/03 10:38:41
Modified: src/java/org/apache/maven/jrcs/diff Diff.java
src/java/org/apache/maven/jrcs/rcs Archive.java
BranchNode.java Line.java Node.java Path.java
TrunkNode.java Version.java
Added: src/java/org/apache/maven/jrcs overview.html
src/java/org/apache/maven/jrcs/diff package.html
src/java/org/apache/maven/jrcs/rcs package.html
src/java/org/apache/maven/jrcs/tools package.html
Log:
added more of the missing javadoc documentation
Revision Changes Path
1.1
jakarta-turbine-maven/src/java/org/apache/maven/jrcs/overview.html
Index: overview.html
===================================================================
<!DOCTYPE html PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. 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.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Maven" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Maven", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
* ITS 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
-->
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<title>
</title>
</head>
<body>
<p>
JRCS is a library that knows how to manipulate the archive files
produced by the RCS and CVS version control systems. JRCS is not
intended to replace neither tool. JRCS was written to be able
create archive analysis tools that can do things like identify
hot spots in the source code, measure the contributions by each
developer, o assess how bugs make it in.
</p>
<p>
The reasons why JRCS has the ability do do check-ins and save
archives is API symmetry, and to simplify the writing of unit
tests.
</p>
<p>
The {@link org.apache.maven.jrcs.diff diff} package implements
the differencing engine that JRCS uses. The engine has the power
of Unix diff, is simple to understand, and can be used
independently of the archive handling functionality. The entry
point to the differencing engine is class {@link
org.apache.maven.jrcs.diff.Diff Diff}.
</p>
<p>
The {@link org.apache.maven.jrcs.rcs rcs} package implements th8e
archive handling functionality. The entry point to the library is
class {@link org.apache.maven.jrcs.rcs.Archive Archive}.
</p>
<p>
<b>CAVEAT UTILITOR:</b> Do not make modifications to your
archives with JRCS. There needs to be an important amount of
additional testing before it's safe to do that.
</p>
<p>
@author <a href="mailto:[EMAIL PROTECTED]";>Juanco Anez</a>
@version $Id: Archive.java,v 1.16 2002/02/27 20:58:58 sbailliez
Exp $
</p>
</body>
</html>
1.7 +13 -2
jakarta-turbine-maven/src/java/org/apache/maven/jrcs/diff/Diff.java
Index: Diff.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/diff/Diff.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- Diff.java 27 Feb 2002 04:17:57 -0000 1.6
+++ Diff.java 3 Mar 2002 18:38:41 -0000 1.7
@@ -68,9 +68,20 @@
/**
- * Produces the "delta" differences between two sequences
+ * Produces the "delta" differences between two sequences.
*
- * @version $Revision: 1.6 $ $Date: 2002/02/27 04:17:57 $
+ * <p>Within this library, the word <i>text</i> means a unit of information
+ * subject to version control.
+ *
+ * <p>Text is represented as <code>Object[]</code> because
+ * the diff engine is capable of handling more than plain ascci. In fact,
+ * arrays of any type that implements
+ * {@link java.lang.Object#hashCode hashCode()} and
+ * {@link java.lang.Object#equals equals()}
+ * correctly can be subject to differencing using this
+ * library.</p>
+ *
+ * @version $Revision: 1.7 $ $Date: 2002/03/03 18:38:41 $
* @author Juancarlo A�ez
* @see org.apache.maven.jrcs.diff.Delta
*/
1.1
jakarta-turbine-maven/src/java/org/apache/maven/jrcs/diff/package.html
Index: package.html
===================================================================
<!DOCTYPE html PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. 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.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Maven" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Maven", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
* ITS 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
-->
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<title>
</title>
</head>
<body>
<p>
JRCS is a library that knows how to manipulate the archive files
produced by the RCS and CVS version control systems. JRCS is not
intended to replace neither tool. JRCS was written to be able
create archive analysis tools that can do things like identify
hot spots in the source code, measure the contributions by each
developer, o assess how bugs make it in.
</p>
<p>
The {@link org.apache.maven.jrcs.diff diff} package implements
the differencing engine that JRCS uses. The engine has the power
of Unix diff, is simple to understand, and can be used
independently of the archive handling functionality. The entry
point to the differencing engine is class {@link
org.apache.maven.jrcs.diff.Diff Diff}.
</p>
<p>
Text is represented as <code>Object[]</code> because the diff
engine is capable of handling more than plain ascci. In fact,
arrays of any type that implements {@link
java.lang.Object#hashCode hashCode()} and {@link
java.lang.Object#equals equals()} correctly can be subject to
differencing using this library.
</p>
<p>
@author <a href="mailto:[EMAIL PROTECTED]";>Juanco Anez</a>
@version $Id: Archive.java,v 1.16 2002/02/27 20:58:58 sbailliez
Exp $ @see Diff @see org.apache.maven.jrcs.rcs.Archive
</p>
</body>
</html>
1.17 +109 -13
jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Archive.java
Index: Archive.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Archive.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- Archive.java 27 Feb 2002 20:58:58 -0000 1.16
+++ Archive.java 3 Mar 2002 18:38:41 -0000 1.17
@@ -78,11 +78,86 @@
/**
- * Handling of RCS/CVS version control archives.
- * This class is NOT thread safe.
+ * Handling of RCS/CVS style version control archives.
+ *
+ *
+ * <p>JRCS is a library that knows how to manipulate the archive files produced
+ * by the RCS and CVS version control systems. JRCS is not intended to replace
+ * neither tool. JRCS was written to be able create archive analysis tools
+ * that can do things like identify hot spots in the source code,
+ * measure the contributions by each developer,
+ * or assess how bugs make it in.</p>
+ *
+ * <p>The reasons why JRCS has the ability do do check-ins and save archives
+ * is API symmetry, and to simplify the writing of unit tests.</p>
+ *
+ * <p><b>CAVEAT UTILITOR:</b> Do not make modifications to your archives with JRCS.
+ * There needs to be an important amount of additional testing
+ * before it's safe to do that.</p>
+ *
+ * <p>The {@link org.apache.maven.jrcs.rcs rcs} package implements the
+ * archive handling functionality. The entry point to the library is class
+ * {@link org.apache.maven.jrcs.rcs.Archive Archive}.</p>
+ *
+ *
+ * <p>The {@link org.apache.maven.jrcs.diff diff} package implements
+ * the differencing engine that JRCS uses. The engine has the power of Unix diff,
+ * is simple to understand, and can be used independently of the archive handling
+ * functionality. The entry point to the differencing engine is class
+ * {@link org.apache.maven.jrcs.diff.Diff Diff}.</p>
+ *
+ * <p>Within this library, the word <i>text</i> means a unit of information
+ * subject to version control. The word <i>revision</i> means a particular
+ * version of a text. Each <i>revision</i> has a <i>version number</i>
+ * associated to it. <i>Version numbers</i> are dot-separated lists of numbers.
+ * Version numbers with an odd number of dots indicate revisions, while those
+ * with an even number of dots (including zero dots) designate branches.</p>
+ *
+ * <p>Revisions of a text are represented as <code>Object[]</code> because
+ * the diff engine is capable of handling more than plain text. In fact,
+ * arrays of any type that implements
+ * {@link java.lang.Object#hashCode hashCode()} and
+ * {@link java.lang.Object#equals equals()}
+ * correctly can be subject to differencing and version control using this
+ * library.</p>
+ *
+ * <p>To create an empty archive use:
+ * <code><pre>
+ * Archive archive = new Archive();
+ * </pre></code>
+ * </p>
+ *
+ * <p>To read an archive from the file system, use:
+ * <code><pre>
+ * Archive archive = new Archive("/path/to/archive,v");
+ * </pre></code>
+ * </p>
+ *
+ * <p>You can also initialize archives from streams.</p>
+ *
+ * <p>To retreive a revision from an archive use:
+ * <code><pre>
+ * String versionNumber = "1.2";
+ * Object[] text = archive.getRevision(versionNumber);
+ * </pre></code>
+ * </p>
+ *
+ * <p>You can also retreive revisions in such a way that each item
+ * is annotated with the version number of the revision in which it was
+ * last changed or added. To retrieve annotated text use:
+ * <code><pre>
+ * String versionNumber = "1.2";
+ * {@link Line Line[]} text = archive.getRevision(versionNumber);
+ * for(int i = 0; i < text.length(); i++)
+ * System.out.println(text[i].revision.version);
+ * </pre></code>
+ * </p>
+ *
+ * <p>This class is NOT thread safe.</p>
+ * @see org.apache.maven.jrcs.diff
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Juanco Anez</a>
- * @version $Id: Archive.java,v 1.16 2002/02/27 20:58:58 sbailliez Exp $
+ * @version $Id: Archive.java,v 1.17 2002/03/03 18:38:41 juanco Exp $
*/
public class Archive
extends ToString
@@ -697,7 +772,7 @@
}
/**
- * Unquote a 8string quoted in RCS style.
+ * Unquote a string quoted in RCS style.
* @param s the quoted string.
* @return s the string unquoted.
*/
@@ -707,7 +782,7 @@
}
/**
- * Unquote a 8string quoted in RCS style.
+ * Unquote a string quoted in RCS style.
* @param s the quoted string.
* @param removeExtremes Determines if the enclosing @ quotes
* should be removed.
@@ -740,10 +815,13 @@
/**
* Get the text belonging to the head revision.
* @return The text of the head revision
+ * @throws NodeNotFoundException if the revision could not be found.
+ * @throws InvalidFileFormatException if any of the deltas cannot be parsed.
+ * @throws PatchFailedException if any of the deltas could not be applied
*/
public Object[] getRevision()
throws InvalidFileFormatException,
- DiffException,
+ PatchFailedException,
NodeNotFoundException
{
return getRevision(false);
@@ -755,10 +833,14 @@
* number of the revision in which they were added or changed.
* @param annotate set to true to have the text be annotated
* @return The text of the head revision
+ * @throws NodeNotFoundException if the revision could not be found.
+ * @throws InvalidFileFormatException if any of the deltas cannot be parsed.
+ * @throws PatchFailedException if any of the deltas could not be applied
+ * to produce a new revision.
*/
public Object[] getRevision(boolean annotate)
throws InvalidFileFormatException,
- DiffException,
+ PatchFailedException,
NodeNotFoundException
{
if (branch != null)
@@ -779,16 +861,20 @@
* Get the text belonging to the revision identified by the
* given version number.
* Partial version numbers are OK.
- * @param v the version number.
+ * @param vernum the version number.
* @return The text of the revision if found.
+ * @throws InvalidVersionNumberException if the version number cannot be parsed.
+ * @throws NodeNotFoundException if the revision could not be found.
+ * @throws InvalidFileFormatException if any of the deltas cannot be parsed.
+ * @throws PatchFailedException if any of the deltas could not be applied
*/
- public Object[] getRevision(String v)
+ public Object[] getRevision(String vernum)
throws InvalidFileFormatException,
PatchFailedException,
InvalidVersionNumberException,
NodeNotFoundException
{
- return getRevision(v, false);
+ return getRevision(vernum, false);
}
/**
@@ -797,17 +883,21 @@
* Partial version numbers are OK.
* Set annotate to true to have the lines be annotated with the
* number of the revision in which they were added or changed.
- * @param v the version number.
+ * @param vernum the version number.
* @param annotate set to true to have the text be annotated
* @return The text of the revision if found.
+ * @throws InvalidVersionNumberException if the version number cannot be parsed.
+ * @throws NodeNotFoundException if the revision could not be found.
+ * @throws InvalidFileFormatException if any of the deltas cannot be parsed.
+ * @throws PatchFailedException if any of the deltas could not be applied
*/
- public Object[] getRevision(String v, boolean annotate)
+ public Object[] getRevision(String vernum, boolean annotate)
throws InvalidVersionNumberException,
NodeNotFoundException,
InvalidFileFormatException,
PatchFailedException
{
- return getRevision(new Version(v), annotate);
+ return getRevision(new Version(vernum), annotate);
}
/**
@@ -816,6 +906,9 @@
* Partial version numbers are OK.
* @param vernum the version number.
* @return The text of the revision if found.
+ * @throws NodeNotFoundException if the revision could not be found.
+ * @throws InvalidFileFormatException if any of the deltas cannot be parsed.
+ * @throws PatchFailedException if any of the deltas could not be applied
*/
public Object[] getRevision(Version vernum)
throws InvalidFileFormatException,
@@ -834,6 +927,9 @@
* @param vernum the version number.
* @param annotate set to true to have the text be annotated
* @return The text of the revision if found.
+ * @throws NodeNotFoundException if the revision could not be found.
+ * @throws InvalidFileFormatException if any of the deltas cannot be parsed.
+ * @throws PatchFailedException if any of the deltas could not be applied
*/
public Object[] getRevision(Version vernum, boolean annotate)
throws InvalidFileFormatException,
1.10 +3 -3
jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/BranchNode.java
Index: BranchNode.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/BranchNode.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- BranchNode.java 27 Feb 2002 20:58:58 -0000 1.9
+++ BranchNode.java 3 Mar 2002 18:38:41 -0000 1.10
@@ -59,10 +59,10 @@
* Represents a branch node in a version control archive.
* This class is NOT thread safe.
*
- * <p>A {@linkplain BranchNode BranchNode} stores the deltas between the previous
revision
+ * <p>A {@link BranchNode BranchNode} stores the deltas between the previous
revision
* and the current revision; that is, when the deltas are applied
* to the previous revision, the text of the current revision is obtained.
- * The {@linkplain Node._rcsnext rcsnext} field of a BranchNode points to
+ * The {@link Node#rcsnext rcsnext} field of a BranchNode points to
* the next revision in the branch.
* </p>
*
@@ -70,7 +70,7 @@
* @see Archive
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Juanco Anez</a>
- * @version $Id: BranchNode.java,v 1.9 2002/02/27 20:58:58 sbailliez Exp $
+ * @version $Id: BranchNode.java,v 1.10 2002/03/03 18:38:41 juanco Exp $
*/
class BranchNode
extends Node
1.7 +2 -2
jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Line.java
Index: Line.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Line.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- Line.java 27 Feb 2002 20:18:05 -0000 1.6
+++ Line.java 3 Mar 2002 18:38:41 -0000 1.7
@@ -65,9 +65,9 @@
* @see Archive
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Juanco Anez</a>
- * @version $Id: Line.java,v 1.6 2002/02/27 20:18:05 sbailliez Exp $
+ * @version $Id: Line.java,v 1.7 2002/03/03 18:38:41 juanco Exp $
*/
-final class Line
+final public class Line
{
private final Node revision;
private final Object text;
1.9 +6 -6
jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Node.java
Index: Node.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Node.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Node.java 27 Feb 2002 20:58:58 -0000 1.8
+++ Node.java 3 Mar 2002 18:38:41 -0000 1.9
@@ -88,7 +88,7 @@
* @see Archive
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Juanco Anez</a>
- * @version $Id: Node.java,v 1.8 2002/02/27 20:58:58 sbailliez Exp $
+ * @version $Id: Node.java,v 1.9 2002/03/03 18:38:41 juanco Exp $
*/
abstract class Node
extends ToString
@@ -302,8 +302,8 @@
/**
* Sets the next node in the RCS logical hierarchy.
- * In the RCS hierarchy, a {@linkplain TrunkNode TrunkNode} points
- * to the previous revision, while a {@linkplain BranchNode BranchNode}
+ * In the RCS hierarchy, a {@link TrunkNode TrunkNode} points
+ * to the previous revision, while a {@link BranchNode BranchNode}
* points to the next revision.
* @param node The next node in the RCS logical hierarchy.
*/
@@ -489,10 +489,10 @@
* Returns the Node with the version number that corresponds to
* the revision to be obtained after the deltas in the current node
* are applied.
- * <p>For a {@linkplain BranchNode BranchNode} the deltaRevision is the
+ * <p>For a {@link BranchNode BranchNode} the deltaRevision is the
* current revision; that is, after the deltas are applied, the text for
* the current revision is obtained.</p>
- * <p>For a {@linkplain TrunkNode TrunkNode} the deltaRevision is the
+ * <p>For a {@link TrunkNode TrunkNode} the deltaRevision is the
* next revision; that is, after the deltas are applied, the text obtained
* corresponds to the next revision in the chain.</p>
* @return The node for the delta revision.
@@ -518,7 +518,7 @@
* Apply the deltas in the current node to the given text.
* @param original the text to be patched
* @param annotate set to true to have each text line be a
- * {@linkplain Line Line} object that identifies the revision in which
+ * {@link Line Line} object that identifies the revision in which
* the line was changed or added.
* @throws InvalidFileFormatException if the deltas cannot be parsed.
* @throws PatchFailedException if the diff engine determines that
1.8 +4 -4
jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Path.java
Index: Path.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Path.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Path.java 27 Feb 2002 20:48:43 -0000 1.7
+++ Path.java 3 Mar 2002 18:38:41 -0000 1.8
@@ -72,7 +72,7 @@
* @see Node
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Juanco Anez</a>
- * @version $Id: Path.java,v 1.7 2002/02/27 20:48:43 juanco Exp $
+ * @version $Id: Path.java,v 1.8 2002/03/03 18:38:41 juanco Exp $
*/
class Path
{
@@ -142,7 +142,7 @@
* Assume that the text of the first node is plaintext and not
* deltatext.
* @param annotate if true, then each text line is a
- * {@linkplain Line Line} with the original text annotated with
+ * {@link Line Line} with the original text annotated with
* the revision in which it was last changed or added.
* @return The resulting text after the patches
*/
@@ -161,7 +161,7 @@
* deltatext.
* @param lines The list to where the text must be added and the
* patches applied.
- * {@linkplain Line Line} with the original text annotated with
+ * {@link Line Line} with the original text annotated with
* the revision in which it was last changed or added.
* @return The resulting text after the patches
*/
@@ -181,7 +181,7 @@
* @param lines The list to where the text must be added and the
* patches applied.
* @param annotate if true, then each text line is a
- * {@linkplain Line Line} with the original text annotated with
+ * {@link Line Line} with the original text annotated with
* the revision in which it was last changed or added.
* @return The resulting text after the patches
*/
1.10 +3 -3
jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/TrunkNode.java
Index: TrunkNode.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/TrunkNode.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- TrunkNode.java 27 Feb 2002 20:58:58 -0000 1.9
+++ TrunkNode.java 3 Mar 2002 18:38:41 -0000 1.10
@@ -60,11 +60,11 @@
/**
* Represents a node on the trunk or main branch of a version control Archive.
*
- * <p>A {@linkplain TrunkNode TrunkNode} stores the deltas between the node's
+ * <p>A {@link TrunkNode TrunkNode} stores the deltas between the node's
* revision and the previous revision;
* that is, when the deltas are applied to the current revision, the
* text of the previous revision is obtained.
- * The {@linkplain Node._rcsnext rcsnext} field of a TrunkNode
+ * The {@link Node#rcsnext rcsnext} field of a TrunkNode
* points to the node corresponding to the previous revision.</p>
* This class is NOT thread safe.
*
@@ -72,7 +72,7 @@
* @see Archive
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Juanco Anez</a>
- * @version $Id: TrunkNode.java,v 1.9 2002/02/27 20:58:58 sbailliez Exp $
+ * @version $Id: TrunkNode.java,v 1.10 2002/03/03 18:38:41 juanco Exp $
*/
class TrunkNode
extends Node
1.8 +2 -2
jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Version.java
Index: Version.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Version.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Version.java 27 Feb 2002 20:48:43 -0000 1.7
+++ Version.java 3 Mar 2002 18:38:41 -0000 1.8
@@ -61,13 +61,13 @@
import org.apache.maven.jrcs.util.ToString;
/**
- * Contains and manages a version number of the form x.y.z... .
+ * Contains and manages a version number of the form "x(\.y)*".
* This class is NOT thread safe.
*
* @see Archive
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Juanco Anez</a>
- * @version $Id: Version.java,v 1.7 2002/02/27 20:48:43 juanco Exp $
+ * @version $Id: Version.java,v 1.8 2002/03/03 18:38:41 juanco Exp $
*/
public class Version
extends ToString
1.1
jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/package.html
Index: package.html
===================================================================
<!DOCTYPE html PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. 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.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Maven" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Maven", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
* ITS 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
-->
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<title>
</title>
</head>
<body>
JRCS is a library that knows how to manipulate the archive files
produced by the RCS and CVS version control systems.
<p>
JRCS is not intended to replace RCS nor CVS. JRCS was written to
be able create archive analysis tools that can do things like
identify hot spots in the source code, measure the contributions
by each developer, or assess how bugs make it in.
</p>
<p>
The reasons why JRCS has the ability do do check-ins and save
archives is API symmetry, and to simplify the writing of unit
tests.
</p>
<p>
The {@link org.apache.maven.jrcs.rcs rcs} package implements th8e
archive handling functionality. The entry point to the library is
class {@link org.apache.maven.jrcs.rcs.Archive Archive}.
</p>
<p>
<b>CAVEAT UTILITOR:</b> Do not make modifications to your
archives with JRCS. There needs to be an important amount of
additional testing before it's safe to do that.
</p>
<p>
The {@link org.apache.maven.jrcs.diff diff} package implements
the differencing engine that JRCS uses. The engine has the power
of Unix diff, is simple to understand, and can be used
independently of the archive handling functionality. The entry
point to the differencing engine is class {@link
org.apache.maven.jrcs.diff.Diff Diff}.
</p>
<h2>
Package Dependencies
</h2>
<h3>
Jakarta ORO Regexp
</h3>
<p>
The Jakarta ORO Regexp library is used for RCS keyword
management. You can get a copy of Jakarta ORO from:
</p>
<blockquote>
<a href="http://jakarta.apache.org/oro/";>http://jakarta.apache.org/oro/</a>
</blockquote>
<p>
A copy of Jakarta Regexp is included in the full distribution of
this library.
</p>
<h3>
JavaCC
</h3>
<p>
The RCS parser is constructed using the JavaCC compiler compiler.
You can get a copy of JavaCC from:
</p>
<blockquote>
<a href="http://www.metamata.com/javacc/";>http://www.metamata.com/javacc/</a>
</blockquote>
<p>
JavaCC is not distributable, so you must get a copy of it
yourself if you intend to use it. Keep in mind that, as
distributed, this library does not require JavaCC to be compiled
because all the JavaCC generated .java files are included.
</p>
<p>
If you decide to use JavaCC, please adjust the "javacc.lib.dir"
property as needed. You'll also need to download the set of
optional tasks for Ant.
</p>
<h3>
JUnit
</h3>
<p>
The library tests are written for the JUnit Testing Framework.
For distributions and documentation see:
</p>
<blockquote>
<a href="http://www.junit.org/";>http://www.junit.org/</a>
</blockquote>
<p>
@author <a href="mailto:[EMAIL PROTECTED]";>Juanco Anez</a>
@version $Id: Archive.java,v 1.16 2002/02/27 20:58:58 sbailliez
Exp $ @see Archive @see org.apache.maven.jrcs.diff.Diff
</p>
</body>
</html>
1.1
jakarta-turbine-maven/src/java/org/apache/maven/jrcs/tools/package.html
Index: package.html
===================================================================
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
<!--
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. 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.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Maven" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Maven", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
* ITS 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
-->
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<title>
</title>
</head>
<body>
Simple tools to test the functionality of the {@linkplain
org.apache.maven.jrcs} library.
</body>
</html>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
