Fixed Javadocs.

This commit is contained in:
dchandler 2003-09-10 01:19:05 +00:00
parent cc853be387
commit 16817d0b8e
9 changed files with 24 additions and 22 deletions

View file

@ -174,7 +174,7 @@ public class TibetanDocument extends DefaultStyledDocument {
* @param s the string you want to insert * @param s the string you want to insert
* @param color the color in which to insert, which is used if and only * @param color the color in which to insert, which is used if and only
* if {@link #colorsEnabled() colors are enabled} * if {@link #colorsEnabled() colors are enabled}
* @see #setRomanAttributeSet(AttributeSet) * @see #setRomanAttributeSet(MutableAttributeSet)
*/ */
public void appendRoman(int offset, String s, Color color) throws BadLocationException { public void appendRoman(int offset, String s, Color color) throws BadLocationException {
ThdlDebug.verify(getRomanAttributeSet() != null); ThdlDebug.verify(getRomanAttributeSet() != null);
@ -189,7 +189,7 @@ public class TibetanDocument extends DefaultStyledDocument {
* @param s the string you want to insert * @param s the string you want to insert
* @param color the color in which to insert, which is used if and only * @param color the color in which to insert, which is used if and only
* if {@link #colorsEnabled() colors are enabled} * if {@link #colorsEnabled() colors are enabled}
* @see #setRomanAttributeSet(AttributeSet) * @see #setRomanAttributeSet(MutableAttributeSet)
*/ */
public void appendRoman(String s, Color color) { public void appendRoman(String s, Color color) {
try { try {
@ -200,15 +200,16 @@ public class TibetanDocument extends DefaultStyledDocument {
} }
private void appendDuff(int fontSize, int offset, String s, MutableAttributeSet attr, Color color) { private void appendDuff(int fontSize, int offset, String s, MutableAttributeSet attr, Color color) {
try { try {
StyleConstants.setFontSize(attr, fontSize); StyleConstants.setFontSize(attr, fontSize);
if (allowColors) StyleConstants.setForeground(attr, color); if (allowColors)
insertString(offset, s, attr); StyleConstants.setForeground(attr, color);
} insertString(offset, s, attr);
catch (BadLocationException ble) { }
catch (BadLocationException ble) {
ThdlDebug.noteIffyCode(); ThdlDebug.noteIffyCode();
} }
} }
/** /**
* Inserts a stretch of TibetanMachineWeb data into the document. * Inserts a stretch of TibetanMachineWeb data into the document.
@ -374,7 +375,7 @@ public class TibetanDocument extends DefaultStyledDocument {
* conversion stops at the first non-Tibetan font. * conversion stops at the first non-Tibetan font.
* @param begin the beginning of the region to convert * @param begin the beginning of the region to convert
* @param end the end of the region to convert * @param end the end of the region to convert
* @param noSuchWylie an array which will not be touched if this is * @param noSuchACIP an array which will not be touched if this is
* successful; however, if there is no ACIP corresponding to one of * successful; however, if there is no ACIP corresponding to one of
* these glyphs, then noSuchACIP[0] will be set to true * these glyphs, then noSuchACIP[0] will be set to true
* @return the string of ACIP corresponding to this document */ * @return the string of ACIP corresponding to this document */

View file

@ -1163,7 +1163,7 @@ public static String getWylieForVowel(String s) {
/** /**
* Gets the DuffCode required for a vowel, if affixed to the given * Gets the DuffCode required for a vowel, if affixed to the given
* hashKey. Not as pretty as {@link * hashKey. Not as pretty as {@link
* TibTextUtils#getVowel(DuffCode,DuffCode,String)}. * TibTextUtils#getVowel(List,DuffCode,DuffCode,String)}.
* @param hashKey the key for the character the vowel is to be affixed * @param hashKey the key for the character the vowel is to be affixed
* to; see {@link #getGlyph(String)} to learn about hash keys. * to; see {@link #getGlyph(String)} to learn about hash keys.
* @param vowel the vowel you want the DuffCode for * @param vowel the vowel you want the DuffCode for
@ -1171,7 +1171,7 @@ public static String getWylieForVowel(String s) {
* context, or null if there is no such vowel in * context, or null if there is no such vowel in
* the context * the context
* @see DuffCode * @see DuffCode
* @see TibTextUtils#getVowel(DuffCode,DuffCode,String) */ * @see TibTextUtils#getVowel(List,DuffCode,DuffCode,String) */
public static DuffCode getVowel(String hashKey, int vowel) { public static DuffCode getVowel(String hashKey, int vowel) {
DuffCode[] dc = (DuffCode[])tibHash.get(hashKey); DuffCode[] dc = (DuffCode[])tibHash.get(hashKey);

View file

@ -66,7 +66,7 @@ public class ACIPString {
public static final int LS = 9; public static final int LS = 9;
/** For [DR] -- picture (without caption) on page */ /** For [DR] -- picture (without caption) on page */
public static final int DR = 10; public static final int DR = 10;
/** For [DD], [DDD], [DD1], [DD2], etc. -- picture with caption on page */ /** For [DD], [DDD], [DD1], [DD2], et cetera -- picture with caption on page */
public static final int DD = 11; public static final int DD = 11;
/** For [?] */ /** For [?] */
public static final int QUESTION = 12; public static final int QUESTION = 12;
@ -115,7 +115,7 @@ public class ACIPString {
private ACIPString() { } private ACIPString() { }
/** Creates a new ACIPString with source text <i>text</i> and type /** Creates a new ACIPString with source text <i>text</i> and type
* <i>type</i> being a characterization like {@link DD}. */ * <i>type</i> being a characterization like {@link #DD}. */
public ACIPString(String text, int type) { public ACIPString(String text, int type) {
setType(type); setType(type);
setText(text); setText(text);

View file

@ -29,7 +29,7 @@ import junit.framework.TestCase;
/** Tests this package, especially {@link #TPairListFactory} and /** Tests this package, especially {@link #TPairListFactory} and
* {@link #TPairList}. * {@link TPairList}.
* *
* @author David Chandler */ * @author David Chandler */
public class PackageTest extends TestCase { public class PackageTest extends TestCase {
@ -7262,6 +7262,7 @@ tstHelper("ZUR");
} }
public void testACIPConversion() { public void testACIPConversion() {
uhelp("KA \nKHA\n\nGA", "\u0f40\u0f0b\u0f41\u0f0b\n\n\u0f42");
uhelp("KA%\nKHA", "\u0f40\u0f35\u0f0b\u0f41"); uhelp("KA%\nKHA", "\u0f40\u0f35\u0f0b\u0f41");
uhelp("KA%", "\u0f40\u0f35"); uhelp("KA%", "\u0f40\u0f35");
uhelp("KAo", "\u0f40[#ERROR CONVERTING ACIP DOCUMENT: This converter cannot yet convert o because the converter's author is unclear what the result should be.]"); uhelp("KAo", "\u0f40[#ERROR CONVERTING ACIP DOCUMENT: This converter cannot yet convert o because the converter's author is unclear what the result should be.]");

View file

@ -22,7 +22,7 @@ import java.util.ListIterator;
import java.util.NoSuchElementException; import java.util.NoSuchElementException;
import java.util.ArrayList; import java.util.ArrayList;
/** An object that can iterate over an {@link #TParseTree}. /** An object that can iterate over an {@link TParseTree}.
* *
* @author David Chandler */ * @author David Chandler */
class ParseIterator { class ParseIterator {

View file

@ -77,7 +77,7 @@ class TPair {
* right side, first and from l, the left side, second. The pair * right side, first and from l, the left side, second. The pair
* returned may be illegal, such as the (A . ') you can get from * returned may be illegal, such as the (A . ') you can get from
* ACIP {A'AAMA}. * ACIP {A'AAMA}.
* @throw IllegalArgumentException if N is out of range */ * @throws IllegalArgumentException if N is out of range */
TPair minusNRightmostACIPCharacters(int N) TPair minusNRightmostACIPCharacters(int N)
throws IllegalArgumentException throws IllegalArgumentException
{ {

View file

@ -20,7 +20,7 @@ package org.thdl.tib.text.ttt;
import java.util.ArrayList; import java.util.ArrayList;
/** A list of non-empty list of {@link #TStackListList /** A list of non-empty list of {@link TStackListList
* TStackListLists} representing all the ways you could break up a * TStackListLists} representing all the ways you could break up a
* tsheg bar of ACIP into stacks (i.e., grapheme clusters). * tsheg bar of ACIP into stacks (i.e., grapheme clusters).
* *
@ -61,7 +61,7 @@ class TParseTree {
return k; return k;
} }
/** Returns the number of {@link #TPair pairs} that are in a /** Returns the number of {@link TPair pairs} that are in a
* parse of this tree. */ * parse of this tree. */
public int numberOfPairs() { public int numberOfPairs() {
if (al.isEmpty()) return 0; if (al.isEmpty()) return 0;

View file

@ -168,7 +168,7 @@ class TStackList {
private static final boolean ddebug = false; private static final boolean ddebug = false;
/** Returns true if and only if this stack list contains a clearly /** Returns true if and only if this stack list contains a clearly
* illegal construct, such as an TPair (V . something). */ * illegal construct. An example of such is a TPair (V . something). */
boolean isClearlyIllegal() { boolean isClearlyIllegal() {
// check for {D}{VA} sorts of things: // check for {D}{VA} sorts of things:
for (int i = 0; i < size(); i++) { for (int i = 0; i < size(); i++) {

View file

@ -21,7 +21,7 @@ package org.thdl.tib.text.ttt;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.ListIterator; import java.util.ListIterator;
/** A list of {@link #TStackList} objects, each of which is for a /** A list of {@link TStackList} objects, each of which is for a
* stack (a grapheme cluster), typically corresponding to one * stack (a grapheme cluster), typically corresponding to one
* ambiguous section of a tsheg bar. * ambiguous section of a tsheg bar.
* *