From 70eda4d8dd0c34603dda4846dd2427e7a1ec9c5c Mon Sep 17 00:00:00 2001 From: "Steven R. Loomis" Date: Thu, 26 Jun 2014 14:08:13 +0000 Subject: [PATCH] ICU-10530 Deprecate LayoutEngine - improve javadoc tags X-SVN-Rev: 35957 --- icu4c/source/layout/ArabicLayoutEngine.h | 4 +- .../layout/ContextualGlyphInsertionProc2.h | 4 +- .../source/layout/ContextualGlyphSubstProc.h | 4 +- .../source/layout/ContextualGlyphSubstProc2.h | 4 +- icu4c/source/layout/GXLayoutEngine.h | 4 +- icu4c/source/layout/GXLayoutEngine2.h | 4 +- icu4c/source/layout/HanLayoutEngine.h | 4 +- icu4c/source/layout/HangulLayoutEngine.h | 4 +- icu4c/source/layout/IndicLayoutEngine.h | 4 +- .../layout/IndicRearrangementProcessor.h | 4 +- .../layout/IndicRearrangementProcessor2.h | 4 +- icu4c/source/layout/KhmerLayoutEngine.h | 4 +- icu4c/source/layout/LEFontInstance.h | 70 +++++++++--------- icu4c/source/layout/LEGlyphStorage.h | 74 +++++++++---------- icu4c/source/layout/LEInsertionList.h | 4 +- icu4c/source/layout/LELanguages.h | 5 +- icu4c/source/layout/LEScripts.h | 32 ++++---- icu4c/source/layout/LESwaps.h | 10 +-- icu4c/source/layout/LETypes.h | 74 +++++++++---------- icu4c/source/layout/LayoutEngine.h | 37 ++++++---- icu4c/source/layout/LigatureSubstProc.h | 4 +- icu4c/source/layout/LigatureSubstProc2.h | 4 +- icu4c/source/layout/OpenTypeLayoutEngine.h | 4 +- icu4c/source/layout/SegmentArrayProcessor.h | 4 +- icu4c/source/layout/SegmentArrayProcessor2.h | 4 +- icu4c/source/layout/SegmentSingleProcessor.h | 4 +- icu4c/source/layout/SegmentSingleProcessor2.h | 4 +- icu4c/source/layout/SimpleArrayProcessor.h | 4 +- icu4c/source/layout/SimpleArrayProcessor2.h | 4 +- icu4c/source/layout/SingleTableProcessor.h | 4 +- icu4c/source/layout/SingleTableProcessor2.h | 4 +- icu4c/source/layout/ThaiLayoutEngine.h | 4 +- icu4c/source/layout/TrimmedArrayProcessor.h | 4 +- icu4c/source/layout/TrimmedArrayProcessor2.h | 4 +- 34 files changed, 208 insertions(+), 202 deletions(-) diff --git a/icu4c/source/layout/ArabicLayoutEngine.h b/icu4c/source/layout/ArabicLayoutEngine.h index 937289aed64..eb8e2adda9d 100644 --- a/icu4c/source/layout/ArabicLayoutEngine.h +++ b/icu4c/source/layout/ArabicLayoutEngine.h @@ -79,14 +79,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/ContextualGlyphInsertionProc2.h b/icu4c/source/layout/ContextualGlyphInsertionProc2.h index 7ac76587f0d..2f930bcb23f 100644 --- a/icu4c/source/layout/ContextualGlyphInsertionProc2.h +++ b/icu4c/source/layout/ContextualGlyphInsertionProc2.h @@ -39,14 +39,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/ContextualGlyphSubstProc.h b/icu4c/source/layout/ContextualGlyphSubstProc.h index 23cd546c6a0..daa15ebb1de 100644 --- a/icu4c/source/layout/ContextualGlyphSubstProc.h +++ b/icu4c/source/layout/ContextualGlyphSubstProc.h @@ -37,14 +37,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/ContextualGlyphSubstProc2.h b/icu4c/source/layout/ContextualGlyphSubstProc2.h index 696958013e1..c8076095cfa 100644 --- a/icu4c/source/layout/ContextualGlyphSubstProc2.h +++ b/icu4c/source/layout/ContextualGlyphSubstProc2.h @@ -37,14 +37,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/GXLayoutEngine.h b/icu4c/source/layout/GXLayoutEngine.h index 6a02f4b007e..0e85b699571 100644 --- a/icu4c/source/layout/GXLayoutEngine.h +++ b/icu4c/source/layout/GXLayoutEngine.h @@ -61,14 +61,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/GXLayoutEngine2.h b/icu4c/source/layout/GXLayoutEngine2.h index 82bef73cf65..57e48ab3d0c 100644 --- a/icu4c/source/layout/GXLayoutEngine2.h +++ b/icu4c/source/layout/GXLayoutEngine2.h @@ -60,14 +60,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/HanLayoutEngine.h b/icu4c/source/layout/HanLayoutEngine.h index d0334db78fc..6ff8d537db9 100644 --- a/icu4c/source/layout/HanLayoutEngine.h +++ b/icu4c/source/layout/HanLayoutEngine.h @@ -61,14 +61,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/HangulLayoutEngine.h b/icu4c/source/layout/HangulLayoutEngine.h index 844b38e7888..7041d8999e5 100644 --- a/icu4c/source/layout/HangulLayoutEngine.h +++ b/icu4c/source/layout/HangulLayoutEngine.h @@ -84,14 +84,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/IndicLayoutEngine.h b/icu4c/source/layout/IndicLayoutEngine.h index 0d5a9efc231..bc4f36e1dc8 100644 --- a/icu4c/source/layout/IndicLayoutEngine.h +++ b/icu4c/source/layout/IndicLayoutEngine.h @@ -85,14 +85,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/IndicRearrangementProcessor.h b/icu4c/source/layout/IndicRearrangementProcessor.h index 2c6047eaec7..0b52cd2674b 100644 --- a/icu4c/source/layout/IndicRearrangementProcessor.h +++ b/icu4c/source/layout/IndicRearrangementProcessor.h @@ -39,14 +39,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/IndicRearrangementProcessor2.h b/icu4c/source/layout/IndicRearrangementProcessor2.h index 814cb10b0a8..37f98e4a93d 100644 --- a/icu4c/source/layout/IndicRearrangementProcessor2.h +++ b/icu4c/source/layout/IndicRearrangementProcessor2.h @@ -39,14 +39,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/KhmerLayoutEngine.h b/icu4c/source/layout/KhmerLayoutEngine.h index d74135983b1..81af6f760f1 100644 --- a/icu4c/source/layout/KhmerLayoutEngine.h +++ b/icu4c/source/layout/KhmerLayoutEngine.h @@ -87,14 +87,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/LEFontInstance.h b/icu4c/source/layout/LEFontInstance.h index 4b435cabbfc..8a4de7bdeb9 100644 --- a/icu4c/source/layout/LEFontInstance.h +++ b/icu4c/source/layout/LEFontInstance.h @@ -23,14 +23,14 @@ U_NAMESPACE_BEGIN * and character mirroring - replacing a character which has both a left and a right * hand form with the opposite form. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ class LECharMapper /* not : public UObject because this is an interface/mixin class */ { public: /** * Destructor. - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual ~LECharMapper(); @@ -41,7 +41,7 @@ public: * * @return the adjusted character * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual LEUnicode32 mapChar(LEUnicode32 ch) const = 0; }; @@ -50,7 +50,7 @@ public: * This is a forward reference to the class which holds the per-glyph * storage. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ class LEGlyphStorage; @@ -76,7 +76,7 @@ class LEGlyphStorage; * methods with some default behavior such as returning constant values, or using the * values from the first subfont. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ class U_LAYOUT_API LEFontInstance : public UObject { @@ -86,7 +86,7 @@ public: * This virtual destructor is here so that the subclass * destructors can be invoked through the base class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual ~LEFontInstance(); @@ -139,7 +139,7 @@ public: * * @see LEScripts.h * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual const LEFontInstance *getSubFont(const LEUnicode chars[], le_int32 *offset, le_int32 limit, le_int32 script, LEErrorCode &success) const; @@ -165,7 +165,7 @@ public: * @return the address of the table in memory, or NULL * if the table doesn't exist. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual const void *getFontTable(LETag tableTag) const = 0; @@ -204,7 +204,7 @@ public: * * @return TRUE if the font can render ch. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual le_bool canDisplay(LEUnicode32 ch) const; @@ -214,7 +214,7 @@ public: * * @return the number of design units pre EM. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual le_int32 getUnitsPerEM() const = 0; @@ -239,7 +239,7 @@ public: * * @see LECharMapper * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual void mapCharsToGlyphs(const LEUnicode chars[], le_int32 offset, le_int32 count, le_bool reverse, const LECharMapper *mapper, le_bool filterZeroWidth, LEGlyphStorage &glyphStorage) const; @@ -256,7 +256,7 @@ public: * * @see LECharMapper * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual LEGlyphID mapCharToGlyph(LEUnicode32 ch, const LECharMapper *mapper, le_bool filterZeroWidth) const; @@ -272,7 +272,7 @@ public: * * @see LECharMapper * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual LEGlyphID mapCharToGlyph(LEUnicode32 ch, const LECharMapper *mapper) const; @@ -286,7 +286,7 @@ public: * * @return the glyph index * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual LEGlyphID mapCharToGlyph(LEUnicode32 ch) const = 0; @@ -300,7 +300,7 @@ public: * @param glyph - the glyph index * @param advance - the X and Y pixel values will be stored here * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual void getGlyphAdvance(LEGlyphID glyph, LEPoint &advance) const = 0; @@ -314,7 +314,7 @@ public: * * @return TRUE if the point coordinates could be stored. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual le_bool getGlyphPoint(LEGlyphID glyph, le_int32 pointNumber, LEPoint &point) const = 0; @@ -324,7 +324,7 @@ public: * * @return the pixel width of the EM square * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual float getXPixelsPerEm() const = 0; @@ -334,7 +334,7 @@ public: * * @return the pixel height of the EM square * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual float getYPixelsPerEm() const = 0; @@ -346,7 +346,7 @@ public: * * @return points in the X direction * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual float xUnitsToPoints(float xUnits) const; @@ -358,7 +358,7 @@ public: * * @return points in the Y direction * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual float yUnitsToPoints(float yUnits) const; @@ -368,7 +368,7 @@ public: * @param units - X and Y design units * @param points - set to X and Y points * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual void unitsToPoints(LEPoint &units, LEPoint &points) const; @@ -380,7 +380,7 @@ public: * * @return font design units in the X direction * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual float xPixelsToUnits(float xPixels) const; @@ -392,7 +392,7 @@ public: * * @return font design units in the Y direction * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual float yPixelsToUnits(float yPixels) const; @@ -402,7 +402,7 @@ public: * @param pixels - X and Y pixel * @param units - set to X and Y font design units * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual void pixelsToUnits(LEPoint &pixels, LEPoint &units) const; @@ -415,7 +415,7 @@ public: * * @see transformFunits * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual float getScaleFactorX() const = 0; @@ -427,7 +427,7 @@ public: * * @see transformFunits * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual float getScaleFactorY() const = 0; @@ -444,7 +444,7 @@ public: * @see getScaleFactorX * @see getScaleFactorY * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual void transformFunits(float xFunits, float yFunits, LEPoint &pixels) const; @@ -456,7 +456,7 @@ public: * * @return the floating point value * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static inline float fixedToFloat(le_int32 fixed); @@ -468,7 +468,7 @@ public: * * @return the fixed point value * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static inline le_int32 floatToFixed(float theFloat); @@ -484,7 +484,7 @@ public: * @return the font's ascent, in points. This value * will always be positive. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual le_int32 getAscent() const = 0; @@ -494,7 +494,7 @@ public: * @return the font's descent, in points. This value * will always be positive. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual le_int32 getDescent() const = 0; @@ -504,7 +504,7 @@ public: * @return the font's leading, in points. This value * will always be positive. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual le_int32 getLeading() const = 0; @@ -516,21 +516,21 @@ public: * @return the line height, in points. This vaule will * always be positive. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual le_int32 getLineHeight() const; /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/LEGlyphStorage.h b/icu4c/source/layout/LEGlyphStorage.h index 12861fea5ad..30ce0d13781 100644 --- a/icu4c/source/layout/LEGlyphStorage.h +++ b/icu4c/source/layout/LEGlyphStorage.h @@ -29,7 +29,7 @@ U_NAMESPACE_BEGIN * * @see LEInsertionList.h * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ class U_LAYOUT_API LEGlyphStorage : public UObject, protected LEInsertionCallback { @@ -105,7 +105,7 @@ protected: * * @see LEInsertionList.h * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual le_bool applyInsertion(le_int32 atPosition, le_int32 count, LEGlyphID newGlyphs[]); @@ -116,14 +116,14 @@ public: * allocateGlyphArray, allocatePositions and allocateAuxData * to allocate the data. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ LEGlyphStorage(); /** * The destructor. This will deallocate all of the arrays. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ ~LEGlyphStorage(); @@ -132,7 +132,7 @@ public: * * @return the number of glyphs in the glyph array * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ inline le_int32 getGlyphCount() const; @@ -144,7 +144,7 @@ public: * @param glyphs - the destiniation glyph array * @param success - set to an error code if the operation fails * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void getGlyphs(LEGlyphID glyphs[], LEErrorCode &success) const; @@ -158,7 +158,7 @@ public: * @param extraBits - this value will be ORed with each glyph index * @param success - set to an error code if the operation fails * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void getGlyphs(le_uint32 glyphs[], le_uint32 extraBits, LEErrorCode &success) const; @@ -170,7 +170,7 @@ public: * @param charIndices - the destiniation character index array * @param success - set to an error code if the operation fails * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void getCharIndices(le_int32 charIndices[], LEErrorCode &success) const; @@ -183,7 +183,7 @@ public: * @param indexBase - an offset which will be added to each index * @param success - set to an error code if the operation fails * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void getCharIndices(le_int32 charIndices[], le_int32 indexBase, LEErrorCode &success) const; @@ -196,7 +196,7 @@ public: * @param positions - the destiniation position array * @param success - set to an error code if the operation fails * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void getGlyphPositions(float positions[], LEErrorCode &success) const; @@ -212,7 +212,7 @@ public: * @param y - the glyph's Y position * @param success - set to an error code if the operation fails * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void getGlyphPosition(le_int32 glyphIndex, float &x, float &y, LEErrorCode &success) const; @@ -226,7 +226,7 @@ public: * @param success set to an error code if the storage cannot be allocated of if the initial * glyph count is not positive. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void allocateGlyphArray(le_int32 initialGlyphCount, le_bool rightToLeft, LEErrorCode &success); @@ -238,7 +238,7 @@ public: * * @return the number of X, Y position pairs allocated. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ le_int32 allocatePositions(LEErrorCode &success); @@ -249,7 +249,7 @@ public: * * @return the size of the auxillary data array. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ le_int32 allocateAuxData(LEErrorCode &success); @@ -259,7 +259,7 @@ public: * @param auxData the auxillary data array will be copied to this address * @param success set to an error code if the data cannot be copied * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void getAuxData(le_uint32 auxData[], LEErrorCode &success) const; @@ -271,7 +271,7 @@ public: * * @return the glyph ID * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ LEGlyphID getGlyphID(le_int32 glyphIndex, LEErrorCode &success) const; @@ -283,7 +283,7 @@ public: * * @return the character index * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ le_int32 getCharIndex(le_int32 glyphIndex, LEErrorCode &success) const; @@ -296,7 +296,7 @@ public: * * @return the auxillary data * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ le_uint32 getAuxData(le_int32 glyphIndex, LEErrorCode &success) const; @@ -308,7 +308,7 @@ public: * * @return a reference to the given location in the glyph array * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ inline LEGlyphID &operator[](le_int32 glyphIndex) const; @@ -327,7 +327,7 @@ public: * * @see LEInsertionList.h * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ LEGlyphID *insertGlyphs(le_int32 atIndex, le_int32 insertCount, LEErrorCode& success); @@ -347,7 +347,7 @@ public: * * @see LEInsertionList.h * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ LEGlyphID *insertGlyphs(le_int32 atIndex, le_int32 insertCount); @@ -362,7 +362,7 @@ public: * @param toPosition - target position of the glyph * @param marker marker bit * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void moveGlyph(le_int32 fromPosition, le_int32 toPosition, le_uint32 marker); @@ -376,7 +376,7 @@ public: * * @see LEInsertionList.h * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ le_int32 applyInsertions(); @@ -387,7 +387,7 @@ public: * @param glyphID the new glyph ID * @param success will be set to an error code if the glyph ID cannot be set. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void setGlyphID(le_int32 glyphIndex, LEGlyphID glyphID, LEErrorCode &success); @@ -398,7 +398,7 @@ public: * @param charIndex the new char index * @param success will be set to an error code if the char index cannot be set. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void setCharIndex(le_int32 glyphIndex, le_int32 charIndex, LEErrorCode &success); @@ -410,7 +410,7 @@ public: * @param y the new Y position * @param success will be set to an error code if the position cannot be set. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void setPosition(le_int32 glyphIndex, float x, float y, LEErrorCode &success); @@ -422,7 +422,7 @@ public: * @param yAdjust the adjustment to the glyph's Y position * @param success will be set to an error code if the glyph's position cannot be adjusted. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void adjustPosition(le_int32 glyphIndex, float xAdjust, float yAdjust, LEErrorCode &success); @@ -433,7 +433,7 @@ public: * @param auxData the new auxillary data * @param success will be set to an error code if the auxillary data cannot be set. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void setAuxData(le_int32 glyphIndex, le_uint32 auxData, LEErrorCode &success); @@ -445,7 +445,7 @@ public: * @param from the LEGlyphStorage object from which * to get the new glyph array. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void adoptGlyphArray(LEGlyphStorage &from); @@ -457,7 +457,7 @@ public: * @param from the LEGlyphStorage object from which * to get the new char indices array. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void adoptCharIndicesArray(LEGlyphStorage &from); @@ -469,7 +469,7 @@ public: * @param from the LEGlyphStorage object from which * to get the new position array. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void adoptPositionArray(LEGlyphStorage &from); @@ -481,7 +481,7 @@ public: * @param from the LEGlyphStorage object from which * to get the new auxillary data array. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void adoptAuxDataArray(LEGlyphStorage &from); @@ -492,7 +492,7 @@ public: * @param from the LEGlyphStorage object from which * to get the new glyph count. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void adoptGlyphCount(LEGlyphStorage &from); @@ -501,7 +501,7 @@ public: * * @param newGlyphCount the new glyph count. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void adoptGlyphCount(le_int32 newGlyphCount); @@ -511,21 +511,21 @@ public: * to layout a different characer array. (This method is also called * by the destructor) * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void reset(); /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); }; diff --git a/icu4c/source/layout/LEInsertionList.h b/icu4c/source/layout/LEInsertionList.h index e25b8e98d92..32407104771 100644 --- a/icu4c/source/layout/LEInsertionList.h +++ b/icu4c/source/layout/LEInsertionList.h @@ -126,14 +126,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/LELanguages.h b/icu4c/source/layout/LELanguages.h index a2bf9767e6d..0640236c9ed 100644 --- a/icu4c/source/layout/LELanguages.h +++ b/icu4c/source/layout/LELanguages.h @@ -25,7 +25,7 @@ U_NAMESPACE_BEGIN * this is just a list of languages which the LayoutEngine * supports. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ enum LanguageCodes { @@ -60,7 +60,8 @@ enum LanguageCodes { zhsLanguageCode = 28, zhtLanguageCode = 29, - /** New language codes added 03/13/2008 @deprecated see {@link LayoutEngine} */ + /** New language codes added 03/13/2008 @deprecated ICU 54. See {@link LayoutEngine} + */ afkLanguageCode = 30, belLanguageCode = 31, bgrLanguageCode = 32, diff --git a/icu4c/source/layout/LEScripts.h b/icu4c/source/layout/LEScripts.h index 583d1fa62e5..9c7606b2d22 100644 --- a/icu4c/source/layout/LEScripts.h +++ b/icu4c/source/layout/LEScripts.h @@ -24,7 +24,7 @@ U_NAMESPACE_BEGIN * Constants for Unicode script values, generated using * ICU4J's UScript class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ enum ScriptCodes { @@ -70,12 +70,12 @@ enum ScriptCodes { thaiScriptCode = 38, tibtScriptCode = 39, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ cansScriptCode = 40, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ yiiiScriptCode = 41, @@ -84,7 +84,7 @@ enum ScriptCodes { buhdScriptCode = 44, tagbScriptCode = 45, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ braiScriptCode = 46, @@ -96,12 +96,12 @@ enum ScriptCodes { taleScriptCode = 52, ugarScriptCode = 53, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ hrktScriptCode = 54, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ bugiScriptCode = 55, @@ -112,7 +112,7 @@ enum ScriptCodes { tfngScriptCode = 60, xpeoScriptCode = 61, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ baliScriptCode = 62, @@ -158,7 +158,7 @@ enum ScriptCodes { zxxxScriptCode = 102, zzzzScriptCode = 103, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ cariScriptCode = 104, @@ -174,7 +174,7 @@ enum ScriptCodes { moonScriptCode = 114, mteiScriptCode = 115, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ armiScriptCode = 116, @@ -192,7 +192,7 @@ enum ScriptCodes { zmthScriptCode = 128, zsymScriptCode = 129, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ bamuScriptCode = 130, @@ -200,7 +200,7 @@ enum ScriptCodes { nkgbScriptCode = 132, sarbScriptCode = 133, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ bassScriptCode = 134, @@ -217,7 +217,7 @@ enum ScriptCodes { sindScriptCode = 145, waraScriptCode = 146, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ afakScriptCode = 147, @@ -230,20 +230,20 @@ enum ScriptCodes { tangScriptCode = 154, woleScriptCode = 155, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ hluwScriptCode = 156, khojScriptCode = 157, tirhScriptCode = 158, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ aghbScriptCode = 159, mahjScriptCode = 160, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ ahomScriptCode = 161, @@ -254,7 +254,7 @@ enum ScriptCodes { siddScriptCode = 166, /** - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ scriptCodeCount }; diff --git a/icu4c/source/layout/LESwaps.h b/icu4c/source/layout/LESwaps.h index f1051ad494a..1d37db17215 100644 --- a/icu4c/source/layout/LESwaps.h +++ b/icu4c/source/layout/LESwaps.h @@ -20,7 +20,7 @@ U_NAMESPACE_BEGIN * A convenience macro which invokes the swapWord member function * from a concise call. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define SWAPW(value) LESwaps::swapWord((le_uint16)(value)) @@ -28,7 +28,7 @@ U_NAMESPACE_BEGIN * A convenience macro which invokes the swapLong member function * from a concise call. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define SWAPL(value) LESwaps::swapLong((le_uint32)(value)) @@ -39,7 +39,7 @@ U_NAMESPACE_BEGIN * All methods are static and inline in an attempt to induce the compiler * to do most of the calculations at compile time. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ class U_LAYOUT_API LESwaps /* not : public UObject because all methods are static */ { public: @@ -52,7 +52,7 @@ public: * * @return the byte swapped word * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static le_uint16 swapWord(le_uint16 value) { @@ -76,7 +76,7 @@ public: * * @return the byte swapped long * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static le_uint32 swapLong(le_uint32 value) { diff --git a/icu4c/source/layout/LETypes.h b/icu4c/source/layout/LETypes.h index 67fa5e9dcb0..c8d0f4037c3 100644 --- a/icu4c/source/layout/LETypes.h +++ b/icu4c/source/layout/LETypes.h @@ -29,42 +29,42 @@ /** * A type used for signed, 32-bit integers. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef int32_t le_int32; /** * A type used for unsigned, 32-bit integers. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef uint32_t le_uint32; /** * A type used for signed, 16-bit integers. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef int16_t le_int16; /** * A type used for unsigned, 16-bit integers. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef uint16_t le_uint16; /** * A type used for signed, 8-bit integers. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef int8_t le_int8; /** * A type used for unsigned, 8-bit integers. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef uint8_t le_uint8; @@ -72,7 +72,7 @@ typedef uint8_t le_uint8; /** * A type used for boolean values. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef UBool le_bool; @@ -80,7 +80,7 @@ typedef UBool le_bool; /** * Used to represent empty pointers. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define NULL 0 #endif @@ -88,7 +88,7 @@ typedef UBool le_bool; /** * Used for four character tags. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef le_uint32 LETag; @@ -96,7 +96,7 @@ typedef le_uint32 LETag; * Used for 16-bit glyph indices as they're represented * in TrueType font tables. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef le_uint16 TTGlyphID; @@ -107,7 +107,7 @@ typedef le_uint16 TTGlyphID; * order 8 bits are client defined. The LayoutEngine * will never change or look at the client defined bits. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef le_uint32 LEGlyphID; @@ -115,7 +115,7 @@ typedef le_uint32 LEGlyphID; * Used to mask off the glyph ID part of an LEGlyphID. * * @see LEGlyphID - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_GLYPH_MASK 0x0000FFFF @@ -124,7 +124,7 @@ typedef le_uint32 LEGlyphID; * into the low-order bits. * * @see LEGlyphID - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_GLYPH_SHIFT 0 @@ -133,7 +133,7 @@ typedef le_uint32 LEGlyphID; * Used to mask off the sub-font ID part of an LEGlyphID. * * @see LEGlyphID - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_SUB_FONT_MASK 0x00FF0000 @@ -142,7 +142,7 @@ typedef le_uint32 LEGlyphID; * into the low-order bits. * * @see LEGlyphID - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_SUB_FONT_SHIFT 16 @@ -151,7 +151,7 @@ typedef le_uint32 LEGlyphID; * Used to mask off the client-defined part of an LEGlyphID. * * @see LEGlyphID - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_CLIENT_MASK 0xFF000000 @@ -160,7 +160,7 @@ typedef le_uint32 LEGlyphID; * into the low-order bits. * * @see LEGlyphID - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_CLIENT_SHIFT 24 @@ -169,7 +169,7 @@ typedef le_uint32 LEGlyphID; * A convenience macro to get the Glyph ID part of an LEGlyphID. * * @see LEGlyphID - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_GET_GLYPH(gid) ((gid & LE_GLYPH_MASK) >> LE_GLYPH_SHIFT) @@ -177,7 +177,7 @@ typedef le_uint32 LEGlyphID; * A convenience macro to get the sub-font ID part of an LEGlyphID. * * @see LEGlyphID - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_GET_SUB_FONT(gid) ((gid & LE_SUB_FONT_MASK) >> LE_SUB_FONT_SHIFT) @@ -185,7 +185,7 @@ typedef le_uint32 LEGlyphID; * A convenience macro to get the client-defined part of an LEGlyphID. * * @see LEGlyphID - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_GET_CLIENT(gid) ((gid & LE_CLIENT_MASK) >> LE_CLIENT_SHIFT) @@ -194,7 +194,7 @@ typedef le_uint32 LEGlyphID; * A convenience macro to set the Glyph ID part of an LEGlyphID. * * @see LEGlyphID - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_SET_GLYPH(gid, glyph) ((gid & ~LE_GLYPH_MASK) | ((glyph << LE_GLYPH_SHIFT) & LE_GLYPH_MASK)) @@ -202,7 +202,7 @@ typedef le_uint32 LEGlyphID; * A convenience macro to set the sub-font ID part of an LEGlyphID. * * @see LEGlyphID - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_SET_SUB_FONT(gid, font) ((gid & ~LE_SUB_FONT_MASK) | ((font << LE_SUB_FONT_SHIFT) & LE_SUB_FONT_MASK)) @@ -210,7 +210,7 @@ typedef le_uint32 LEGlyphID; * A convenience macro to set the client-defined part of an LEGlyphID. * * @see LEGlyphID - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_SET_CLIENT(gid, client) ((gid & ~LE_CLIENT_MASK) | ((client << LE_CLIENT_SHIFT) & LE_CLIENT_MASK)) @@ -218,14 +218,14 @@ typedef le_uint32 LEGlyphID; /** * Used to represent 16-bit Unicode code points. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef UChar LEUnicode16; /** * Used to represent 32-bit Unicode code points. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef UChar32 LEUnicode32; @@ -233,7 +233,7 @@ typedef UChar32 LEUnicode32; /** * Used to represent 16-bit Unicode code points. * - * @deprecated since ICU 2.4. Use LEUnicode16 instead + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef UChar LEUnicode; #endif /* U_HIDE_DEPRECATED_API */ @@ -241,21 +241,21 @@ typedef UChar LEUnicode; /** * Used to hold a pair of (x, y) values which represent a point. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ struct LEPoint { /** * The x coordinate of the point. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ float fX; /** * The y coordinate of the point. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ float fY; }; @@ -264,7 +264,7 @@ struct LEPoint /** * Used to hold a pair of (x, y) values which represent a point. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef struct LEPoint LEPoint; #endif @@ -406,7 +406,7 @@ typedef struct LEPoint LEPoint; * WARNING: THIS MACRO WILL ONLY WORK CORRECTLY IF * THE ARGUMENT CHARACTERS ARE ASCII. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_MAKE_TAG(a, b, c, d) \ (((le_uint32)(a) << 24) | \ @@ -418,7 +418,7 @@ typedef struct LEPoint LEPoint; * This enumeration defines constants for the standard * TrueType, OpenType and AAT table tags. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ enum LETableTags { LE_ACNT_TABLE_TAG = 0x61636E74UL, /**< 'acnt' */ @@ -480,7 +480,7 @@ enum LETableTags { * This enumeration defines constants for all * the common OpenType feature tags. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ enum LEFeatureTags { LE_AALT_FEATURE_TAG = 0x61616C74UL, /**< 'aalt' */ @@ -682,7 +682,7 @@ enum LEFeatureENUMs { /** * Error codes returned by the LayoutEngine. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ enum LEErrorCode { /* informational */ @@ -705,7 +705,7 @@ enum LEErrorCode { /** * Error codes returned by the LayoutEngine. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ typedef enum LEErrorCode LEErrorCode; #endif @@ -713,14 +713,14 @@ typedef enum LEErrorCode LEErrorCode; /** * A convenience macro to test for the success of a LayoutEngine call. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_SUCCESS(code) (U_SUCCESS((UErrorCode)code)) /** * A convenience macro to test for the failure of a LayoutEngine call. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ #define LE_FAILURE(code) (U_FAILURE((UErrorCode)code)) diff --git a/icu4c/source/layout/LayoutEngine.h b/icu4c/source/layout/LayoutEngine.h index ff2dcb173fe..91e6027e7d4 100644 --- a/icu4c/source/layout/LayoutEngine.h +++ b/icu4c/source/layout/LayoutEngine.h @@ -19,6 +19,10 @@ class LEGlyphFilter; class LEGlyphStorage; /** + * NOTE: This class is deprecated, please instead use HarfBuzz. + * See: http://www.freedesktop.org/wiki/Software/HarfBuzz/ + * and http://userguide.icu-project.org/layoutengine + * * This is a virtual base class used to do complex text layout. The text must all * be in a single font, script, and language. An instance of a LayoutEngine can be * created by calling the layoutEngineFactory method. Fonts are identified by @@ -59,7 +63,8 @@ class LEGlyphStorage; * @see LEFontInstance * @see ScriptAndLanguageTags.h * - * @deprecated please use HarfBuzz instead. + * @deprecated ICU 54. See {@link LayoutEngine} + * Instead, please use HarfBuzz. * see http://www.freedesktop.org/wiki/Software/HarfBuzz/ * and http://userguide.icu-project.org/layoutengine */ @@ -263,7 +268,7 @@ protected: virtual const void *getFontTable(LETag tableTag, size_t &length) const; /** - * @deprecated + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual const void *getFontTable(LETag tableTag) const { size_t ignored; return getFontTable(tableTag, ignored); } @@ -338,7 +343,7 @@ public: * method. It is declared virtual so that it will be invoked by the * subclass destructors. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual ~LayoutEngine(); @@ -365,7 +370,7 @@ public: * method first to free the glyph, character index and position arrays * allocated by the previous call. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual le_int32 layoutChars(const LEUnicode chars[], le_int32 offset, le_int32 count, le_int32 max, le_bool rightToLeft, float x, float y, LEErrorCode &success); @@ -376,7 +381,7 @@ public: * * @return the number of glyphs in the glyph array * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ le_int32 getGlyphCount() const; @@ -388,7 +393,7 @@ public: * @param glyphs - the destiniation glyph array * @param success - set to an error code if the operation fails * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void getGlyphs(LEGlyphID glyphs[], LEErrorCode &success) const; @@ -402,7 +407,7 @@ public: * @param extraBits - this value will be ORed with each glyph index * @param success - set to an error code if the operation fails * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual void getGlyphs(le_uint32 glyphs[], le_uint32 extraBits, LEErrorCode &success) const; @@ -414,7 +419,7 @@ public: * @param charIndices - the destiniation character index array * @param success - set to an error code if the operation fails * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void getCharIndices(le_int32 charIndices[], LEErrorCode &success) const; @@ -427,7 +432,7 @@ public: * @param indexBase - an offset which will be added to each index * @param success - set to an error code if the operation fails * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void getCharIndices(le_int32 charIndices[], le_int32 indexBase, LEErrorCode &success) const; @@ -440,7 +445,7 @@ public: * @param positions - the destiniation position array * @param success - set to an error code if the operation fails * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void getGlyphPositions(float positions[], LEErrorCode &success) const; @@ -456,7 +461,7 @@ public: * @param y - the glyph's Y position * @param success - set to an error code if the operation fails * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ void getGlyphPosition(le_int32 glyphIndex, float &x, float &y, LEErrorCode &success) const; @@ -465,7 +470,7 @@ public: * so that the LayoutEngine can be reused to layout a different * characer array. (This method is also called by the destructor) * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual void reset(); @@ -483,27 +488,27 @@ public: * * @see LEFontInstance * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static LayoutEngine *layoutEngineFactory(const LEFontInstance *fontInstance, le_int32 scriptCode, le_int32 languageCode, LEErrorCode &success); /** * Override of existing call that provides flags to control typography. - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static LayoutEngine *layoutEngineFactory(const LEFontInstance *fontInstance, le_int32 scriptCode, le_int32 languageCode, le_int32 typo_flags, LEErrorCode &success); /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/LigatureSubstProc.h b/icu4c/source/layout/LigatureSubstProc.h index d98132eb493..0069aaf8e19 100644 --- a/icu4c/source/layout/LigatureSubstProc.h +++ b/icu4c/source/layout/LigatureSubstProc.h @@ -39,14 +39,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/LigatureSubstProc2.h b/icu4c/source/layout/LigatureSubstProc2.h index b55d68e79da..a338e3a8ef7 100644 --- a/icu4c/source/layout/LigatureSubstProc2.h +++ b/icu4c/source/layout/LigatureSubstProc2.h @@ -40,14 +40,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/OpenTypeLayoutEngine.h b/icu4c/source/layout/OpenTypeLayoutEngine.h index 10d737454d5..e975fa5467c 100644 --- a/icu4c/source/layout/OpenTypeLayoutEngine.h +++ b/icu4c/source/layout/OpenTypeLayoutEngine.h @@ -129,14 +129,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/SegmentArrayProcessor.h b/icu4c/source/layout/SegmentArrayProcessor.h index 0be80698d0a..80dec71c68f 100644 --- a/icu4c/source/layout/SegmentArrayProcessor.h +++ b/icu4c/source/layout/SegmentArrayProcessor.h @@ -34,14 +34,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/SegmentArrayProcessor2.h b/icu4c/source/layout/SegmentArrayProcessor2.h index 4927a8cb879..3e28351e5ef 100644 --- a/icu4c/source/layout/SegmentArrayProcessor2.h +++ b/icu4c/source/layout/SegmentArrayProcessor2.h @@ -34,14 +34,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/SegmentSingleProcessor.h b/icu4c/source/layout/SegmentSingleProcessor.h index a0908e73401..85fddc057a9 100644 --- a/icu4c/source/layout/SegmentSingleProcessor.h +++ b/icu4c/source/layout/SegmentSingleProcessor.h @@ -34,14 +34,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/SegmentSingleProcessor2.h b/icu4c/source/layout/SegmentSingleProcessor2.h index cc4022032f5..856c9b2e28f 100644 --- a/icu4c/source/layout/SegmentSingleProcessor2.h +++ b/icu4c/source/layout/SegmentSingleProcessor2.h @@ -34,14 +34,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/SimpleArrayProcessor.h b/icu4c/source/layout/SimpleArrayProcessor.h index dfb00f2895d..04bb1c7c22d 100644 --- a/icu4c/source/layout/SimpleArrayProcessor.h +++ b/icu4c/source/layout/SimpleArrayProcessor.h @@ -34,14 +34,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/SimpleArrayProcessor2.h b/icu4c/source/layout/SimpleArrayProcessor2.h index 504f76e6ccf..a702bc88024 100644 --- a/icu4c/source/layout/SimpleArrayProcessor2.h +++ b/icu4c/source/layout/SimpleArrayProcessor2.h @@ -34,14 +34,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/SingleTableProcessor.h b/icu4c/source/layout/SingleTableProcessor.h index 6491a0346fa..d8beb4cd1ad 100644 --- a/icu4c/source/layout/SingleTableProcessor.h +++ b/icu4c/source/layout/SingleTableProcessor.h @@ -34,14 +34,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/SingleTableProcessor2.h b/icu4c/source/layout/SingleTableProcessor2.h index 528ad312856..af8277a43b4 100644 --- a/icu4c/source/layout/SingleTableProcessor2.h +++ b/icu4c/source/layout/SingleTableProcessor2.h @@ -34,14 +34,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/ThaiLayoutEngine.h b/icu4c/source/layout/ThaiLayoutEngine.h index f6408491ecc..d5441a2e7a3 100644 --- a/icu4c/source/layout/ThaiLayoutEngine.h +++ b/icu4c/source/layout/ThaiLayoutEngine.h @@ -56,14 +56,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/TrimmedArrayProcessor.h b/icu4c/source/layout/TrimmedArrayProcessor.h index 7a09ae2d84f..66481f999ea 100644 --- a/icu4c/source/layout/TrimmedArrayProcessor.h +++ b/icu4c/source/layout/TrimmedArrayProcessor.h @@ -34,14 +34,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); diff --git a/icu4c/source/layout/TrimmedArrayProcessor2.h b/icu4c/source/layout/TrimmedArrayProcessor2.h index d9d95572ba8..f14d5cb3d27 100644 --- a/icu4c/source/layout/TrimmedArrayProcessor2.h +++ b/icu4c/source/layout/TrimmedArrayProcessor2.h @@ -34,14 +34,14 @@ public: /** * ICU "poor man's RTTI", returns a UClassID for the actual class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ virtual UClassID getDynamicClassID() const; /** * ICU "poor man's RTTI", returns a UClassID for this class. * - * @deprecated see {@link LayoutEngine} + * @deprecated ICU 54. See {@link LayoutEngine} */ static UClassID getStaticClassID(); -- 2.40.0