ICU-823 Misc API documentation bugs
X-SVN-Rev: 4178
This commit is contained in:
Ram Viswanadha
parent
e8c3ac77d8
commit
e94f176398
@ -251,7 +251,7 @@ protected:
|
||||
* \code
|
||||
* void processChar( UChar c )
|
||||
* {
|
||||
* cout << " " << c;
|
||||
* cout << " " << c;
|
||||
* }
|
||||
* \endcode
|
||||
* </pre>
|
||||
@ -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
|
||||
* </pre>
|
||||
|
||||
@ -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
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>String and Character Iteration</td>
|
||||
* <td>chariter.h, ustring.h, utf.h, uchar.h</td>
|
||||
* <td>ustring.h, utf.h, uchar.h</td>
|
||||
* <td>CharacterIterator, Unicode, UnicodeString</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
@ -99,7 +100,7 @@ opyright (C) 1996-1999, International Business Machines
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>Message Formatting</td>
|
||||
* <td>umsg.h</td>
|
||||
* <td>unum.h</td>
|
||||
* <td>MessageFormat</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
|
||||
@ -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
|
||||
* <code>UBIDI_LEVEL_OVERRIDE</code> bit set.<p>
|
||||
* Except for that bit, it must be
|
||||
* <code>paraLevel<=embeddingLevels[]<=UBIDI_MAX_EXPLICIT_LEVEL</code>.<p>
|
||||
* <code>paraLevel<=embeddingLevels[]<=UBIDI_MAX_EXPLICIT_LEVEL</code>.<p>
|
||||
* <strong>Caution: </strong>A copy of this pointer, not of the levels,
|
||||
* will be stored in the <code>UBiDi</code> object;
|
||||
* the <code>embeddingLevels</code> 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).<br>
|
||||
* It must be <code>0<=start<=limit<=</code>paragraph length.
|
||||
* It must be <code>0<=start<=limit<=</code>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 <code>length>0</code>.
|
||||
* It must be <code>length>0</code>.
|
||||
*
|
||||
* @param indexMap is a pointer to an array of <code>length</code>
|
||||
* 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 <code>length>0</code>.
|
||||
* It must be <code>length>0</code>.
|
||||
*
|
||||
* @param indexMap is a pointer to an array of <code>length</code>
|
||||
* indexes which will reflect the reordering of the characters.
|
||||
|
||||
@ -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 <code>0<=code<0x10ffff</code>.
|
||||
* It must be <code>0<=code<0x10ffff</code>.
|
||||
* @param nameChoice Selector for which name to get.
|
||||
* @param buffer Destination address for copying the name.
|
||||
* The name will always be zero-terminated.
|
||||
|
||||
@ -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 <code>0<=code<0x10ffff</code>.
|
||||
* It must be <code>0<=code<0x10ffff</code>.
|
||||
* @param buffer Destination address for copying the name.
|
||||
* @param bufferLength <code>==sizeof(buffer)</code>
|
||||
* @param nameChoice Selector for which name to get.
|
||||
@ -941,8 +941,8 @@ public:
|
||||
* Returns the numeric value of the character <code>ch</code> in the
|
||||
* specified radix.
|
||||
* <p>
|
||||
* If the radix is not in the range <code>MIN_RADIX</code> <=
|
||||
* <code>radix</code> <= <code>MAX_RADIX</code> or if the
|
||||
* If the radix is not in the range <code>MIN_RADIX <=
|
||||
* radix <= MAX_RADIX</code> or if the
|
||||
* value of <code>ch</code> is not a valid digit in the specified
|
||||
* radix, <code>-1</code> 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.
|
||||
* <li>The character is one of the uppercase Latin letters
|
||||
* <code>'A'</code> through <code>'Z'</code> and its code is less than
|
||||
* <code>radix + 'A' - 10</code>.
|
||||
* In this case, <code>ch - 'A' + 10</code>
|
||||
* <code>radix + 'A' - 10</code>.
|
||||
* In this case, <code>ch - 'A' + 10</code>
|
||||
* is returned.
|
||||
* <li>The character is one of the lowercase Latin letters
|
||||
* <code>'a'</code> through <code>'z'</code> and its code is less than
|
||||
* <code>radix + 'a' - 10</code>.
|
||||
* In this case, <code>ch - 'a' + 10</code>
|
||||
* <code>radix + 'a' - 10</code>.
|
||||
* In this case, <code>ch - 'a' + 10</code>
|
||||
* is returned.
|
||||
* </ul>
|
||||
*
|
||||
@ -986,11 +986,11 @@ public:
|
||||
* The <code>radix</code> argument is valid if it is greater than or
|
||||
* equal to <code>MIN_RADIX</code> and less than or equal to
|
||||
* <code>MAX_RADIX</code>. The <code>digit</code> argument is valid if
|
||||
* <code>0 <= digit <= radix</code>.
|
||||
* <code>0 <= digit <= radix</code>.
|
||||
* <p>
|
||||
* If the digit is less than 10, then
|
||||
* <code>'0' + digit</code> is returned. Otherwise, the value
|
||||
* <code>'a' + digit - 10</code> is returned.
|
||||
* <code>'0' + digit</code> is returned. Otherwise, the value
|
||||
* <code>'a' + digit - 10</code> is returned.
|
||||
*
|
||||
* @param digit the number to convert to a character.
|
||||
* @param radix the radix.
|
||||
|
||||
@ -63,7 +63,10 @@
|
||||
* Also, '\n', '\r', '\t' should be available.</p>
|
||||
*
|
||||
* <p>The list of "invariant characters" is:<br>
|
||||
* A-Z a-z 0-9 SPACE " % & ' ( ) * + , - . / : ; < = > ? _<br>
|
||||
* \code
|
||||
* A-Z a-z 0-9 SPACE " % & ' ( ) * + , - . / : ; < = > ? _
|
||||
*\endcode
|
||||
*<br>
|
||||
* (52 letters + 10 numbers + 20 punc/sym = 82 total)</p>
|
||||
*
|
||||
* <p>In other words, all the graphic characters in 7-bit ASCII should
|
||||
|
||||
Loading…
Reference in New Issue
Block a user