ICU-21464 Modifies comments to address warnings when Doxygen 1.8.20 is used to
authorgnrunge <nrunge@google.com>
Tue, 26 Jan 2021 22:00:39 +0000 (14:00 -0800)
committerNorbert Runge <41129501+gnrunge@users.noreply.github.com>
Tue, 26 Jan 2021 23:13:58 +0000 (15:13 -0800)
build the ICU4C docs. Typical changes: avoid linebreaks in {@link ...}
declarations, remove duplicate @param declaration.
The document building task in GHA CI is designed to fail upon warnings but
currently still passes because GHA uses an older version of Doxygen.

ICU-21464 Fix a typo.

icu4c/source/Doxyfile.in
icu4c/source/common/unicode/icuplug.h
icu4c/source/common/unicode/platform.h
icu4c/source/common/unicode/ucnvsel.h
icu4c/source/common/unicode/unifilt.h
icu4c/source/common/unicode/unistr.h
icu4c/source/i18n/unicode/translit.h
icu4c/source/layoutex/layout/playout.h

index 7ced104ce80ba4de8edc782da3dd37fe0955910b..d851b19e381149ef242dadb390cb1f69a6398424 100644 (file)
@@ -1677,7 +1677,7 @@ COMPACT_LATEX          = NO
 # The default value is: a4.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-PAPER_TYPE             = a4wide
+PAPER_TYPE             = a4
 
 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
 # that should be included in the LaTeX output. The package can be specified just
index 52f810da57d209f376889512d721115c204945cd..205af360d45e9e622729a7d400df4cd5b523e44d 100644 (file)
 /* === Basic types === */
 
 #ifndef U_HIDE_INTERNAL_API
+struct UPlugData;
 /**
  * @{
- * Opaque structure passed to/from a plugin. 
- * use the APIs to access it.
+ * Typedef for opaque structure passed to/from a plugin. 
+ * Use the APIs to access it.
  * @internal ICU 4.4 Technology Preview
  */
-
-struct UPlugData;
 typedef struct UPlugData UPlugData;
 
 /** @} */
