comparison src/org/tmatesoft/hg/core/HgCatCommand.java @ 368:8107b95f4280

Update Javadoc with 'revision index'
author Artem Tikhomirov <tikhomirov.artem@gmail.com>
date Fri, 16 Dec 2011 16:00:57 +0100
parents 2fadf8695f8a
children 0ae53c32ecef
comparison
equal deleted inserted replaced
367:2fadf8695f8a 368:8107b95f4280
63 file = fname; 63 file = fname;
64 return this; 64 return this;
65 } 65 }
66 66
67 /** 67 /**
68 * Select specific revision of the file to cat with local revision index. Note, revision numbering is of particular file, not that of 68 * Select specific revision of the file to cat with revision local index. Note, revision numbering is of particular file, not that of
69 * repository (i.e. revision 0 means initial content of the file, irrespective of changeset revision at the time of commit) 69 * repository (i.e. revision 0 means initial content of the file, irrespective of changeset revision at the time of commit)
70 * 70 *
71 * Invocation of this method clears revision set with {@link #revision(Nodeid)} or {@link #revision(int)} earlier. 71 * Invocation of this method clears revision set with {@link #revision(Nodeid)} or {@link #revision(int)} earlier.
72 * 72 *
73 * @param fileRevisionIndex local revision index, non-negative, or one of predefined constants. Note, use of {@link HgRepository#BAD_REVISION}, 73 * @param fileRevisionIndex - revision local index, non-negative, or one of predefined constants. Note, use of {@link HgRepository#BAD_REVISION},
74 * although possible, makes little sense (command would fail if executed). 74 * although possible, makes little sense (command would fail if executed).
75 * @return <code>this</code> for convenience 75 * @return <code>this</code> for convenience
76 */ 76 */
77 public HgCatCommand revision(int fileRevisionIndex) { 77 public HgCatCommand revision(int fileRevisionIndex) {
78 if (wrongRevisionIndex(fileRevisionIndex)) { 78 if (wrongRevisionIndex(fileRevisionIndex)) {
114 114
115 /** 115 /**
116 * Select whatever revision of the file that was actual at the time of the specified changeset. Unlike {@link #revision(int)} or {@link #revision(Nodeid)}, this method 116 * Select whatever revision of the file that was actual at the time of the specified changeset. Unlike {@link #revision(int)} or {@link #revision(Nodeid)}, this method
117 * operates in terms of repository global revisions (aka changesets). 117 * operates in terms of repository global revisions (aka changesets).
118 * 118 *
119 * Invocation of this method clears local file revisions selection. 119 * Invocation of this method clears selection of a file revision with its index.
120 * 120 *
121 * @param nodeid changeset revision 121 * @param nodeid changeset revision
122 * @return <code>this</code> for convenience 122 * @return <code>this</code> for convenience
123 */ 123 */
124 public HgCatCommand changeset(Nodeid nodeid) { 124 public HgCatCommand changeset(Nodeid nodeid) {