diff src/org/tmatesoft/hg/repo/HgDataFile.java @ 380:9517df1ef7ec

Comments/javadoc
author Artem Tikhomirov <tikhomirov.artem@gmail.com>
date Thu, 09 Feb 2012 18:57:14 +0100
parents 8107b95f4280
children 994b5813a925
line wrap: on
line diff
--- a/src/org/tmatesoft/hg/repo/HgDataFile.java	Thu Feb 09 16:47:17 2012 +0100
+++ b/src/org/tmatesoft/hg/repo/HgDataFile.java	Thu Feb 09 18:57:14 2012 +0100
@@ -92,7 +92,7 @@
 	 * @param nodeid revision of the file
 	 * 
 	 * @return size of the file content at the given revision
-	 * @throws HgInvalidRevisionException if supplied argument doesn't represent revision index in this revlog
+	 * @throws HgInvalidRevisionException if supplied nodeid doesn't identify any revision from this revlog  
 	 * @throws HgDataStreamException if attempt to access file metadata failed
 	 * @throws HgInvalidControlFileException if access to revlog index/data entry failed
 	 */
@@ -127,7 +127,7 @@
 	 *     
 	 * @param sink where to pipe content to
 	 * @throws HgDataStreamException to indicate troubles reading repository file
-	 * @throws CancelledException if operation was cancelled
+	 * @throws CancelledException if execution of the operation was cancelled
 	 */
 	public void workingCopy(ByteChannel sink) throws HgDataStreamException, HgInvalidControlFileException, CancelledException {
 		File f = getRepo().getFile(this);
@@ -205,9 +205,9 @@
  	 * @param fileRevisionIndex - revision local index, non-negative. From predefined constants, {@link HgRepository#TIP} and {@link HgRepository#WORKING_COPY} make sense. 
 	 * @param sink
 	 * @throws HgDataStreamException FIXME
-	 * @throws HgInvalidControlFileException
-	 * @throws CancelledException
-	 * @throws HgInvalidRevisionException
+	 * @throws HgInvalidControlFileException if access to revlog index/data entry failed
+	 * @throws CancelledException if execution of the operation was cancelled
+	 * @throws HgInvalidRevisionException if supplied argument doesn't represent revision index in this revlog
 	 */
 	public void content(int fileRevisionIndex, ByteChannel sink) throws HgDataStreamException, HgInvalidControlFileException, CancelledException, HgInvalidRevisionException {
 		// for data files need to check heading of the file content for possible metadata