Changeset 3870851


Ignore:
Timestamp:
Mar 31, 2015, 11:27:32 AM (3 years ago)
Author:
Michael Seifert <mseifert@…>
Branches:
master
Children:
7c70b11
Parents:
a37e89a
Message:

Improved javadoc documentation

Location:
core/src/main/java/de/erichseifert/warp/core
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • core/src/main/java/de/erichseifert/warp/core/DataPresenter.java

    ra37e89a r3870851  
    3232
    3333import de.erichseifert.warp.core.io.MemoryStorage;
     34import de.erichseifert.warp.core.io.ReplayStorage;
    3435import de.erichseifert.warp.core.io.ReplayStorageListener;
    35 import de.erichseifert.warp.core.io.ReplayStorage;
    3636import de.erichseifert.warp.core.io.Settings;
    3737import de.erichseifert.warp.core.io.search.ReplayIndexer.SearchMode;
     
    181181         * parses them, and adds them to the storage.
    182182         * Calling this method fires a replay info change.
    183          * @param dir
     183         * @param dir Directory to be parsed
     184         * @param listeners Listeners registered to the process
    184185         */
    185186        public void parseDir(File dir, ProgressListener... listeners) {
     
    223224         * Returns all replays that match the specified queries and the
    224225         * according ranges in the specified search mode.
    225          * @param queries Queries to be searched for.
     226         * @param query Query to be searched for.
    226227         * @param ranges Ranges of the queries.
    227228         * @param mode Search mode.
     
    284285        }
    285286
     287        /**
     288         * Sets the path where the data is stored to the specified value.
     289         * @param path Storage path
     290         * @throws IOException if the path cannot be accesssed
     291         */
    286292        public void setStoragePath(String path) throws IOException {
    287293                storage.setStoragePath(path);
    288294        }
    289295
     296        /**
     297         * Returns the path where the data is stored.
     298         * @return Storage path
     299         */
    290300        public String getStoragePath() {
    291301                return storage.getStoragePath();
  • core/src/main/java/de/erichseifert/warp/core/io/BufferedStorage.java

    ra37e89a r3870851  
    5454                /**
    5555                 * Creates a new <code>StorageBuffer</code> with the specified buffer size.
    56                  * @param bufferSize
     56                 * @param bufferSize Size in elements.
    5757                 */
    5858                public StorageBuffer(int bufferSize) {
  • core/src/main/java/de/erichseifert/warp/core/io/ReplayStorage.java

    ra37e89a r3870851  
    133133         * Sets the storage path to the specified value.
    134134         * @param path Storage path
    135          * @throws IOException
     135         * @throws IOException if the path cannot be accessed
    136136         */
    137137        void setStoragePath(String path) throws IOException;
  • core/src/main/java/de/erichseifert/warp/core/io/search/IndexHierarchy.java

    ra37e89a r3870851  
    137137                 * @param propertyGetterName Name of the property's getter method.
    138138                 * @param id Id.
    139                  * @return
     139                 * @return Removed node
    140140                 */
    141141                public Node remove(String propertyGetterName, long id) {
     
    234234         * @param propertyGetterName Name of the property's getter method.
    235235         * @param id Id.
    236          * @return
     236         * @return Removed node.
    237237         */
    238238        public Node remove(String propertyGetterName, long id) {
  • core/src/main/java/de/erichseifert/warp/core/io/search/IndexedProperty.java

    ra37e89a r3870851  
    5757        /**
    5858         * Returns the class containing this property.
    59          * @return
     59         * @return Containing class
    6060         */
    6161        public Class<?> getDeclaringClass() {
  • core/src/main/java/de/erichseifert/warp/core/io/search/ReplayIndexer.java

    ra37e89a r3870851  
    2626import java.util.Set;
    2727
     28import de.erichseifert.warp.core.io.ReplayStorage;
    2829import de.erichseifert.warp.core.io.ReplayStorageListener;
    29 import de.erichseifert.warp.core.io.ReplayStorage;
    3030import de.erichseifert.warp.core.io.search.IndexHierarchy.Node;
    3131import de.erichseifert.warp.core.io.search.indices.Index.Range;
     
    4747 * @see Indexable
    4848 * @see IndexableChildren
    49  * @see de.erichseifert.warp.ReplayDataChangeListener
    5049 */
    5150public interface ReplayIndexer extends ReplayStorageListener, Serializable {
  • core/src/main/java/de/erichseifert/warp/core/io/search/indices/FieldIndex.java

    ra37e89a r3870851  
    3838 * <code>FieldIndex</code> does distinguish between upper and lower
    3939 * case letters.
    40  * @see de.erichseifert.warp.io.search.Indexable
     40 * @see de.erichseifert.warp.core.io.search.Indexable
    4141 */
    4242public class FieldIndex extends AbstractIndex {
  • core/src/main/java/de/erichseifert/warp/core/io/search/indices/FullTextIndex.java

    ra37e89a r3870851  
    3030import java.util.regex.Pattern;
    3131
     32import de.erichseifert.warp.core.io.search.IndexHierarchy.Node;
    3233import de.erichseifert.warp.core.io.search.ReplayIndexer;
    33 import de.erichseifert.warp.core.io.search.IndexHierarchy.Node;
    3434
    3535/**
     
    4242 * <code>FullTextIndex</code> does not distinguish between upper and lower
    4343 * case letters.
    44  * @see de.erichseifert.warp.io.search.Indexable
     44 * @see de.erichseifert.warp.core.io.search.Indexable
    4545 */
    4646public class FullTextIndex extends AbstractIndex {
Note: See TracChangeset for help on using the changeset viewer.