From: Adam Dickmeiss <adam@indexdata.dk>
Date: Tue, 22 Jul 2008 18:17:08 +0000 (+0200)
Subject: Comment OID utilities.
X-Git-Tag: v3.0.36~9
X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=commitdiff_plain;h=6aa3a97ba632e1507ca00a98b8e45567e51e51e6

Comment OID utilities.
---

diff --git a/include/yaz/oid_util.h b/include/yaz/oid_util.h
index c201225..c2ad635 100644
--- a/include/yaz/oid_util.h
+++ b/include/yaz/oid_util.h
@@ -51,11 +51,50 @@ typedef enum oid_proto
     PROTO_HTTP
 } oid_proto;
 
+
+/** \brief copies OID
+    \param t destination OID
+    \param s source OID
+*/
 YAZ_EXPORT void oid_oidcpy(Odr_oid *t, const Odr_oid *s);
+
+/** \brief appends to OID
+    \param t destination OID
+    \param s source OID
+*/
 YAZ_EXPORT void oid_oidcat(Odr_oid *t, const Odr_oid *s);
+
+
+/** \brief compares OIDs
+    \param o1 first OID
+    \param o2 second OID
+    \retval 0 equal
+    \retval >0 o1 greater than o2
+    \retval <0 o1 less than o2
+*/
 YAZ_EXPORT int oid_oidcmp(const Odr_oid *o1, const Odr_oid *o2);
+
+
+/** \brief returns length of OIDs
+    \param o OID
+    \returns length as number of Odr_oids
+*/
 YAZ_EXPORT int oid_oidlen(const Odr_oid *o);
+
+/** \brief converts OID to string (dot notation)
+    \param oid OID
+    \param oidbuf resulting buffer which should be at least of size OID_STR_MAX
+    \returns result (same as oidbuf)
+*/
 YAZ_EXPORT char *oid_oid_to_dotstring(const Odr_oid *oid, char *oidbuf);
+
+
+/** \brief converts dot string to OID
+    \param name dot string OID, e.g. "1.2.840.10003.2.1"
+    \param oid resulting OID buffer which should be at least of size OID_SIZE
+    \retval 0 OK
+    \retval -1 failure
+*/
 YAZ_EXPORT int oid_dotstring_to_oid(const char *name, Odr_oid *oid);
 
 YAZ_END_CDECL