[jsword-svn] r1907 - in trunk/jsword/src/main/java/org/crosswire/jsword: book book/basic book/readings book/sword bridge passage

dmsmith at www.crosswire.org dmsmith at www.crosswire.org
Fri Jul 25 12:00:16 MST 2008


Author: dmsmith
Date: 2008-07-25 12:00:13 -0700 (Fri, 25 Jul 2008)
New Revision: 1907

Modified:
   trunk/jsword/src/main/java/org/crosswire/jsword/book/Bookmark.java
   trunk/jsword/src/main/java/org/crosswire/jsword/book/basic/DefaultBookmark.java
   trunk/jsword/src/main/java/org/crosswire/jsword/book/readings/ReadingsKey.java
   trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/AbstractKeyBackend.java
   trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/DataEntry.java
   trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/RawBackend.java
   trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/RawLDBackend.java
   trunk/jsword/src/main/java/org/crosswire/jsword/bridge/BookInstaller.java
   trunk/jsword/src/main/java/org/crosswire/jsword/bridge/DwrBridge.java
   trunk/jsword/src/main/java/org/crosswire/jsword/passage/VerseRange.java
Log:
QA changes: checkstyle, javadoc

Modified: trunk/jsword/src/main/java/org/crosswire/jsword/book/Bookmark.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/book/Bookmark.java	2008-07-25 17:42:46 UTC (rev 1906)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/book/Bookmark.java	2008-07-25 19:00:13 UTC (rev 1907)
@@ -47,7 +47,7 @@
 
     /**
      * Return the ordered set of books.
-     * @return
+     * @return the books
      */
     List getBooks();
 

Modified: trunk/jsword/src/main/java/org/crosswire/jsword/book/basic/DefaultBookmark.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/book/basic/DefaultBookmark.java	2008-07-25 17:42:46 UTC (rev 1906)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/book/basic/DefaultBookmark.java	2008-07-25 19:00:13 UTC (rev 1907)
@@ -50,31 +50,24 @@
         books = new ArrayList();
     }
 
-    /**
-     * Add a Book to this Bookmark.
-     * The books are maintained in the order they are added as a set.
-     * 
-     * @param book the Book to add.
+    /* (non-Javadoc)
+     * @see org.crosswire.jsword.book.Bookmark#addBook(org.crosswire.jsword.book.Book)
      */
     public void addBook(Book book)
     {
         books.add(book);
     }
 
-    /**
-     * Return the ordered set of books.
-     * @return
+    /* (non-Javadoc)
+     * @see org.crosswire.jsword.book.Bookmark#getBooks()
      */
     public List getBooks()
     {
         return Collections.unmodifiableList(books);
     }
 
-    /**
-     * Set the SearchRequest for this Bookmark. A copy of the SearchRequest will be stored.
-     * Note, setting this will clear the lookup request, if any.
-     * 
-     * @param request the SearchRequest
+    /* (non-Javadoc)
+     * @see org.crosswire.jsword.book.Bookmark#setSearchRequest(org.crosswire.jsword.index.search.SearchRequest)
      */
     public void setSearchRequest(SearchRequest request)
     {
@@ -82,21 +75,16 @@
         lookupRequest = null;
     }
 
-    /**
-     * Get the SearchRequest for this Bookmark.
-     * 
-     * @return a copy of the SearchRequest, or null.
+    /* (non-Javadoc)
+     * @see org.crosswire.jsword.book.Bookmark#getSearchRequest()
      */
     public SearchRequest getSearchRequest()
     {
         return searchRequest;
     }
 
-    /**
-     * Set the lookup request for this Bookmark.
-     * Note, setting this will clear the SearchRequest, if any.
-     * 
-     * @param request the lookup request.
+    /* (non-Javadoc)
+     * @see org.crosswire.jsword.book.Bookmark#setLookupRequest(java.lang.String)
      */
     public void setLookupRequest(String request)
     {
@@ -104,21 +92,16 @@
         searchRequest = null;
     }
 
-    /**
-     * Get the lookup request.
-     * 
-     * @return the lookup request or null.
+    /* (non-Javadoc)
+     * @see org.crosswire.jsword.book.Bookmark#getLookupRequest()
      */
     public String getLookupRequest()
     {
         return lookupRequest;
     }
 
