[jsword-svn] r1420 - in trunk: bibledesktop/src/main/java/org/crosswire/bibledesktop/book common/src/main/java/org/crosswire/common/diff jsword/src/main/java/org/crosswire/jsword/book/basic jsword/src/main/java/org/crosswire/jsword/book/sword jsword/src/main/java/org/crosswire/jsword/versification
dmsmith at www.crosswire.org
dmsmith at www.crosswire.org
Thu Jun 21 05:01:01 MST 2007
Author: dmsmith
Date: 2007-06-21 05:01:00 -0700 (Thu, 21 Jun 2007)
New Revision: 1420
Modified:
trunk/bibledesktop/src/main/java/org/crosswire/bibledesktop/book/BookSelectEvent.java
trunk/common/src/main/java/org/crosswire/common/diff/DifferenceEngine.java
trunk/common/src/main/java/org/crosswire/common/diff/Patch.java
trunk/jsword/src/main/java/org/crosswire/jsword/book/basic/AbstractPassageBook.java
trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/TreeNode.java
trunk/jsword/src/main/java/org/crosswire/jsword/versification/BookName.java
Log:
Javadoc bug fixes.
Modified: trunk/bibledesktop/src/main/java/org/crosswire/bibledesktop/book/BookSelectEvent.java
===================================================================
--- trunk/bibledesktop/src/main/java/org/crosswire/bibledesktop/book/BookSelectEvent.java 2007-06-20 20:22:58 UTC (rev 1419)
+++ trunk/bibledesktop/src/main/java/org/crosswire/bibledesktop/book/BookSelectEvent.java 2007-06-21 12:01:00 UTC (rev 1420)
@@ -35,9 +35,9 @@
public class BookSelectEvent extends EventObject
{
/**
- * For when a command has been made
+ * Create a BookSelectionEvent, declaring that the BookProvider has a new selection.
+ *
* @param source The thing that started this off
- * @param books The selected books
*/
public BookSelectEvent(BookProvider source)
{
Modified: trunk/common/src/main/java/org/crosswire/common/diff/DifferenceEngine.java
===================================================================
--- trunk/common/src/main/java/org/crosswire/common/diff/DifferenceEngine.java 2007-06-20 20:22:58 UTC (rev 1419)
+++ trunk/common/src/main/java/org/crosswire/common/diff/DifferenceEngine.java 2007-06-21 12:01:00 UTC (rev 1420)
@@ -360,7 +360,7 @@
}
/**
- * Set the timeout for the diff operation. 0 for infinity. Default is 1 second.
+ * Set the timeout for the diff operation. The default is 1 second. Use 0 for infinity.
*
* @param newTimeout
*/
@@ -370,7 +370,7 @@
}
/**
- * Number of seconds to map a diff before giving up. (0 for infinity)
+ * Number of seconds to map a diff before giving up. Use 0 for infinity.
*/
private static final float TIMEOUT = 1.0f;
private static float timeout = TIMEOUT;
Modified: trunk/common/src/main/java/org/crosswire/common/diff/Patch.java
===================================================================
--- trunk/common/src/main/java/org/crosswire/common/diff/Patch.java 2007-06-20 20:22:58 UTC (rev 1419)
+++ trunk/common/src/main/java/org/crosswire/common/diff/Patch.java 2007-06-21 12:01:00 UTC (rev 1420)
@@ -86,7 +86,7 @@
* Use the diffs provided.
* @param source Old text
* @param target New text
- * @param diffs Optional array of diff tuples for text1 to text2.
+ * @param diffList Optional array of diff tuples for text1 to text2.
* @return this patch
*/
public Patch make(String source, String target, List diffList)
@@ -189,9 +189,8 @@
/**
- * Merge a set of patches onto the text. Return a patched text, as well
+ * Merge this patch onto the text. Return a patched text, as well
* as an array of true/false values indicating which patches were applied.
- * @param patches Array of patch objects
* @param text Old text
* @return the patch result
*/
Modified: trunk/jsword/src/main/java/org/crosswire/jsword/book/basic/AbstractPassageBook.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/book/basic/AbstractPassageBook.java 2007-06-20 20:22:58 UTC (rev 1419)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/book/basic/AbstractPassageBook.java 2007-06-21 12:01:00 UTC (rev 1420)
@@ -112,7 +112,7 @@
* Add the OSIS elements to the div element. Note, this assumes that
* the data is fully marked up.
* @param key The key being added
- * @param div The div element to which the key is being added
+ * @param div The div element to which the key's OSIS representation is being added
* @param osisContent The OSIS representation of the key being added.
*/
public void addOSIS(Key key, Element div, List osisContent)
@@ -125,7 +125,7 @@
* Add the OSIS elements to the div element. Note, this assumes that
* the data is fully marked up.
* @param key The key being added
- * @param div The div element to which the key is being added
+ * @param content The list to which the key's OSIS representation is being added
* @param osisContent The OSIS representation of the key being added.
*/
public void addOSIS(Key key, List content, List osisContent)
@@ -231,39 +231,4 @@
*/
private static final Logger log = Logger.getLogger(AbstractPassageBook.class);
-// /* (non-Javadoc)
-// * @see org.crosswire.jsword.book.Book#getRawText(org.crosswire.jsword.passage.Key)
-// */
-// public String getRawText(Key key) throws BookException
-// {
-// assert key != null;
-//
-// StringBuffer buffer = new StringBuffer();
-//
-// // For all the ranges in this Passage
-// Passage ref = KeyUtil.getPassage(key);
-// Iterator rit = ref.rangeIterator(RestrictionType.CHAPTER);
-//
-// while (rit.hasNext())
-// {
-// VerseRange range = (VerseRange) rit.next();
-//
-// // For all the verses in this range
-// Iterator vit = range.iterator();
-// while (vit.hasNext())
-// {
-// Key subkey = (Key) vit.next();
-// String txt = getRawText(subkey);
-//
-// // If the verse is empty then we shouldn't add the verse
-// if (txt.length() > 0)
-// {
-// buffer.append(txt);
-// buffer.append('\n');
-// }
-// }
-// }
-//
-// return buffer.toString();
-// }
}
Modified: trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/TreeNode.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/TreeNode.java 2007-06-20 20:22:58 UTC (rev 1419)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/TreeNode.java 2007-06-21 12:01:00 UTC (rev 1420)
@@ -205,20 +205,23 @@
private byte[] userData;
/**
- * The offset of the parent record in the offset.<br/>-1 means that there are no
- * parents and this TreeNode is a root.
+ * The offset of the parent record in the offset.
+ * Root nodes are indicated with a value of -1.
+ * That is, this TreeNode does not hava a parent.
*/
private int parent;
/**
- * The offset of the next sibling record in the offset.<br/>-1 means that there is
- * no next sibling.
+ * The offset of the next sibling record in the offset.
+ * Final siblings are indicated with a value of -1.
+ * That is, this TreeNode does not have a next sibling.
*/
private int nextSibling;
/**
- * The offset of the first child record in the offset.<br/>-1 means that there are
- * no children and this TreeNode is a leaf.
+ * The offset of the first child record in the offset.
+ * Leaf nodes are indicated with a value of -1.
+ * That is, this TreeNode does not have any children.
*/
private int firstChild;
Modified: trunk/jsword/src/main/java/org/crosswire/jsword/versification/BookName.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/versification/BookName.java 2007-06-20 20:22:58 UTC (rev 1419)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/versification/BookName.java 2007-06-21 12:01:00 UTC (rev 1420)
@@ -43,7 +43,7 @@
* @param bookNumber the Book's canonical number
* @param longName the Book's long name
* @param shortName the Book's short name, if any
- * @param alternateNames optional alternates for the Book
+ * @param alternateNames optional comma separated list of alternates for the Book
*/
public BookName(Locale locale, int bookNumber, String longName, String shortName, String alternateNames)
{
@@ -72,9 +72,7 @@
/**
* Get the preferred name of a book.
* Altered by the case setting (see setBookCase() and isLongBookName())
- * @param book The book number (1-66)
- * @return The full name of the book
- * @exception NoSuchVerseException If the book number is not valid
+ * @return The preferred name of the book
*/
public String getPreferredName()
{
More information about the jsword-svn
mailing list