index 2bb2f8b318d1133de3c4a9ebf13bdce642482726..cb3a833fefc9b1dc515cf55f8fd9b80f3543ee47 100644 (file)
@@ -880,6 +880,6 @@ namespace std {
 #else
 #    define U_CALLCONV_FPTR
 #endif
-/* @} */
+/** @} */
 
 #endif  // _PLATFORM_H
index 5e0a71cf3513f697a868c041bcf550a3b7eec563..3d7d3327f7daddd94cc843cab19655a06a20353d 100644 (file)
  * from the serialized form.
  */
 
+struct UConverterSelector;
 /**
  * @{
- * The selector data structure
+ * Typedef for selector data structure.
  */
-struct UConverterSelector;
 typedef struct UConverterSelector UConverterSelector;
 /** @} */
 
index 420e1a190564f03f6d28523dde7877502aab0e8d..7870b5593912efc26ac0830a7b6992a5f366fef5 100644 (file)
@@ -40,8 +40,8 @@ U_NAMESPACE_BEGIN
  *
  * <code>UnicodeFilter</code> defines a protocol for selecting a
  * subset of the full range (U+0000 to U+10FFFF) of Unicode characters.
- * Currently, filters are used in conjunction with classes like {@link
- * Transliterator} to only process selected characters through a
+ * Currently, filters are used in conjunction with classes like
+ * {@link Transliterator} to only process selected characters through a
  * transformation.
  *
  * <p>Note: UnicodeFilter currently stubs out two pure virtual methods
index df88d858366a8952b08f88256b423da23553168c..85bd96495150d38e26aa5d602566bcdeb5e48a56 100644 (file)
@@ -44,9 +44,10 @@ struct UConverter;          // unicode/ucnv.h
 #ifndef USTRING_H
 /**
  * \ingroup ustring_ustrlen
+ * @param s Pointer to sequence of UChars.
+ * @return Length of sequence.
  */
-U_CAPI int32_t U_EXPORT2
-u_strlen(const UChar *s);
+U_CAPI int32_t U_EXPORT2 u_strlen(const UChar *s);
 #endif
 
 U_NAMESPACE_BEGIN
@@ -2766,7 +2767,6 @@ public:
    * @param options   Options bit set, usually 0. See U_TITLECASE_NO_LOWERCASE,
    *                  U_TITLECASE_NO_BREAK_ADJUSTMENT, U_TITLECASE_ADJUST_TO_CASED,
    *                  U_TITLECASE_WHOLE_STRING, U_TITLECASE_SENTENCES.
-   * @param options Options bit set, see ucasemap_open().
    * @return A reference to this.
    * @stable ICU 3.8
    */
index 57ceb37d7fc3d22c6d2fa73848c2284b3e832c36..0556b740fab7923f246a77dbcee427ef5c521bf6 100644 (file)
@@ -683,8 +683,8 @@ public:
      * unambiguous transliterations.  After the last call to this
      * method, there may be untransliterated text that is waiting for
      * more input to resolve an ambiguity.  In order to perform these
-     * pending transliterations, clients should call {@link
-     * #finishTransliteration } after the last call to this
+     * pending transliterations, clients should call
+     * {@link #finishTransliteration } after the last call to this
      * method has been made.
      *
      * @param text the buffer holding transliterated and untransliterated text
@@ -741,8 +741,7 @@ public:
     /**
      * Transliterates the portion of the text buffer that can be
      * transliterated unambiguosly.  This is a convenience method; see
-     * {@link
-     * #transliterate(Replaceable&, UTransPosition&, const UnicodeString&, UErrorCode&) const }
+     * {@link #transliterate(Replaceable&, UTransPosition&, const UnicodeString&, UErrorCode&) const }
      * for details.
      * @param text the buffer holding transliterated and
      * untransliterated text
@@ -761,8 +760,7 @@ public:
      * <code>transliterate()</code>.
      * @param text the buffer holding transliterated and
      * untransliterated text.
-     * @param index the array of indices previously passed to {@link
-     * #transliterate }
+     * @param index the array of indices previously passed to {@link #transliterate }
      * @stable ICU 2.0
      */
     virtual void finishTransliteration(Replaceable& text,
@@ -968,8 +966,8 @@ public:
 
     /**
      * Returns a name for this transliterator that is appropriate for
-     * display to the user in the default locale.  See {@link
-     * #getDisplayName } for details.
+     * display to the user in the default locale.  See {@link #getDisplayName }
+     * for details.
      * @param ID     the string identifier for this transliterator
      * @param result Output param to receive the display name
      * @return       A reference to 'result'.
@@ -1168,8 +1166,8 @@ public:
      * input text by this Transliterator.  This incorporates this
      * object's current filter; if the filter is changed, the return
      * value of this function will change.  The default implementation
-     * returns an empty set.  Some subclasses may override {@link
-     * #handleGetSourceSet } to return a more precise result.  The
+     * returns an empty set.  Some subclasses may override
+     * {@link #handleGetSourceSet } to return a more precise result. The
      * return result is approximate in any case and is intended for
      * use by tests, tools, or utilities.
      * @param result receives result set; previous contents lost
index 98fc2127cb8f73cfd8bfba9e50fb24b3239ca78b..a9a21e7fe0cc5c7051c5825f81596d5c30b03867 100644 (file)
@@ -164,11 +164,6 @@ U_CAPI UBiDiDirection U_EXPORT2
 pl_getTextDirection(pl_paragraph *paragraph);
 
 /**
- * Get the max ascent value for all the fonts
- * in the paragraph.
- *
- * @param paragraph the <code>pl_paragraph</code>
- *
  * Return the max ascent value for all the fonts
  * in the paragraph.
  *