-    /**
-     * Convert this Bookmark into a BookData by converting the SearchReqeust or lookup request
-     * into a key list.
-     * 
-     * @return the resulting BookData
+    /* (non-Javadoc)
+     * @see org.crosswire.jsword.book.Bookmark#getBookData()
      */
     public BookData getBookData()
     {

Modified: trunk/jsword/src/main/java/org/crosswire/jsword/book/readings/ReadingsKey.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/book/readings/ReadingsKey.java	2008-07-25 17:42:46 UTC (rev 1906)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/book/readings/ReadingsKey.java	2008-07-25 19:00:13 UTC (rev 1907)
@@ -131,7 +131,7 @@
     /**
      * Convert the Gregorian Calendar to a string.
      * @param externalKey
-     * @return
+     * @return the internal representation of the key
      */
     public static String external2internal(Calendar externalKey)
     {

Modified: trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/AbstractKeyBackend.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/AbstractKeyBackend.java	2008-07-25 17:42:46 UTC (rev 1906)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/AbstractKeyBackend.java	2008-07-25 19:00:13 UTC (rev 1907)
@@ -38,7 +38,7 @@
 {
     /**
      * Simple ctor
-     * @param datasize We need to know how many bytes in the size portion of the index
+     * @param sbmd the book's metadata
      */
     public AbstractKeyBackend(SwordBookMetaData sbmd)
     {

Modified: trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/DataEntry.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/DataEntry.java	2008-07-25 17:42:46 UTC (rev 1906)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/DataEntry.java	2008-07-25 19:00:13 UTC (rev 1907)
@@ -62,9 +62,7 @@
 
     /**
      * Get the key from this DataEntry.
-     * @param name A diagnostic name. Either the module initials or the expected key name.
-     * @param charset The character encoding for the String
-     * @return the key
+    * @return the key
      */
     public String getKey()
     {
@@ -106,7 +104,7 @@
      * If the entry is not linked then it is an error to call this method.
      * 
      * @return the key to look up
-     * @see isLinkEntry
+     * @see #isLinkEntry()
      */
     public String getLinkTarget()
     {
@@ -129,7 +127,7 @@
 
     /**
      * Get the block start and entry position.
-     * @return
+     * @return the index of the block
      */
     public DataIndex getBlockIndex()
     {

Modified: trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/RawBackend.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/RawBackend.java	2008-07-25 17:42:46 UTC (rev 1906)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/RawBackend.java	2008-07-25 19:00:13 UTC (rev 1907)
@@ -261,7 +261,7 @@
     /**
      * Get the Index (that is offset and size) for an entry.
      * @param entry
-     * @return
+     * @return the index for the entry
      * @throws IOException 
      */
     private DataIndex getIndex(RandomAccessFile raf, long entry) throws IOException

Modified: trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/RawLDBackend.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/RawLDBackend.java	2008-07-25 17:42:46 UTC (rev 1906)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/book/sword/RawLDBackend.java	2008-07-25 19:00:13 UTC (rev 1907)
@@ -285,7 +285,7 @@
     /**
      * Get the Index (that is offset and size) for an entry.
      * @param entry
-     * @return
+     * @return the index of the entry
      * @throws IOException 
      */
     private DataIndex getIndex(long entry) throws IOException
@@ -328,7 +328,7 @@
      * Find a matching entry, returning it's index. Otherwise return < 0, such that
      * (-pos - 1) gives the insertion index.
      * @param key
-     * @return
+     * @return the match
      * @throws IOException
      */
     private int search(String key) throws IOException

Modified: trunk/jsword/src/main/java/org/crosswire/jsword/bridge/BookInstaller.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/bridge/BookInstaller.java	2008-07-25 17:42:46 UTC (rev 1906)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/bridge/BookInstaller.java	2008-07-25 19:00:13 UTC (rev 1907)
@@ -68,9 +68,9 @@
     }
 
     /**
-     * Get a list of all know installers.
+     * Get a list of all known installers.
      * 
-     * @return
+     * @return the list of installers
      */
     public Map getInstallers()
     {
@@ -100,7 +100,7 @@
 
     /**
      * Get a list of books by CustomFilter specification
-     * @param filter The filter string
+     * @param filterSpec The filter string
      * @see BookFilters#getCustom(java.lang.String)
      * @see Books
      */
@@ -143,7 +143,7 @@
 
     /**
      * Get a list of books in a repository by CustomFilter specification
-     * @param filter The filter string
+     * @param filterSpec The filter string
      * @see BookFilters#getCustom(java.lang.String)
      * @see Books
      */
@@ -179,7 +179,7 @@
      * 
      * @param repositoryName the repository from which to get the book
      * @param bookName the name of the book to get
-     * @return
+     * @return the Book
      */
     public Book getBook(String repositoryName, String bookName)
     {
@@ -190,7 +190,7 @@
      * Install a book, overwriting it if the book to be installed is newer.
      * 
      * @param repositoryName the name of the repository from which to get the book
-     * @param bookName the book to get
+     * @param book the book to get
      * @throws BookException 
      * @throws InstallException 
      */

Modified: trunk/jsword/src/main/java/org/crosswire/jsword/bridge/DwrBridge.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/bridge/DwrBridge.java	2008-07-25 17:42:46 UTC (rev 1906)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/bridge/DwrBridge.java	2008-07-25 19:00:13 UTC (rev 1907)
@@ -56,8 +56,7 @@
      * 
      * @param filter The custom filter specification string
      * @return a list of (initial, name) string pairs
-     * @see BookFilters#getCustom(java.lang.String)
-     * @see Books
+     * @see BookInstaller#getInstalledBook(String)
      */
     public String[][] getInstalledBooks(String filter)
     {
@@ -144,9 +143,11 @@
     }
 
     /**
+     * Get a reference list for a search result against a book.
+     * 
      * @param bookInitials
      * @param searchRequest
-     * @return
+     * @return The reference for the matching.
      * @throws BookException
      */
     public String search(String bookInitials, String searchRequest) throws BookException
@@ -218,7 +219,7 @@
 
     /**
      * For the sake of diagnostics, return the locations that JSword will look for books.
-     * @return
+     * @return the SWORD path
      */
     public String[] getSwordPath()
     {

Modified: trunk/jsword/src/main/java/org/crosswire/jsword/passage/VerseRange.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/passage/VerseRange.java	2008-07-25 17:42:46 UTC (rev 1906)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/passage/VerseRange.java	2008-07-25 19:00:13 UTC (rev 1907)
@@ -43,7 +43,7 @@
  *      The copyright to this program is held by it's authors.
  * @author Joe Walker [joe at eireneh dot com]
  * @author DM Smith [dmsmith555 at yahoo dot com]
- */ 
+ */
 public final class VerseRange implements Key
 {
     /**




More information about the jsword-svn mailing list