Changeset 1748 for pjproject/trunk/pjlib/include/pj/errno.h

Timestamp:

Jan 25, 2008 4:06:33 PM (16 years ago)

Author:

bennylp

Message:

Fixed doxygen comments everywhere

File:

• pjproject/trunk/pjlib/include/pj/errno.h (modified) (2 diffs)

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

@@ -112 +112 @@
                                char *buf, pj_size_t bufsize);
 
-typedef pj_str_t (*pjsip_error_callback)(pj_status_t, char*, pj_size_t);
+/**
+ * Type of callback to be specified in #pj_register_strerror()
+ *
+ * @param e         The error code to lookup.
+ * @param msg       Buffer to store the error message.
+ * @param max       Length of the buffer.
+ *
+ * @return          The error string.
+ */
+typedef pj_str_t (*pj_error_callback)(pj_status_t e, char *msg, pj_size_t max);
+
+
 /**
  * Register strerror message handler for the specified error space.
@@ -134 +145 @@
 PJ_DECL(pj_status_t) pj_register_strerror(pj_status_t start_code,
                                           pj_status_t err_space,
-                                          pjsip_error_callback f);
+                                          pj_error_callback f);
 
 /**