From e94f176398fac2f7a12836a44ed14281d684fe15 Mon Sep 17 00:00:00 2001 From: Ram Viswanadha Date: Mon, 19 Mar 2001 21:51:32 +0000 Subject: [PATCH] ICU-823 Misc API documentation bugs X-SVN-Rev: 4178 --- icu4c/source/common/unicode/chariter.h | 16 ++++++++-------- icu4c/source/common/unicode/docmain.h | 23 ++++++++++++----------- icu4c/source/common/unicode/ubidi.h | 14 +++++++------- icu4c/source/common/unicode/uchar.h | 2 +- icu4c/source/common/unicode/unicode.h | 20 ++++++++++---------- icu4c/source/common/unicode/utypes.h | 5 ++++- 6 files changed, 42 insertions(+), 38 deletions(-) diff --git a/icu4c/source/common/unicode/chariter.h b/icu4c/source/common/unicode/chariter.h index 43c902c680..022c1171db 100644 --- a/icu4c/source/common/unicode/chariter.h +++ b/icu4c/source/common/unicode/chariter.h @@ -251,7 +251,7 @@ protected: * \code * void processChar( UChar c ) * { - * cout << " " << c; + * cout << " " << c; * } * \endcode * @@ -293,8 +293,8 @@ protected: * c = iter.previous()) {} * UTextOffset start = iter.getIndex() + 1; * - * cout << "start: " << start << " end: " << end << endl; - * for (c = iter.setIndex(start); iter.getIndex() < end; c = iter.next() ) { + * cout << "start: " << start << " end: " << end << endl; + * for (c = iter.setIndex(start); iter.getIndex() < end; c = iter.next() ) { * processChar(c); * } * } @@ -305,16 +305,16 @@ protected: * \code * void CharacterIterator_Example( void ) * { - * cout << endl << "===== CharacterIterator_Example: =====" << endl; + * cout << endl << "===== CharacterIterator_Example: =====" << endl; * UnicodeString text("Ein kleiner Satz."); * StringCharacterIterator iterator(text); - * cout << "----- traverseForward: -----------" << endl; + * cout << "----- traverseForward: -----------" << endl; * traverseForward( iterator ); - * cout << endl << endl << "----- traverseBackward: ----------" << endl; + * cout << endl << endl << "----- traverseBackward: ----------" << endl; * traverseBackward( iterator ); - * cout << endl << endl << "----- traverseOut: ---------------" << endl; + * cout << endl << endl << "----- traverseOut: ---------------" << endl; * traverseOut( iterator, 7 ); - * cout << endl << endl << "-----" << endl; + * cout << endl << endl << "-----" << endl; * } * \endcode * diff --git a/icu4c/source/common/unicode/docmain.h b/icu4c/source/common/unicode/docmain.h index 403a36a473..c95cbc3a57 100644 --- a/icu4c/source/common/unicode/docmain.h +++ b/icu4c/source/common/unicode/docmain.h @@ -1,12 +1,13 @@ -opyright (C) 1996-1999, International Business Machines -* Corporation and others. All Rights Reserved. -********************************************************************** -* -* FILE NAME: DOCMAIN.h -* -* Date Name Description -* 12/11/2000 Ram Creation. -*/ +/******************************************************************** + * COPYRIGHT: + * Copyright (c) 1997-1999, International Business Machines Corporation and + * others. All Rights Reserved. + * + * FILE NAME: DOCMAIN.h + * + * Date Name Description + * 12/11/2000 Ram Creation. + */ /* This file contains documentation for Doxygen and doesnot have * any significance with respect to C or C++ API */ @@ -69,7 +70,7 @@ opyright (C) 1996-1999, International Business Machines * * * String and Character Iteration - * chariter.h, ustring.h, utf.h, uchar.h + * ustring.h, utf.h, uchar.h * CharacterIterator, Unicode, UnicodeString * * @@ -99,7 +100,7 @@ opyright (C) 1996-1999, International Business Machines * * * Message Formatting - * umsg.h + * unum.h * MessageFormat * * diff --git a/icu4c/source/common/unicode/ubidi.h b/icu4c/source/common/unicode/ubidi.h index b81b86dded..cde2361c20 100644 --- a/icu4c/source/common/unicode/ubidi.h +++ b/icu4c/source/common/unicode/ubidi.h @@ -218,7 +218,7 @@ * UErrorCode *pErrorCode) { * UBiDi *para; * - * if(pErrorCode==NULL || U_FAILURE(*pErrorCode) || length<=0) { + * if(pErrorCode==NULL || U_FAILURE(*pErrorCode) || length<=0) { * return; * } * @@ -233,7 +233,7 @@ * StyleRun styleRun={ length, styleNormal }; * int width; * - * if(styleRuns==NULL || styleRunCount<=0) { + * if(styleRuns==NULL || styleRunCount<=0) { * styleRunCount=1; * styleRuns=&styleRun; * } @@ -241,7 +241,7 @@ * // assume styleRuns[styleRunCount-1].limit>=length * * width=getTextWidth(text, 0, length, styleRuns, styleRunCount); - * if(width<=lineWidth) { + * if(width<=lineWidth) { * // everything fits onto one line * * // prepare rendering a new line from either left or right @@ -559,7 +559,7 @@ ubidi_isInverse(UBiDi *pBiDi); * (same index) character if the level has the * UBIDI_LEVEL_OVERRIDE bit set.

* Except for that bit, it must be - * paraLevel<=embeddingLevels[]<=UBIDI_MAX_EXPLICIT_LEVEL.

+ * paraLevel<=embeddingLevels[]<=UBIDI_MAX_EXPLICIT_LEVEL.

* Caution: A copy of this pointer, not of the levels, * will be stored in the UBiDi object; * the embeddingLevels array must not be @@ -614,7 +614,7 @@ ubidi_setPara(UBiDi *pBiDi, const UChar *text, UTextOffset length, * * @param limit is just behind the line's last index into the paragraph text * (its last index +1).
- * It must be 0<=start<=limit<=paragraph length. + * It must be 0<=start<=limit<=paragraph length. * * @param pLineBiDi is the object that will now represent a line of the paragraph. * @@ -908,7 +908,7 @@ ubidi_getVisualMap(UBiDi *pBiDi, UTextOffset *indexMap, UErrorCode *pErrorCode); * * @param length is the number of levels in the array, or, semantically, * the number of objects to be reordered. - * It must be length>0. + * It must be length>0. * * @param indexMap is a pointer to an array of length * indexes which will reflect the reordering of the characters. @@ -930,7 +930,7 @@ ubidi_reorderLogical(const UBiDiLevel *levels, UTextOffset length, UTextOffset * * * @param length is the number of levels in the array, or, semantically, * the number of objects to be reordered. - * It must be length>0. + * It must be length>0. * * @param indexMap is a pointer to an array of length * indexes which will reflect the reordering of the characters. diff --git a/icu4c/source/common/unicode/uchar.h b/icu4c/source/common/unicode/uchar.h index 481398069c..820b37c8fc 100644 --- a/icu4c/source/common/unicode/uchar.h +++ b/icu4c/source/common/unicode/uchar.h @@ -746,7 +746,7 @@ u_charScript(UChar32 ch); * not be called with a command line option to include 1.0 names in unames.dat. * * @param code The character (code point) for which to get the name. - * It must be 0<=code<0x10ffff. + * It must be 0<=code<0x10ffff. * @param nameChoice Selector for which name to get. * @param buffer Destination address for copying the name. * The name will always be zero-terminated. diff --git a/icu4c/source/common/unicode/unicode.h b/icu4c/source/common/unicode/unicode.h index fc57551fcf..45df069767 100644 --- a/icu4c/source/common/unicode/unicode.h +++ b/icu4c/source/common/unicode/unicode.h @@ -902,7 +902,7 @@ public: * like A-Z, 0-9, space, and '-'. * * @param code The character (code point) for which to get the name. - * It must be 0<=code<0x10ffff. + * It must be 0<=code<0x10ffff. * @param buffer Destination address for copying the name. * @param bufferLength ==sizeof(buffer) * @param nameChoice Selector for which name to get. @@ -941,8 +941,8 @@ public: * Returns the numeric value of the character ch in the * specified radix. *

- * If the radix is not in the range MIN_RADIX <= - * radix <= MAX_RADIX or if the + * If the radix is not in the range MIN_RADIX <= + * radix <= MAX_RADIX or if the * value of ch is not a valid digit in the specified * radix, -1 is returned. A character is a valid digit * if at least one of the following is true: @@ -953,13 +953,13 @@ public: * In this case the decimal digit value is returned. *

  • The character is one of the uppercase Latin letters * 'A' through 'Z' and its code is less than - * radix + 'A' - 10. - * In this case, ch - 'A' + 10 + * radix + 'A' - 10. + * In this case, ch - 'A' + 10 * is returned. *
  • The character is one of the lowercase Latin letters * 'a' through 'z' and its code is less than - * radix + 'a' - 10. - * In this case, ch - 'a' + 10 + * radix + 'a' - 10. + * In this case, ch - 'a' + 10 * is returned. * * @@ -986,11 +986,11 @@ public: * The radix argument is valid if it is greater than or * equal to MIN_RADIX and less than or equal to * MAX_RADIX. The digit argument is valid if - * 0 <= digit <= radix. + * 0 <= digit <= radix. *

    * If the digit is less than 10, then - * '0' + digit is returned. Otherwise, the value - * 'a' + digit - 10 is returned. + * '0' + digit is returned. Otherwise, the value + * 'a' + digit - 10 is returned. * * @param digit the number to convert to a character. * @param radix the radix. diff --git a/icu4c/source/common/unicode/utypes.h b/icu4c/source/common/unicode/utypes.h index 0042805f3e..a34129a767 100644 --- a/icu4c/source/common/unicode/utypes.h +++ b/icu4c/source/common/unicode/utypes.h @@ -63,7 +63,10 @@ * Also, '\n', '\r', '\t' should be available.

    * *

    The list of "invariant characters" is:
    - * A-Z a-z 0-9 SPACE " % & ' ( ) * + , - . / : ; < = > ? _
    + * \code + * A-Z a-z 0-9 SPACE " % & ' ( ) * + , - . / : ; < = > ? _ + *\endcode + *
    * (52 letters + 10 numbers + 20 punc/sym = 82 total)

    * *

    In other words, all the graphic characters in 7-bit ASCII should