Changeset 514 for pjproject/trunk/pjlib/include/pj/unicode.h

Timestamp:

Jun 16, 2006 4:52:51 PM (18 years ago)

Author:

bennylp

Message:

Fixed pjlib doxygen documentation

File:

• pjproject/trunk/pjlib/include/pj/unicode.h (modified) (4 diffs)

pjproject/trunk/pjlib/include/pj/unicode.h

@@ -22 +22 @@
 #include <pj/types.h>
 
+
+/**
+ * @defgroup PJ_UNICODE Unicode Support
+ * @ingroup PJ_MISC
+ * @{
+ */
 
 PJ_BEGIN_DECL
@@ -61 +67 @@
 #if defined(PJ_NATIVE_STRING_IS_UNICODE) && PJ_NATIVE_STRING_IS_UNICODE!=0
 
+/**
+ * This macro is used to declare temporary Unicode buffer for ANSI to 
+ * Unicode conversion, and should be put in declaration section of a block.
+ * When PJ_NATIVE_STRING_IS_UNICODE macro is not defined, this 
+ * macro will expand to nothing.
+ */
 #   define PJ_DECL_UNICODE_TEMP_BUF(buf,size)   wchar_t buf[size];
+
+/**
+ * This macro will convert ANSI string to native, when the platform's
+ * native string is Unicode (PJ_NATIVE_STRING_IS_UNICODE is non-zero).
+ */
 #   define PJ_STRING_TO_NATIVE(s,buf,max)       pj_ansi_to_unicode( \
                                                     s, strlen(s), \
                                                     buf, max)
+
+/**
+ * This macro is used to declare temporary ANSI buffer for Unicode to 
+ * ANSI conversion, and should be put in declaration section of a block.
+ * When PJ_NATIVE_STRING_IS_UNICODE macro is not defined, this 
+ * macro will expand to nothing.
+ */
 #   define PJ_DECL_ANSI_TEMP_BUF(buf,size)      char buf[size];
+
+
+/**
+ * This macro will convert Unicode string to ANSI, when the platform's
+ * native string is Unicode (PJ_NATIVE_STRING_IS_UNICODE is non-zero).
+ */
 #   define PJ_NATIVE_TO_STRING(cs,buf,max)      pj_unicode_to_ansi( \
                                                     cs, wcslen(cs), \
@@ -72 +102 @@
 #else
 
+/**
+ * This macro is used to declare temporary Unicode buffer for ANSI to 
+ * Unicode conversion, and should be put in declaration section of a block.
+ * When PJ_NATIVE_STRING_IS_UNICODE macro is not defined, this 
+ * macro will expand to nothing.
+ */
 #   define PJ_DECL_UNICODE_TEMP_BUF(var,size)
+/**
+ * This macro will convert ANSI string to native, when the platform's
+ * native string is Unicode (PJ_NATIVE_STRING_IS_UNICODE is non-zero).
+ */
 #   define PJ_STRING_TO_NATIVE(s,buf,max)       ((char*)s)
+/**
+ * This macro is used to declare temporary ANSI buffer for Unicode to 
+ * ANSI conversion, and should be put in declaration section of a block.
+ * When PJ_NATIVE_STRING_IS_UNICODE macro is not defined, this 
+ * macro will expand to nothing.
+ */
 #   define PJ_DECL_ANSI_TEMP_BUF(buf,size)
+/**
+ * This macro will convert Unicode string to ANSI, when the platform's
+ * native string is Unicode (PJ_NATIVE_STRING_IS_UNICODE is non-zero).
+ */
 #   define PJ_NATIVE_TO_STRING(cs,buf,max)      ((char*)(const char*)cs)
 
@@ -83 +133 @@
 PJ_END_DECL
 
+/*
+ * @}
+ */
+
 
 #endif  /* __PJ_UNICODE_H__ */