From aa144dd599737cd8479dcc73c6ce36da35838721 Mon Sep 17 00:00:00 2001 From: dchandler Date: Mon, 3 Feb 2003 01:36:56 +0000 Subject: [PATCH] Javadoc 1.4.1_01 no longer has a single warning about this package. --- source/org/thdl/tib/bibl/DiacriticPanel.java | 2 +- source/org/thdl/tib/bibl/EditAction.java | 8 ++--- source/org/thdl/tib/bibl/ElementList.java | 8 ++--- source/org/thdl/tib/bibl/ElementStyle.java | 2 +- source/org/thdl/tib/bibl/IDFactory.java | 2 +- source/org/thdl/tib/bibl/InsertAction.java | 10 +++--- source/org/thdl/tib/bibl/TTFileView.java | 2 +- source/org/thdl/tib/bibl/TextPane.java | 2 +- source/org/thdl/tib/bibl/TibDoc.java | 4 +-- source/org/thdl/tib/bibl/TibFrame.java | 20 ++++++----- source/org/thdl/tib/bibl/TiblEdit.java | 36 ++++++++++---------- source/org/thdl/tib/bibl/ViewAction.java | 6 ++-- source/org/thdl/tib/bibl/package.html | 24 +++++++++++++ 13 files changed, 76 insertions(+), 50 deletions(-) create mode 100644 source/org/thdl/tib/bibl/package.html diff --git a/source/org/thdl/tib/bibl/DiacriticPanel.java b/source/org/thdl/tib/bibl/DiacriticPanel.java index a9e545f..c0508c2 100644 --- a/source/org/thdl/tib/bibl/DiacriticPanel.java +++ b/source/org/thdl/tib/bibl/DiacriticPanel.java @@ -102,7 +102,7 @@ public class DiacriticPanel extends JPanel implements TibConstants /** * This method takes a character, which is actually a String variable and creates a label * with a border and a margin with the supplied character string as the - * centered text. Adds a MouseListener that is a {@link #TiblEditMouseAdapter}. It is called by the {@link #init} method. + * centered text. Adds a MouseListener that is a {@link DiacriticPanel.TiblEditMouseAdapter}. It is called by the {@link #init} method. * * @param ch - A string variable that is the character associated with this label/button. * diff --git a/source/org/thdl/tib/bibl/EditAction.java b/source/org/thdl/tib/bibl/EditAction.java index 0531395..2fcc5ae 100644 --- a/source/org/thdl/tib/bibl/EditAction.java +++ b/source/org/thdl/tib/bibl/EditAction.java @@ -26,10 +26,10 @@ import java.awt.event.ActionEvent; * super constructor. The action performed takes the following action commands: *

* * * @author Than Garson, Tibetan and Himalayan Digital Library diff --git a/source/org/thdl/tib/bibl/ElementList.java b/source/org/thdl/tib/bibl/ElementList.java index 99b973d..eb58200 100644 --- a/source/org/thdl/tib/bibl/ElementList.java +++ b/source/org/thdl/tib/bibl/ElementList.java @@ -23,11 +23,11 @@ import org.jdom.*; /** *

-* Element List is a list of elements and ranges. The ranges refer to the {@link TextPanel} locations -* where the text for that element is found. The {@link #getElement} method takes an integer location -* in the TextPanel and returns the org.jdom.Element that is associated with that location +* Element List is a list of elements and ranges. The ranges refer to the {@link TextPane} locations +* where the text for that element is found. The {@link #getElementAt(int)} method takes an integer location +* in the TextPane and returns the org.jdom.Element that is associated with that location * if there is one! If not, it returns null, indicating there is nothing to edit at -* that location. This is created by the TextPanel and given to the {@link TiblEdit} controller so +* that location. This is created by the TextPane and given to the {@link TiblEdit} controller so * it can turn on and off menu options and functionality, depending on the position of the cursor in * the TextPane. *

diff --git a/source/org/thdl/tib/bibl/ElementStyle.java b/source/org/thdl/tib/bibl/ElementStyle.java index ee41252..dabbcb3 100644 --- a/source/org/thdl/tib/bibl/ElementStyle.java +++ b/source/org/thdl/tib/bibl/ElementStyle.java @@ -21,7 +21,7 @@ package org.thdl.tib.bibl; import org.jdom.*; /** -* This wrapper class associates a String of text with a Style (as defined in {@link TibConstants}?) and a particular +* This wrapper class associates a String of text with a Style (as defined in {@link TibConstants} [MAYBE]) and a particular * element. It is used for interactivity with the {@link TextPane} so that highlighting or clicking on a string in the * text pane can be associated with actions for processing the text within an element. * diff --git a/source/org/thdl/tib/bibl/IDFactory.java b/source/org/thdl/tib/bibl/IDFactory.java index da3efc7..326b102 100644 --- a/source/org/thdl/tib/bibl/IDFactory.java +++ b/source/org/thdl/tib/bibl/IDFactory.java @@ -226,7 +226,7 @@ public class IDFactory extends GenericTibFactory implements TibConstants * * @param String - the master ID string * - * @Return String - the new file name based on the master ID + * @return String - the new file name based on the master ID */ public void setMasterID(String masterID) { diff --git a/source/org/thdl/tib/bibl/InsertAction.java b/source/org/thdl/tib/bibl/InsertAction.java index 916ec75..037a541 100644 --- a/source/org/thdl/tib/bibl/InsertAction.java +++ b/source/org/thdl/tib/bibl/InsertAction.java @@ -26,11 +26,11 @@ import java.awt.event.ActionEvent; * super constructor. The action performed takes the following action commands: *

* * * @author Than Garson, Tibetan and Himalayan Digital Library diff --git a/source/org/thdl/tib/bibl/TTFileView.java b/source/org/thdl/tib/bibl/TTFileView.java index b814b09..14ef9cc 100644 --- a/source/org/thdl/tib/bibl/TTFileView.java +++ b/source/org/thdl/tib/bibl/TTFileView.java @@ -48,7 +48,7 @@ public class TTFileView extends FileView implements TibConstants /** *

- * Overrides the ancestor's--{@link javax.swing.JFileChooser.FileView}--getName() function + * Overrides the ancestor's--{@link FileView}--getName() function * so that it returns the text title as the name, if it is an XML file. This has the * effect of presenting a list of text names in the open dialog rather than their less * comprehensible file names. diff --git a/source/org/thdl/tib/bibl/TextPane.java b/source/org/thdl/tib/bibl/TextPane.java index 0353ae0..7352d42 100644 --- a/source/org/thdl/tib/bibl/TextPane.java +++ b/source/org/thdl/tib/bibl/TextPane.java @@ -65,7 +65,7 @@ public class TextPane extends JTextPane implements TibConstants /** *

- * This and the following are static, style constants, i.e. names of the styles + * This and the following are static, style constants. I.e., they're names of the styles. *

*/ public static String REG = "regular"; diff --git a/source/org/thdl/tib/bibl/TibDoc.java b/source/org/thdl/tib/bibl/TibDoc.java index 8b9a119..95c857e 100644 --- a/source/org/thdl/tib/bibl/TibDoc.java +++ b/source/org/thdl/tib/bibl/TibDoc.java @@ -58,7 +58,7 @@ public class TibDoc extends XMLDoc private TitleFactory tf; /** *

- * The {@link IDFactory} associated with this Tibbibl XML document + * The {@link IDFactory} associated with this Tibbibl XML document. *

*/ private IDFactory idf; @@ -202,7 +202,7 @@ public class TibDoc extends XMLDoc /** *

- * This method returns an array of strings that contains 1. the opening string of the header, such as + * This method returns an array of strings. The array contains 1. the opening string of the header, such as * "Bibliographic Record for", and 2. the text contain within each of its children elements, usually * there are two of these a lang="tib" and a lang="eng", each one entered separately. The strings * are stripped of extraneous paragraph markers and spaces using the {@link #cleanString} method. diff --git a/source/org/thdl/tib/bibl/TibFrame.java b/source/org/thdl/tib/bibl/TibFrame.java index ab03b4f..4ef2a13 100644 --- a/source/org/thdl/tib/bibl/TibFrame.java +++ b/source/org/thdl/tib/bibl/TibFrame.java @@ -312,7 +312,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants /** *

- * This method sets the list of recent files in the file menu + * This method sets the list of recent files in the file menu. *

* * @param recent - A Vector of the recent files from the controller. @@ -442,7 +442,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants /** *

- * This method is called (maybe?) when the cursor is on a title. It enables the add + * This method is called (maybe) when the cursor is on a title. It enables the add * critical title menu option. (May be deprecated?) *

*/ @@ -453,7 +453,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants /** *

- * This method is called (maybe?) when cursor is on something other than a title. It disnables the add + * This method is called (maybe) when cursor is on something other than a title. It disables the add * critical title menu option. (May be deprecated?) *

*/ @@ -466,7 +466,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants *

* This method displays a {@link TibTable} as the bottom half of a split screen with the {@link TextPane} * This particular table displays the editions consulted for the formation of the master record - * by displaying the information in the text's tibiddecl element. To do so it uses {@link TibTable(IDFactory) TibTable constructor} + * by displaying the information in the text's tibiddecl element. To do so it uses {@link TibTable#TibTable(IDFactory) TibTable constructor} * that takes an {@link IDFactory} retrieved from the {@link TibDoc}. It then calls {@link #showTable(TibTable) TibTable} * method. *

@@ -504,7 +504,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants /** *

- * This method creates a split screen with a {@link DiacriticPanel(TibFrame) DiacriticPanel} + * This method creates a split screen with a {@link DiacriticPanel#DiacriticPanel(TibFrame) DiacriticPanel} * on the left and the main {@link TextPane} on the right. *

*/ @@ -741,7 +741,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants /** *

* This method is used by {@link #showTitles(TitleFactory)} to insert prompts for information - * at the correct location. The showTitles method creates a vector of {@link ElementStyles}. Once + * at the correct location. The showTitles method creates a vector of {@link ElementStyle}. Once * this is created, if the {@link TiblEdit#mode} is to insert a title or translation. This method * is called with the selected element. It searches the vector for that element and returns its * index in the vector. @@ -850,15 +850,17 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants /** *

* When the TibFrame is closed, the program ends. The window is disposed. The controller's - * {@link TiblEdit#writePrefs() writePrefs()} method is called, and the system is exited. + * {@link TiblEdit#exit() exit()} method is called, and the system is exited. *

- * - * @param WindowEvent - the required parameter for this abstract method. */ public class XWindowHandler extends WindowAdapter implements TibConstants { + /** See class comment. + * + * @param WindowEvent - the required parameter for this abstract method. + */ public void windowClosing(WindowEvent e) { e.getWindow().dispose(); diff --git a/source/org/thdl/tib/bibl/TiblEdit.java b/source/org/thdl/tib/bibl/TiblEdit.java index 593be2e..f9fd0c3 100644 --- a/source/org/thdl/tib/bibl/TiblEdit.java +++ b/source/org/thdl/tib/bibl/TiblEdit.java @@ -112,7 +112,7 @@ public class TiblEdit implements MouseListener, KeyListener, Observer, TibConsta /** *

- * This is the name of the file which is changed when the master ID is changes + * This is the name of the file which is changed when the master ID is changes. *

*/ String fileName; @@ -146,7 +146,7 @@ public class TiblEdit implements MouseListener, KeyListener, Observer, TibConsta private String todaysDate; /** *

-* This is the file chooser object that will be modified in {@link #setFileChoose} so +* This is the file chooser object that will be modified in {@link #setFileChooser} so * that it displays the text names instead of the file names when opening a file. *

*/ @@ -220,7 +220,7 @@ public class TiblEdit implements MouseListener, KeyListener, Observer, TibConsta /** *

-* This variable tells whether a text has been saved or not +* This variable tells whether a text has been saved or not. *

*/ boolean hasBeenSaved; @@ -246,9 +246,9 @@ public class TiblEdit implements MouseListener, KeyListener, Observer, TibConsta /** *

* The init method sets the {@link #dataDirectory}, {@link #currentDirectory}, - * and the {@link tibFrame} variables. It reads in preferences from {@link #readPrefData}, + * and the {@link #tibFrame} variables. It reads in preferences from {@link #readPrefData}, * performs {@link #setDate} and {@link #setFileChooser}, and sets the {@link #mode} - * to {@link TibConstants@NORM}. + * to {@link TibConstants#NORM}. *

*/ public void init() @@ -312,7 +312,7 @@ public class TiblEdit implements MouseListener, KeyListener, Observer, TibConsta * This reads in the preferences from the preference file that is located in * {@link TibConstants#DEFAULT_DIRECTORY} + {@link TibConstants#BIN} + * {@link TibConstants#PREFS}. The main preferences that are stored in this file - * are: the {@link editorsInitials} and {@link editorsName}. + * are: the {@link #editorsInitials} and {@link #editorsName}. *

*/ public void readPrefData() @@ -547,7 +547,7 @@ System.out.println("EdInits given: " + editorsInitials); * * @return int - the current display mode * - * @see setMode + * @see #setMode */ public int getMode() { @@ -616,7 +616,7 @@ System.out.println("EdInits given: " + editorsInitials); /** *

- * Returns the editors name + * Returns the editors name. *

* * @return String - the editor's name. @@ -1046,7 +1046,7 @@ System.out.println("EdInits given: " + editorsInitials); * critically edited. They represent titles as they appear in particular editions. * One choses a particular edition title as the basis for a critical title which * then can have app elements collating the various readings. This method uses - * a {@link TibDialog} with {@link TibConstants@NEW_ED_TITLE_INFO} and + * a {@link TibDialog} with {@link TibConstants#NEW_ED_TITLE_INFO} and * {@link TibConstants#NEW_ED_TITLE_INFO_SPECS} to get the title and its pagination. * When the TibDialog is submitted, the {@link #insertNewEdTitle} method * is called with that TibDialog. @@ -1122,7 +1122,7 @@ System.out.println("EdInits given: " + editorsInitials); *

* This method is called when one either double clicks on a title or chooses enter a translation * from the menu. It first determines if the selected element is the normalized title, in which case - * it sets the {@link #mode} to {@link TibConstants.ENTER_NORMALIZED ENTER_NORMALIZED} and redisplays with the appropriate prompts. + * it sets the {@link #mode} to {@link TibConstants#ENTER_NORMALIZED ENTER_NORMALIZED} and redisplays with the appropriate prompts. * Otherwise, it makes sure there is a Tibetan title there and not "No title given" or "Not specified" and * if it's a valid title, asks the user if they want to create a critical title with the selected title * as its base. If so, it redisplays with the appropriate prompts. @@ -1202,7 +1202,7 @@ System.out.println("EdInits given: " + editorsInitials); * prompt to the next paragraph mark "/n", and then calls the {@link TibDoc#addTranslation} * method with this translation String and the {@link #selected_element}. * The display mode ({@link #mode}) is then set to {@link TibConstants#NORM} and - * the text is redisplayed using {@link TibFrame@showTitles} which returns + * the text is redisplayed using {@link TibFrame#showTitles} which returns * an {@link ElementList} that is assigned to {@link #elemList}. *

*/ @@ -1373,8 +1373,8 @@ 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 - * for the title at the cursor position of the {@link TextPane}. When type equals {@link TibConstants.GEN GEN} + * type 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. *

* @@ -1435,7 +1435,7 @@ System.out.println("EdInits given: " + editorsInitials); *
  • Key: {@link TibConstants#TABLE} -- the {@link TibTable.TibTableModel} that contains the data. *
  • Key: {@link TibConstants#PAGIN} -- the hashtable of paginations keyed on edition sigla, used to create table * - * First, it sets the information for the main reading found in the {@link TibConstants#LEM} or lemma element. + * First, it sets the information for the main reading found in the {@link TibConstants#LM} or lemma element. * Then, it correlates the reading witnesses already in the app element with the siglas * for the lines of data in the table and replaces the information in existing reading elements * or adds new ones where necessary. @@ -1846,7 +1846,7 @@ System.out.println("EdInits given: " + editorsInitials); *

    * This method is invoked when the {@link DoxWindow} is submitted. It calls upon the * {@link TibDoc} to {@link TibDoc#setDoxography(String, String) setDoxography} and then - * to {@link TibDox#setMasterID(String) setMasterID}. + * to {@link TibDoc#setMasterID(String) setMasterID}. *

    * * @param DoxWindow - the doxography selection window that supplies the users input. @@ -2194,7 +2194,7 @@ System.out.println("EdInits given: " + editorsInitials); * and there is an {@link ElementList} defined to check. It checks the {@link #elemList} * for the selected element, if it is a {@link TibConstants#TITLE}, then it calls * {@link #enterTranslation}. If it is an {@link TibConstants#AP}, then it calls - * {@link #showAp}. + * {@link #showApp}. *

    * * @param MouseEvent - the required parameter for this abstract method. @@ -2251,8 +2251,8 @@ System.out.println("EdInits given: " + editorsInitials); * This implementation of the KeyListener interface is used when information * is being added directly to the {@link TextPane} being displayed. If the * Enter key is pressed, the it checks the {@link #mode}. If the mode is - * {@link TibConstants#ENTER_TRANS}, then it calls {@link insertTranslation}. - * If the mode is {@link NEW_TITLE}, it calls {@link insertNewTitleAndTranslation}. + * {@link TibConstants#ENTER_TRANS}, then it calls {@link #insertTranslation}. + * If the mode is {@link #NEW_TITLE}, it calls {@link #insertNewTitleAndTranslation}. *

    * * @param KeyEvent - the required parameter for this abstract method. diff --git a/source/org/thdl/tib/bibl/ViewAction.java b/source/org/thdl/tib/bibl/ViewAction.java index b964c5e..5fbb663 100644 --- a/source/org/thdl/tib/bibl/ViewAction.java +++ b/source/org/thdl/tib/bibl/ViewAction.java @@ -26,9 +26,9 @@ import java.awt.event.ActionEvent; * super constructor. The action performed takes the following action commands: *

    * * * @author Than Garson, Tibetan and Himalayan Digital Library diff --git a/source/org/thdl/tib/bibl/package.html b/source/org/thdl/tib/bibl/package.html new file mode 100644 index 0000000..b26ca25 --- /dev/null +++ b/source/org/thdl/tib/bibl/package.html @@ -0,0 +1,24 @@ + + + + + + +Provides classes and methods for the Tibbibl application. +

    +Tibbibl is for editing scholarly bibliographies of Tibetan texts, +where the bibliographies are stored as XML instances. +

    + +