Changeset 6770 for trunk/gli/src/org/greenstone/gatherer/cdm

Timestamp:

2004-02-10T18:07:32+13:00 (20 years ago)

Author:

kjdon

Message:

fixed all the javadoc errors. (hope I didn't commit anything I wasn't supposed to)

Location:

trunk/gli/src/org/greenstone/gatherer/cdm

Files:

• Argument.java (modified) (2 diffs)
• ArgumentConfiguration.java (modified) (2 diffs)
• Classifier.java (modified) (3 diffs)
• CollectionConfiguration.java (modified) (1 diff)
• CollectionMeta.java (modified) (1 diff)
• DOMProxyListModel.java (modified) (1 diff)
• Index.java (modified) (1 diff)
• IndexManager.java (modified) (2 diffs)
• LanguageManager.java (modified) (1 diff)
• PlugIn.java (modified) (2 diffs)
• SearchTypeManager.java (modified) (1 diff)
• Subcollection.java (modified) (2 diffs)
• SubcollectionIndexManager.java (modified) (2 diffs)

trunk/gli/src/org/greenstone/gatherer/cdm/Argument.java

@@ -246 +246 @@
      * @see org.greenstone.gatherer.msm.ElementWrapper
      * @see org.greenstone.gatherer.msm.MetadataSetManager#getElement(String)
