ICU-8.11.tar.gz

[apple/icu.git] / icuSources / common / unicode / usprep.h

diff --git a/icuSources/common/unicode/usprep.h b/icuSources/common/unicode/usprep.h
index 5bedc11fdeffb7c33a9e1ed0326f5388a50c6068..c7e75a53fabb69b9c13a17acbf5bd55bbc072852 100644 (file)
--- a/icuSources/common/unicode/usprep.h
+++ b/icuSources/common/unicode/usprep.h
@@ -1,7 +1,7 @@
 /*
  *******************************************************************************
  *
 /*
  *******************************************************************************
  *

- *   Copyright (C) 2003-2004, International Business Machines
+ *   Copyright (C) 2003-2006, International Business Machines

  *   Corporation and others.  All Rights Reserved.
  *
  *******************************************************************************
  *   Corporation and others.  All Rights Reserved.
  *
  *******************************************************************************


@@ -17,9 +17,14 @@
 #ifndef __USPREP_H__
 #define __USPREP_H__
 
 #ifndef __USPREP_H__
 #define __USPREP_H__
 

+/**
+ * \file 
+ * \brief C API: Implements the StringPrep algorithm.
+ */
+

 #include "unicode/utypes.h"
 /**
 #include "unicode/utypes.h"
 /**

- *\file
+ *

  * StringPrep API implements the StingPrep framework as described by RFC 3454.
  * StringPrep prepares Unicode strings for use in network protocols.
  * Profiles of StingPrep are set of rules and data according to with the
  * StringPrep API implements the StingPrep framework as described by RFC 3454.
  * StringPrep prepares Unicode strings for use in network protocols.
  * Profiles of StingPrep are set of rules and data according to with the


@@ -54,11 +59,9 @@
 
 #include "unicode/parseerr.h"
 
 
 #include "unicode/parseerr.h"
 

-#ifndef U_HIDE_DRAFT_API
-

 /**
  * The StringPrep profile
 /**
  * The StringPrep profile

- * @draft ICU 2.8
+ * @stable ICU 2.8

  */
 typedef struct UStringPrepProfile UStringPrepProfile;
 
  */
 typedef struct UStringPrepProfile UStringPrepProfile;
 


@@ -67,7 +70,7 @@ typedef struct UStringPrepProfile UStringPrepProfile;
  * Option to prohibit processing of unassigned code points in the input
  * 
  * @see  usprep_prepare
  * Option to prohibit processing of unassigned code points in the input
  * 
  * @see  usprep_prepare

- * @draft ICU 2.8
+ * @stable ICU 2.8

  */
 #define USPREP_DEFAULT 0x0000
 
  */
 #define USPREP_DEFAULT 0x0000
 


@@ -75,13 +78,11 @@ typedef struct UStringPrepProfile UStringPrepProfile;
  * Option to allow processing of unassigned code points in the input
  * 
  * @see  usprep_prepare
  * Option to allow processing of unassigned code points in the input
  * 
  * @see  usprep_prepare

- * @draft ICU 2.8
+ * @stable ICU 2.8

  */
 #define USPREP_ALLOW_UNASSIGNED 0x0001
 
 
  */
 #define USPREP_ALLOW_UNASSIGNED 0x0001
 
 

-#endif /*U_HIDE_DRAFT_API*/
-

 /**
  * Creates a StringPrep profile from the data file.
  *
 /**
  * Creates a StringPrep profile from the data file.
  *


@@ -95,9 +96,9 @@ typedef struct UStringPrepProfile UStringPrepProfile;
  * @return Pointer to UStringPrepProfile that is opened. Should be closed by
  * calling usprep_close()
  * @see usprep_close()
  * @return Pointer to UStringPrepProfile that is opened. Should be closed by
  * calling usprep_close()
  * @see usprep_close()

- * @draft ICU 2.8
+ * @stable ICU 2.8

  */
  */

-U_DRAFT UStringPrepProfile* U_EXPORT2
+U_STABLE UStringPrepProfile* U_EXPORT2

 usprep_open(const char* path, 
             const char* fileName,
             UErrorCode* status);
 usprep_open(const char* path, 
             const char* fileName,
             UErrorCode* status);


@@ -106,9 +107,9 @@ usprep_open(const char* path,
 /**
  * Closes the profile
  * @param profile The profile to close
 /**
  * Closes the profile
  * @param profile The profile to close

- * @draft ICU 2.8
+ * @stable ICU 2.8

  */
  */

-U_DRAFT void U_EXPORT2
+U_STABLE void U_EXPORT2

 usprep_close(UStringPrepProfile* profile);
 
 
 usprep_close(UStringPrepProfile* profile);
 
 


@@ -138,10 +139,10 @@ usprep_close(UStringPrepProfile* profile);
  *                          too many code points.
  *                          U_BUFFER_OVERFLOW_ERROR if destCapacity is not enough
  * @return The number of UChars in the destination buffer
  *                          too many code points.
  *                          U_BUFFER_OVERFLOW_ERROR if destCapacity is not enough
  * @return The number of UChars in the destination buffer

- * @draft ICU 2.8
+ * @stable ICU 2.8

  */
 
  */
 

-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2

 usprep_prepare(   const UStringPrepProfile* prep,
                   const UChar* src, int32_t srcLength, 
                   UChar* dest, int32_t destCapacity,
 usprep_prepare(   const UStringPrepProfile* prep,
                   const UChar* src, int32_t srcLength, 
                   UChar* dest, int32_t destCapacity,