Skip to content

Commit

Permalink
Change @internal to @Preview for existing tech preview sites
Browse files Browse the repository at this point in the history
  • Loading branch information
srl295 committed Aug 2, 2018
1 parent ea2cb4b commit dac91d1
Show file tree
Hide file tree
Showing 11 changed files with 111 additions and 111 deletions.
50 changes: 25 additions & 25 deletions icu4c/source/common/unicode/icuplug.h
Expand Up @@ -100,7 +100,7 @@
* SHOULD call uplug_setPlugName to indicate a human readable plugin name.</li></ol>
*
*
* \internal ICU 4.4 Technology Preview
* \preview ICU 4.4
*/


Expand All @@ -121,7 +121,7 @@
* @{
* Opaque structure passed to/from a plugin.
* use the APIs to access it.
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/

struct UPlugData;
Expand All @@ -132,13 +132,13 @@ typedef struct UPlugData UPlugData;
/**
* Random Token to identify a valid ICU plugin. Plugins must return this
* from the entrypoint.
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
#define UPLUG_TOKEN 0x54762486

/**
* Max width of names, symbols, and configuration strings
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
#define UPLUG_NAME_MAX 100

Expand All @@ -147,13 +147,13 @@ typedef struct UPlugData UPlugData;
* Return value from a plugin entrypoint.
* Must always be set to UPLUG_TOKEN
* @see UPLUG_TOKEN
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
typedef uint32_t UPlugTokenReturn;

/**
* Reason code for the entrypoint's call
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
typedef enum {
UPLUG_REASON_QUERY = 0, /**< The plugin is being queried for info. **/
Expand All @@ -172,7 +172,7 @@ typedef enum {
* INITIAL: UNKNOWN
* QUERY: INVALID -> { LOW | HIGH }
* ERR -> INVALID
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
typedef enum {
UPLUG_LEVEL_INVALID = 0, /**< The plugin is invalid, hasn't called uplug_setLevel, or can't load. **/
Expand All @@ -191,7 +191,7 @@ typedef enum {
* @param plug the UPlugData handle.
* @param status the plugin's extended status code.
* @return A valid plugin must return UPLUG_TOKEN
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
typedef UPlugTokenReturn (U_EXPORT2 UPlugEntrypoint) (
UPlugData *plug,
Expand All @@ -206,7 +206,7 @@ typedef UPlugTokenReturn (U_EXPORT2 UPlugEntrypoint) (
* @see u_cleanup()
* @param plug plugin
* @param dontUnload set true if this plugin can't be unloaded
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL void U_EXPORT2
uplug_setPlugNoUnload(UPlugData *plug, UBool dontUnload);
Expand All @@ -215,7 +215,7 @@ uplug_setPlugNoUnload(UPlugData *plug, UBool dontUnload);
* Set the level of this plugin.
* @param plug plugin data handle
* @param level the level of this plugin
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL void U_EXPORT2
uplug_setPlugLevel(UPlugData *plug, UPlugLevel level);
Expand All @@ -224,7 +224,7 @@ uplug_setPlugLevel(UPlugData *plug, UPlugLevel level);
* Get the level of this plugin.
* @param plug plugin data handle
* @return the level of this plugin
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL UPlugLevel U_EXPORT2
uplug_getPlugLevel(UPlugData *plug);
Expand All @@ -234,7 +234,7 @@ uplug_getPlugLevel(UPlugData *plug);
* For example, if UPLUG_LEVEL_LOW is returned, then low level plugins may load
* if UPLUG_LEVEL_HIGH is returned, then only high level plugins may load.
* @return the lowest level of plug which can currently load
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL UPlugLevel U_EXPORT2
uplug_getCurrentLevel(void);
Expand All @@ -243,7 +243,7 @@ uplug_getCurrentLevel(void);
/**
* Get plug load status
* @return The error code of this plugin's load attempt.
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL UErrorCode U_EXPORT2
uplug_getPlugLoadStatus(UPlugData *plug);
Expand All @@ -252,7 +252,7 @@ uplug_getPlugLoadStatus(UPlugData *plug);
* Set the human-readable name of this plugin.
* @param plug plugin data handle
* @param name the name of this plugin. The first UPLUG_NAME_MAX characters willi be copied into a new buffer.
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL void U_EXPORT2
uplug_setPlugName(UPlugData *plug, const char *name);
Expand All @@ -261,7 +261,7 @@ uplug_setPlugName(UPlugData *plug, const char *name);
* Get the human-readable name of this plugin.
* @param plug plugin data handle
* @return the name of this plugin
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL const char * U_EXPORT2
uplug_getPlugName(UPlugData *plug);
Expand All @@ -270,7 +270,7 @@ uplug_getPlugName(UPlugData *plug);
* Return the symbol name for this plugin, if known.
* @param plug plugin data handle
* @return the symbol name, or NULL
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL const char * U_EXPORT2
uplug_getSymbolName(UPlugData *plug);
Expand All @@ -280,7 +280,7 @@ uplug_getSymbolName(UPlugData *plug);
* @param plug plugin data handle
* @param status error code
* @return the library name, or NULL
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL const char * U_EXPORT2
uplug_getLibraryName(UPlugData *plug, UErrorCode *status);
Expand All @@ -290,7 +290,7 @@ uplug_getLibraryName(UPlugData *plug, UErrorCode *status);
* Plugins could use this to load data out of their
* @param plug plugin data handle
* @return the library, or NULL
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL void * U_EXPORT2
uplug_getLibrary(UPlugData *plug);
Expand All @@ -299,7 +299,7 @@ uplug_getLibrary(UPlugData *plug);
* Return the plugin-specific context data.
* @param plug plugin data handle
* @return the context, or NULL if not set
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL void * U_EXPORT2
uplug_getContext(UPlugData *plug);
Expand All @@ -308,7 +308,7 @@ uplug_getContext(UPlugData *plug);
* Set the plugin-specific context data.
* @param plug plugin data handle
* @param context new context to set
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL void U_EXPORT2
uplug_setContext(UPlugData *plug, void *context);
Expand All @@ -319,7 +319,7 @@ uplug_setContext(UPlugData *plug, void *context);
* The string is in the platform default codepage.
* @param plug plugin data handle
* @return configuration string, or else null.
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL const char * U_EXPORT2
uplug_getConfiguration(UPlugData *plug);
Expand All @@ -337,7 +337,7 @@ uplug_getConfiguration(UPlugData *plug);
* @param prior pass in 'NULL' to get the first (most recent) plug,
* otherwise pass the value returned on a prior call to uplug_nextPlug
* @return the next oldest plugin, or NULL if no more.
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL UPlugData* U_EXPORT2
uplug_nextPlug(UPlugData *prior);
Expand All @@ -352,7 +352,7 @@ uplug_nextPlug(UPlugData *prior);
* @param config user specified configuration string, if available, or NULL.
* @param status error result
* @return the new UPlugData associated with this plugin, or NULL if error.
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL UPlugData* U_EXPORT2
uplug_loadPlugFromEntrypoint(UPlugEntrypoint *entrypoint, const char *config, UErrorCode *status);
Expand All @@ -366,7 +366,7 @@ uplug_loadPlugFromEntrypoint(UPlugEntrypoint *entrypoint, const char *config, UE
* @param config configuration string, or NULL
* @param status error result
* @return the new UPlugData associated with this plugin, or NULL if error.
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL UPlugData* U_EXPORT2
uplug_loadPlugFromLibrary(const char *libName, const char *sym, const char *config, UErrorCode *status);
Expand All @@ -376,7 +376,7 @@ uplug_loadPlugFromLibrary(const char *libName, const char *sym, const char *conf
* Will request the plugin to be unloaded, and close the library if needed
* @param plug plugin handle to close
* @param status error result
* @internal ICU 4.4 Technology Preview
* @preview ICU 4.4
*/
U_INTERNAL void U_EXPORT2
uplug_removePlug(UPlugData *plug, UErrorCode *status);
Expand Down
2 changes: 1 addition & 1 deletion icu4c/source/common/unicode/utext.h
Expand Up @@ -701,7 +701,7 @@ utext_extract(UText *ut,
* Returns U_SENTINEL (-1) if the position is at the end of the
* text.
*
* @internal ICU 4.4 technology preview
* @preview ICU 4.4
*/
#define UTEXT_CURRENT32(ut) \
((ut)->chunkOffset < (ut)->chunkLength && ((ut)->chunkContents)[(ut)->chunkOffset]<0xd800 ? \
Expand Down
8 changes: 4 additions & 4 deletions icu4c/source/i18n/reldtfmt.h
Expand Up @@ -194,23 +194,23 @@ class RelativeDateFormat : public DateFormat {
* date and time formatters associated with this object.
* @param result Output param to receive the pattern.
* @return A reference to 'result'.
* @internal ICU 4.2 technology preview
* @preview ICU 4.2
*/
virtual UnicodeString& toPattern(UnicodeString& result, UErrorCode& status) const;

/**
* Get the date pattern for the the date formatter associated with this object.
* @param result Output param to receive the date pattern.
* @return A reference to 'result'.
* @internal ICU 4.2 technology preview
* @preview ICU 4.2
*/
virtual UnicodeString& toPatternDate(UnicodeString& result, UErrorCode& status) const;

/**
* Get the time pattern for the the time formatter associated with this object.
* @param result Output param to receive the time pattern.
* @return A reference to 'result'.
* @internal ICU 4.2 technology preview
* @preview ICU 4.2
*/
virtual UnicodeString& toPatternTime(UnicodeString& result, UErrorCode& status) const;

Expand All @@ -221,7 +221,7 @@ class RelativeDateFormat : public DateFormat {
*
* @param datePattern The date pattern to be applied.
* @param timePattern The time pattern to be applied.
* @internal ICU 4.2 technology preview
* @preview ICU 4.2
*/
virtual void applyPatterns(const UnicodeString& datePattern, const UnicodeString& timePattern, UErrorCode &status);

Expand Down
20 changes: 10 additions & 10 deletions icu4c/source/i18n/unicode/decimfmt.h
Expand Up @@ -1295,15 +1295,15 @@ class U_I18N_API DecimalFormat : public NumberFormat {
#ifndef U_HIDE_INTERNAL_API
/**
* Whether to show the plus sign on positive (non-negative) numbers; for example, "+12"
* @internal Technical Preview
* @preview
*/
UBool isSignAlwaysShown() const;
#endif /* U_HIDE_INTERNAL_API */

/**
* Set whether to show the plus sign on positive (non-negative) numbers; for example, "+12"
* @param value The new setting for whether to show plus sign on positive numbers
* @internal Technical Preview
* @preview
*/
virtual void setSignAlwaysShown(UBool value);

Expand Down Expand Up @@ -1675,7 +1675,7 @@ class U_I18N_API DecimalFormat : public NumberFormat {
*
* @see setMinimumGroupingDigits
* @see getGroupingSize
* @internal technology preview
* @preview
*/
int32_t getMinimumGroupingDigits() const;

Expand All @@ -1688,7 +1688,7 @@ class U_I18N_API DecimalFormat : public NumberFormat {
*
* @param newValue the new value of minimum grouping digits.
* @see getMinimumGroupingDigits
* @internal technology preview
* @preview
*/
virtual void setMinimumGroupingDigits(int32_t newValue);

Expand Down Expand Up @@ -1736,7 +1736,7 @@ class U_I18N_API DecimalFormat : public NumberFormat {
* Returns whether to ignore exponents when parsing.
*
* @see #setParseNoExponent
* @internal This API is a technical preview. It may change in an upcoming release.
* @preview
*/
virtual UBool isParseNoExponent() const;

Expand All @@ -1746,15 +1746,15 @@ class U_I18N_API DecimalFormat : public NumberFormat {
* 5).
*
* @param value true to prevent exponents from being parsed; false to allow them to be parsed.
* @internal This API is a technical preview. It may change in an upcoming release.
* @preview
*/
virtual void setParseNoExponent(UBool value);

/**
* Returns whether parsing is sensitive to case (lowercase/uppercase).
*
* @see #setParseCaseSensitive
* @internal This API is a technical preview. It may change in an upcoming release.
* @preview
*/
virtual UBool isParseCaseSensitive() const;

Expand All @@ -1765,7 +1765,7 @@ class U_I18N_API DecimalFormat : public NumberFormat {
* Currency symbols are never case-folded. For example, "us$1.00" will not parse in case-insensitive
* mode, even though "US$1.00" parses.
*
* @internal This API is a technical preview. It may change in an upcoming release.
* @preview
*/
virtual void setParseCaseSensitive(UBool value);

Expand All @@ -1774,15 +1774,15 @@ class U_I18N_API DecimalFormat : public NumberFormat {
* By default, setMaximumIntegerDigits truncates high-order digits silently.
*
* @see setFormatFailIfMoreThanMaxDigits
* @internal This API is a technical preview. It may change in an upcoming release.
* @preview
*/
virtual UBool isFormatFailIfMoreThanMaxDigits() const;

/**
* Sets whether truncation of high-order integer digits should result in an error.
* By default, setMaximumIntegerDigits truncates high-order digits silently.
*
* @internal This API is a technical preview. It may change in an upcoming release.
* @preview
*/
virtual void setFormatFailIfMoreThanMaxDigits(UBool value);

Expand Down
6 changes: 3 additions & 3 deletions icu4c/source/i18n/unicode/smpdtfmt.h
Expand Up @@ -1113,21 +1113,21 @@ class U_I18N_API SimpleDateFormat: public DateFormat {
* The caller should not delete the TimeZoneFormat object after
* it is adopted by this call.
* @param timeZoneFormatToAdopt The TimeZoneFormat object to be adopted.
* @internal ICU 49 technology preview
* @preview ICU 49
*/
virtual void adoptTimeZoneFormat(TimeZoneFormat* timeZoneFormatToAdopt);

/**
* Sets the TimeZoneFormat to be used by this date/time formatter.
* @param newTimeZoneFormat The TimeZoneFormat object to copy.
* @internal ICU 49 technology preview
* @preview ICU 49
*/
virtual void setTimeZoneFormat(const TimeZoneFormat& newTimeZoneFormat);

/**
* Gets the time zone format object associated with this date/time formatter.
* @return the time zone format associated with this date/time formatter.
* @internal ICU 49 technology preview
* @preview ICU 49
*/
virtual const TimeZoneFormat* getTimeZoneFormat(void) const;

Expand Down

0 comments on commit dac91d1

Please sign in to comment.