-     * @see org.greenstone.gatherer.msm.MSMUtils#getValue(Element)
+     * @see org.greenstone.gatherer.msm.MSMUtils#getValue(Node)
      */
     public String getValue() {
@@ -271 +271 @@
      * @see org.greenstone.gatherer.msm.ElementWrapper
      * @see org.greenstone.gatherer.msm.MetadataSetManager#getElement(String)
-     * @see org.greenstone.gatherer.msm.MSMUtils#getValue(Element)
+     * @see org.greenstone.gatherer.msm.MSMUtils#getValue(Node)
      */
     public ArrayList getValues() {

trunk/gli/src/org/greenstone/gatherer/cdm/ArgumentConfiguration.java

@@ -835 +835 @@
          * @param two A <strong>JButton</strong> whose enabled state is determined by the listener, or <i>null</i> if no button.
          * @param list A <strong>JList</strong> whose enabled state is determined by the listener, or <i>null</i> if no list.
-         * @param list A <strong>JComponent</strong> whose enabled state is determined by the listener, or <i>null</i> if no component.
+         * @param target A <strong>JComponent</strong> whose enabled state is determined by the listener, or <i>null</i> if no component.
          */
         public EnabledListener(JButton one, JButton two, JList list, JComponent target) {
@@ -943 +943 @@
         }
         /** Tests two possible ListOption objects for equality. Uses the result from compareTo().
-         * @param The <strong>Object</strong> which may be equal.
+         * @param object The <strong>Object</strong> which may be equal.
          * @return <i>true</i> if the objects are equal, <i>false</i> otherwise.
          */

trunk/gli/src/org/greenstone/gatherer/cdm/Classifier.java

@@ -133 +133 @@
     /** Constructor.
      * @param name The name of this classifier as a <strong>String</strong>.
-     * @param desc A description of this classifier as a <strong>String</strong>.
+     * @param description A description of this classifier as a <strong>String</strong>.
      * @param super_classifier The super class of this classifier, as a <strong>Classifier</strong>.
      */
@@ -167 +167 @@
     /** The assigned classifier constructor.
      * @param element the DOM Element this classifier is based upon
-     * @param base_classifier the Classifier from the stored library showing details about this classifier, may be null
      */
     public DOMProxyListEntry create(Element element) {
@@ -360 +359 @@
 
     /** Method to set the value of desc.
-     * @param desc The new value of desc as a <strong>String</strong>.
+     * @param description The new value of desc as a <strong>String</strong>.
      */
     public void setDescription(String description) {

trunk/gli/src/org/greenstone/gatherer/cdm/CollectionConfiguration.java

@@ -67 +67 @@
 
     /** Find the best insertion position for the given DOM Element. This should try to match command tag, and if found should then try to group by name or type (eg CollectionMeta), or append to end is no such grouping exists (eg PlugIns). Failing a command match it will check against the command order for the best insertion location.
-     * @param element the command Element to be inserted
+     * @param target_element the command Element to be inserted
      * @return the Element which the given command should be inserted before, or null to append to end of list
      */

trunk/gli/src/org/greenstone/gatherer/cdm/CollectionMeta.java

@@ -166 +166 @@
 
     /** Change the value of value. 
-     * @param value the new value as a String.
+     * @param raw_value the new value as a String.
      */
     public void setValue(String raw_value) {

trunk/gli/src/org/greenstone/gatherer/cdm/DOMProxyListModel.java

@@ -75 +75 @@
     /** Used to add an element into the underlying dom, and fire the appropriate repaint events.
      * @param index the index where the element should be inserted (relative of the other elements in this proxy list)
-     * @param element the Element to be inserted
+     * @param entry the <strong>DOMProxyListEntry</strong> to be inserted
      */
     public synchronized void add(int index, DOMProxyListEntry entry) {

trunk/gli/src/org/greenstone/gatherer/cdm/Index.java

@@ -244 +244 @@
 
     /** Method to set the level of this index which can only be used for the default index. 
-     * @param level the new level as an int
+     * @param new_level the new level as an int
      */
     public void setLevel(int new_level) {

trunk/gli/src/org/greenstone/gatherer/cdm/IndexManager.java

@@ -1391 +1391 @@
          * @param  event a DocumentEvent containing information about the text removed
          */
-        public void removeUpdate(DocumentEvent e) {
+        public void removeUpdate(DocumentEvent event) {
         validateAddButton();
         }
@@ -1453 +1453 @@
          * @param  event a DocumentEvent containing information about the text removed
          */
-        public void removeUpdate(DocumentEvent e) {
+        public void removeUpdate(DocumentEvent event) {
         validateAddButton();
         }

trunk/gli/src/org/greenstone/gatherer/cdm/LanguageManager.java

@@ -168 +168 @@
     /** Method to retrieve a certain language object by its code.
      * @param code The two letter code of a language, as a <strong>String</strong>.
-     * @param assigned_only If <i>true</i> only those languages currently having indexes built for them are checked, otherwise the known languages buffer is checked.
      * @return The <strong>Language</strong> that matches the given code, or <i>null</i> if no such language exists.
      */

trunk/gli/src/org/greenstone/gatherer/cdm/PlugIn.java

@@ -135 +135 @@
     /** The assigned plugin constructor.
      * @param element the DOM Element this plugin is based upon
-     * @param base_plugin the PlugIn from the stored library showing details about this plugin, may be null
      */
     public DOMProxyListEntry create(Element element) {
@@ -315 +314 @@
 
     /** Method to set the value of desc.
-     * @param desc The new value of desc as a <strong>String</strong>.
+     * @param description The new value of desc as a <strong>String</strong>.
      */
     public void setDescription(String description) {

trunk/gli/src/org/greenstone/gatherer/cdm/SearchTypeManager.java

@@ -443 +443 @@
          * @param  event a DocumentEvent containing information about the text removed
          */
-        public void removeUpdate(DocumentEvent e) {
+        public void removeUpdate(DocumentEvent event) {
         validateAddButton();
         }

trunk/gli/src/org/greenstone/gatherer/cdm/Subcollection.java

@@ -142 +142 @@
 
     /** Method to get the value of name.
-     * @param String The value of name as a <strong>String</string>.
+     * @return String The value of name as a <strong>String</string>.
      */
     public String getName() {
@@ -180 +180 @@
 
     /** Method to get the value of include.
-     * @param boolean true if this is an inclusion filter, false otherwise
+     * @return boolean true if this is an inclusion filter, false otherwise
      */
     public boolean isInclusive() {

trunk/gli/src/org/greenstone/gatherer/cdm/SubcollectionIndexManager.java

@@ -152 +152 @@
 
     /** Method to remove all of the subindexes that contain a certain subcollection.
-     * @param sub the Subcollection that has been removed
+     * @param subcollection the Subcollection that has been removed
      * @see org.greenstone.gatherer.cdm.Subcollection
      * @see org.greenstone.gatherer.cdm.SubcollectionIndex
@@ -170 +170 @@
 
     /** Method to set the default subcollection index.
-     * @param subcollection The <strong>Subcollection</strong> to use as the default index.
+     * @param index The <strong>SubcollectionIndex</strong> to use as the default index.
      * @see org.greenstone.gatherer.Gatherer
      * @see org.greenstone.gatherer.collection.CollectionManager
+     * @see org.greenstone.gatherer.cdm.SubcollectionIndex
      */
     public void setDefaultSubcollectionIndex(SubcollectionIndex index) {