diff --git a/source/org/thdl/tib/bibl/IDFactory.java b/source/org/thdl/tib/bibl/IDFactory.java index 326b102..16b1fa4 100644 --- a/source/org/thdl/tib/bibl/IDFactory.java +++ b/source/org/thdl/tib/bibl/IDFactory.java @@ -224,7 +224,7 @@ public class IDFactory extends GenericTibFactory implements TibConstants * set the text's number within the category but it leaves a last Tibid empty ready for that information. *

* - * @param String - the master ID string + * @param masterID String - masterID the master ID string * * @return String - the new file name based on the master ID */ diff --git a/source/org/thdl/tib/bibl/TextPane.java b/source/org/thdl/tib/bibl/TextPane.java index 7352d42..71b54ed 100644 --- a/source/org/thdl/tib/bibl/TextPane.java +++ b/source/org/thdl/tib/bibl/TextPane.java @@ -98,8 +98,8 @@ public class TextPane extends JTextPane implements TibConstants * this TextPane's document. *

* - * @param String[] - The array of text phrases to be added to the document - * @param String[] - The array of styles associated with the respective text phrases. + * @param phrases String[] - The array of text phrases to be added to the document + * @param styles String[] - The array of styles associated with the respective text phrases. */ public void setTextPane(String[] phrases, String[] styles) { @@ -193,9 +193,6 @@ public class TextPane extends JTextPane implements TibConstants * types of annotations. Green = addition; yellow = alternative reading or variant; * red = omission/deletion. *

- * - * @param JTextPane to which the new styles are added. - * */ protected void initStyles() { diff --git a/source/org/thdl/tib/bibl/TibDoc.java b/source/org/thdl/tib/bibl/TibDoc.java index 95c857e..04e0ed2 100644 --- a/source/org/thdl/tib/bibl/TibDoc.java +++ b/source/org/thdl/tib/bibl/TibDoc.java @@ -139,9 +139,9 @@ public class TibDoc extends XMLDoc * the editor's full name and his/her responsibility regarding the document. *

* - * @param String - the editor's (preferrably) three initials, such as snw or dfg. - * @param String - the editor's full name to be recorded in the metadata. - * @param String - the present date. + * @param initials String - the editor's (preferably) three initials, such as snw or dfg. + * @param fullName String - the editor's full name to be recorded in the metadata. + * @param today String - the present date. */ public void addEditor(String initials, String fullName, String today) { @@ -294,10 +294,10 @@ public class TibDoc extends XMLDoc * editor who is the source of this critical title. *

* - * @param org.jdom.Element - the Title element that is to serve as the basis of the critical title. This is + * @param el org.jdom.Element - the Title element that is to serve as the basis of the critical title. This is * the element that is cloned to create the critical version. * - * @param initials - the initials of the editor creating the critical title. + * @param initials String - the initials of the editor creating the critical title. */ public org.jdom.Element createCriticalTitle(org.jdom.Element el, String initials) { @@ -377,9 +377,9 @@ public class TibDoc extends XMLDoc * containing the English translation of it. *

* - * @param String - the Tibetan doxographical statement + * @param tibDox String - the Tibetan doxographical statement * - * @param String - the English doxographical statement. + * @param engDox String - the English doxographical statement. */ public void setDoxography(String tibDox, String engDox) { @@ -433,7 +433,7 @@ public class TibDoc extends XMLDoc * the nested Tibid mark-up. *

* - * @param String - the new ID string delimited by periods. + * @param idString String - the new ID string delimited by periods. */ public void setMasterID(String idString) { @@ -465,7 +465,7 @@ public class TibDoc extends XMLDoc * *

* - * @param org.jdom.Element - the title list's titledecl. + * @param tdecl org.jdom.Element - the title list's titledecl. * * @return String - the sigla of the edition that is the source for the title, derrived from the first titleitem element. */ @@ -487,8 +487,8 @@ public class TibDoc extends XMLDoc * its Lang=eng, and putting the text in its content. *

* - * @param String - the text of the translation - * @param org.jdom.Element - the Title element (lang=tib) that contains the title being translated. + * @param text String - the text of the translation + * @param el org.jdom.Element - the Title element (lang=tib) that contains the title being translated. */ public void addTranslation(String text, org.jdom.Element el) { @@ -525,9 +525,9 @@ public class TibDoc extends XMLDoc * *

* - * @param org.jdom.Element - the title element to be cloned. - * @param String - the sigla of the new title element. - * @param String - the pagination of the new title. + * @param elem org.jdom.Element - the title element to be cloned. + * @param sigla String - the sigla of the new title element. + * @param pagination String - the pagination of the new title. * * @return org.jdom.Element - the new edition title with corresp=sigla that is a sibling of the originally given title element. */ @@ -613,7 +613,7 @@ public class TibDoc extends XMLDoc * the Lem child (i.e., the main reading). *

* - * @param org.jdom.Element - the title whose text is desired. + * @param title org.jdom.Element - the title whose text is desired. * * @return String - the display text for that title element. */ @@ -632,9 +632,9 @@ public class TibDoc extends XMLDoc * and adds the app element. If all succeeds, the app element is then returned. *

* - * @param org.jdom.Element - the title in which the app is to be inserted. - * @param String - the text selected in the {@link TextPane} that indicates where the app is to be inserted. - * @param int - the offset from the beginning of the text's display title, where the insertion point is. + * @param title org.jdom.Element - the title in which the app is to be inserted. + * @param selText String - the text selected in the {@link TextPane} that indicates where the app is to be inserted. + * @param offset int - the offset from the beginning of the text's display title, where the insertion point is. * * @return org.jdom.Element - the app element that has been successfully inserted or null if unsuccessfull. */ @@ -699,7 +699,7 @@ System.out.println("TExt at title offset is: " + text); * This method removes an existing App element, replacing it with the text of its lemma or main reading child. *

* - * @param org.jdom.Element - the app to be removed. + * @param appToRemove org.jdom.Element - the app to be removed. */ public void removeApp(org.jdom.Element appToRemove) { @@ -766,7 +766,7 @@ System.out.println("TExt at title offset is: " + text); * is sent to this method, it returns an empty String. *

* - * @param String - the text to be cleaned. + * @param text String - the text to be cleaned. * * @return String - the clean text. */ @@ -796,7 +796,7 @@ System.out.println("TExt at title offset is: " + text); * back to an Element. This method returns a fixed array of Elements that do not require such casting. *

* - * @param java.util.List - the list of content or children of an element. + * @param childs java.util.List - the list of content or children of an element. * * @return org.jdom.Element[] - the array of element children derrived from the list. */ @@ -816,8 +816,8 @@ System.out.println("TExt at title offset is: " + text); * element with the first child being this lem element and one empty rdg (reading) element for non-main-readings. *

* -* @param String - the sigla of the lemma's witness. -* @param String - the text of the lemma's reading. +* @param mainWit String - the sigla of the lemma's witness. +* @param lemma String - the text of the lemma's reading. * * @return org.jdom.Element - the app element created. */ @@ -856,7 +856,7 @@ System.out.println("TExt at title offset is: " + text); * TibDoc has a single constructor that takes a root element for the document. *

* -* @param org.jdom.Element - the new TibDoc's root element. +* @param rootElement org.jdom.Element - the new TibDoc's root element. */ public TibDoc(org.jdom.Element rootElement) { diff --git a/source/org/thdl/tib/bibl/TibFrame.java b/source/org/thdl/tib/bibl/TibFrame.java index 4ef2a13..10a1e49 100644 --- a/source/org/thdl/tib/bibl/TibFrame.java +++ b/source/org/thdl/tib/bibl/TibFrame.java @@ -291,7 +291,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants * instantiation of the main {@link TiblEdit} program. *

* - * @param TiblEdit - the controller of the program. + * @param jt TiblEdit - the controller of the program. */ public void setController (TiblEdit jt) { @@ -315,7 +315,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants * This method sets the list of recent files in the file menu. *

* - * @param recent - A Vector of the recent files from the controller. + * @param recent Vector - A Vector of the recent files from the controller. */ public void setRecentFiles(Vector recent) { @@ -554,7 +554,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants * JPanel} that has a table with an apparatus' info and control buttons. *

* - * @param TibTable the TibTable object that contains the tabular information to be displayed. + * @param tt TibTable - the TibTable object that contains the tabular information to be displayed. */ public void showTable(TibTable tt) { @@ -613,7 +613,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants * can find the associated element and make the appropriate options available. *

* - * @param TitleFactory - The TibDocs TitleFactory object for retrieving title information + * @param tf TitleFactory - The TibDocs TitleFactory object for retrieving title information * * @return ElementList - The ElementList returned by the TextPane once its document is set. * @@ -747,7 +747,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants * index in the vector. *

* - * @param org.jdom.Element - the selected element. + * @param el org.jdom.Element - the selected element. * * @return int - that element's index in the ElementStyle Vector. */ @@ -784,7 +784,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants * This constructor simply takes a title as the corresponding JFrame contructor. *

* - * @param String - the frame's title. + * @param title String - the frame's title. */ public TibFrame(String title) { @@ -821,7 +821,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants * menu item. If not, that item is turned off. *

* - * @param CaretEvent - the required parameter of this abstract method. It is not used here. + * @param ce CaretEvent - the required parameter of this abstract method. It is not used here. */ public void caretUpdate(CaretEvent ce) { @@ -859,7 +859,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants /** See class comment. * - * @param WindowEvent - the required parameter for this abstract method. + * @param e WindowEvent - the required parameter for this abstract method. */ public void windowClosing(WindowEvent e) { diff --git a/source/org/thdl/tib/bibl/TiblEdit.java b/source/org/thdl/tib/bibl/TiblEdit.java index f9fd0c3..45de5e5 100644 --- a/source/org/thdl/tib/bibl/TiblEdit.java +++ b/source/org/thdl/tib/bibl/TiblEdit.java @@ -392,8 +392,6 @@ System.out.println("in getEditorINfo!"); * the variables {@link #editorsName} and {@link #editorsInitials} are set. *

* - * @param tdia - the {@link TibDialog} which has gathered the information. - * */ public void setEditor() { @@ -492,7 +490,7 @@ System.out.println("EdInits given: " + editorsInitials); * Sets the current directory to the given path. *

* - * @param A File object that represents the path of the current directory. + * @param cd A File object that represents the path of the current directory. */ public void setCurrentDirectory(File cd) { @@ -533,7 +531,7 @@ System.out.println("EdInits given: " + editorsInitials); * *

* - * @param int m - the value that sets the mode as above. + * @param m int - the value that sets the mode as above. */ public void setMode(int m) { @@ -583,7 +581,7 @@ System.out.println("EdInits given: " + editorsInitials); * Sets the {@link #selected_element} variable to the presently selected element. *

* - * @param org.jdom.Element - the selected element. + * @param e org.jdom.Element - the selected element. */ public void setSelectedElement(org.jdom.Element e) { @@ -663,7 +661,7 @@ System.out.println("EdInits given: " + editorsInitials); * when the Master ID is set so that the name of the file reflects the master ID. *

* - * @param String - the Master ID string that serves as the base of the file name + * @param masterID String - the Master ID string that serves as the base of the file name * * */ @@ -709,9 +707,9 @@ System.out.println("EdInits given: " + editorsInitials); * the end of the name until a unique name is arrived at. *

* -* @param File outDirectory - this is the directory to which processed files are written. +* @param outDirectory File - this is the directory to which processed files are written. * -* @param String masterName - the is the master name for the file, e.g. Ng3.1.5.gsang_ba_'dus +* @param masterName String - the is the master name for the file, e.g. Ng3.1.5.gsang_ba_'dus * * @return File - the uniquely named file created by combining the two above and checking for conflicts. */ @@ -770,7 +768,7 @@ System.out.println("EdInits given: " + editorsInitials); * to the {@link TibFrame} using its {@link TibFrame#fileOpened} method. *

* - * @param File the file to be opened, sent by the file chooser. + * @param file File the file to be opened, sent by the file chooser. */ public void openFile(File file) @@ -806,7 +804,7 @@ System.out.println("EdInits given: " + editorsInitials); * If it is not, then it adds it to the list. *

* - * @param File - the file to be added to the recent list. + * @param newFile File - the file to be added to the recent list. * */ public void addToRecent(File newFile) @@ -901,7 +899,7 @@ System.out.println("EdInits given: " + editorsInitials); * from the {@link #saveAs} method. *

* - * @param File - the file to be saved + * @param outFile File - the file to be saved */ public void save(File outFile) { @@ -939,7 +937,7 @@ System.out.println("EdInits given: " + editorsInitials); * the overwrite option is chosen, or it is cancelled. *

* - * @param File - the file + * @param outFile File - the file * * @return boolean - whether the save operation was successful. */ @@ -1074,7 +1072,7 @@ System.out.println("EdInits given: " + editorsInitials); * to display a place to enter the new title. *

* - * @param TibDialog - The TibDialog with the information of the new title's sigla and pagination. + * @param tdia TibDialog - The TibDialog with the information of the new title's sigla and pagination. */ public void insertNewEdTitle(TibDialog tdia) { @@ -1104,7 +1102,7 @@ System.out.println("EdInits given: " + editorsInitials); * This displays an entry place for the new title in the {@link TextPane}. *

* - * @param TibDialog - the TibDialog with the information concerning the new edition. + * @param tdia TibDialog - the TibDialog with the information concerning the new edition. */ public void insertNewEdAndTitle(TibDialog tdia) { @@ -1373,12 +1371,12 @@ System.out.println("EdInits given: " + editorsInitials); /** *

* This method inserts a particular type of discussion depending on the setting of the - * type parameter. When type equals {@link TibConstants#TITLE TITLE}, a discussion will be inserted + * type parameter (FIXME: this routine no longer takes this parameter). When type equals {@link TibConstants#TITLE TITLE}, a discussion will be inserted * for the title at the cursor position of the {@link TextPane}. When type equals {@link TibConstants#GEN GEN} * the user will be prompted with a list of options to choose from. *

* - * @param type - the string indicating which typeof discussion to insert. + * The parameter type is the string indicating which typeof discussion to insert. */ public void insertDiscussion() { @@ -1849,7 +1847,7 @@ System.out.println("EdInits given: " + editorsInitials); * to {@link TibDoc#setMasterID(String) setMasterID}. *

* - * @param DoxWindow - the doxography selection window that supplies the users input. + * @param dw DoxWindow - the doxography selection window that supplies the users input. */ public void enterDox(DoxWindow dw) { @@ -1870,7 +1868,7 @@ System.out.println("EdInits given: " + editorsInitials); * The latter spec is converted to an integer. *

* - * @param String[] - the specifications for the confirm dialog. + * @param specs String[] - the specifications for the confirm dialog. */ public void doMessage(String[] specs) @@ -1901,7 +1899,7 @@ System.out.println("EdInits given: " + editorsInitials); * * The latter spec is converted to an integer. * - * @param String[] specs - the specifications for the confirm dialog. + * @param specs String[] - the specifications for the confirm dialog. * * @return int - the response *

@@ -2071,7 +2069,7 @@ System.out.println("EdInits given: " + editorsInitials); * The latter spec is converted to an integer. It returns the String * that was inputed. *

- * @param String[] - the specifications for the input dialog + * @param specs String[] - the specifications for the input dialog * * @return String - the string entered by the user. * @@ -2086,7 +2084,7 @@ System.out.println("EdInits given: " + editorsInitials); * A public static method that converts a Vector into an array of Strings. *

* - * @param Vector The vector to be converted. + * @param v Vector The vector to be converted. * * @return String[] The resulting array of Strings. */ @@ -2104,7 +2102,7 @@ System.out.println("EdInits given: " + editorsInitials); * A public static method that converts an Object array into an array of Strings. *

* - * @param Object[] The object array to be converted. + * @param objs Object[] The object array to be converted. * * @return String[] The resulting array of Strings. */ @@ -2124,7 +2122,7 @@ System.out.println("EdInits given: " + editorsInitials); * This is a public, static method that can be called from anywhere with this classes prefix. *

* - * @param org.jdom.Element The element to be turned into a string. + * @param e org.jdom.Element The element to be turned into a string. * * @return String The resulting string version of the element. */ @@ -2197,7 +2195,7 @@ System.out.println("EdInits given: " + editorsInitials); * {@link #showApp}. *

* - * @param MouseEvent - the required parameter for this abstract method. + * @param me MouseEvent - the required parameter for this abstract method. */ public void mouseClicked(MouseEvent me) { @@ -2255,7 +2253,7 @@ System.out.println("EdInits given: " + editorsInitials); * If the mode is {@link #NEW_TITLE}, it calls {@link #insertNewTitleAndTranslation}. *

* - * @param KeyEvent - the required parameter for this abstract method. + * @param ke KeyEvent - the required parameter for this abstract method. */ public void keyPressed(KeyEvent ke) { if(ke.getKeyCode() == KeyEvent.VK_ENTER) { diff --git a/source/org/thdl/tib/text/DuffData.java b/source/org/thdl/tib/text/DuffData.java index 7f70c9f..7f22334 100644 --- a/source/org/thdl/tib/text/DuffData.java +++ b/source/org/thdl/tib/text/DuffData.java @@ -82,7 +82,7 @@ public class DuffData { } /** Changes the text and font this DuffData represents. -* @param c a String of TibetanMachineWeb or TibetanMachine text +* @param s a String of TibetanMachineWeb or TibetanMachine text * @param i a TibetanMachineWeb or TibetanMachine font number */ public void setData(String s, int i) { diff --git a/source/org/thdl/tib/text/TibetanKeyboard.java b/source/org/thdl/tib/text/TibetanKeyboard.java index fc6ca61..9d4b871 100644 --- a/source/org/thdl/tib/text/TibetanKeyboard.java +++ b/source/org/thdl/tib/text/TibetanKeyboard.java @@ -332,7 +332,7 @@ public class TibetanKeyboard { * parameter, assuming it is in fact a character * in this keyboard; if not, returns null. * -* @param the possible character +* @param s the possible character */ public String getWylieForChar(String s) { if (!charMap.containsKey(s)) @@ -391,7 +391,7 @@ public class TibetanKeyboard { * parameter, assuming it is in fact a vowel * in this keyboard; if not, returns null. * -* @param the possible vowel +* @param s the possible vowel */ public String getWylieForVowel(String s) { if (!vowelMap.containsKey(s)) diff --git a/source/org/thdl/tib/text/TibetanMachineWeb.java b/source/org/thdl/tib/text/TibetanMachineWeb.java index 0e9b88b..f705984 100644 --- a/source/org/thdl/tib/text/TibetanMachineWeb.java +++ b/source/org/thdl/tib/text/TibetanMachineWeb.java @@ -1622,7 +1622,7 @@ public static String getAVowel() { /** * Returns true iff this glyph is a top (superscript) vowel. -* @param a DuffCode representing a TibetanMachineWeb glyph +* @param dc a DuffCode representing a TibetanMachineWeb glyph * @return true if the glyph is a top-hanging (superscript) vowel (i, * u, e, o, ai, or ao) and false if not */ public static boolean isTopVowel(DuffCode dc) { diff --git a/source/org/thdl/util/SimpleFrame.java b/source/org/thdl/util/SimpleFrame.java index 6e7715a..aee7f97 100644 --- a/source/org/thdl/util/SimpleFrame.java +++ b/source/org/thdl/util/SimpleFrame.java @@ -32,7 +32,7 @@ public class SimpleFrame extends JFrame { * component comp. * * @param frameTitle the title (on the title bar) of the window - * @param rtfPane the */ + * @param comp the component to be placed within this frame */ public SimpleFrame(String frameTitle, final Component comp) { super(frameTitle); diff --git a/source/org/thdl/util/javaxdelta/Primes.java b/source/org/thdl/util/javaxdelta/Primes.java index 381638f..5aa773a 100644 --- a/source/org/thdl/util/javaxdelta/Primes.java +++ b/source/org/thdl/util/javaxdelta/Primes.java @@ -95,7 +95,7 @@ public class Primes } // end above /** - * @param return first prime less than candidate + * @return first prime less than candidate */ public int below (int candidate) { @@ -110,7 +110,7 @@ public class Primes /** * calc all primes in the range 1..n, * not the first n primes. - * @param n, highest candidate, not necessarily prime. + * @param n highest candidate, not necessarily prime. * @return list of primes 1..n in an array */ public final int[] getPrimes(int n)