More Doxygen comments from InSiTo

1 files changed, 29 insertions, 9 deletions

diff --git a/src/core/oid_lookup/oids.h b/src/core/oid_lookup/oids.h
index b5be0e01f..1bf209c61 100644
--- a/src/core/oid_lookup/oids.h
+++ b/src/core/oid_lookup/oids.h
@@ -12,21 +12,41 @@ namespace Botan {
 
 namespace OIDS {
 
-/*************************************************
-* Register an OID to string mapping              *
-*************************************************/
+/**
+* Register an OID to string mapping.
+* @param oid the oid to register
+* @param name the name to be associated with the oid
+*/
 BOTAN_DLL void add_oid(const OID&, const std::string&);
 
-/*************************************************
-* See if an OID exists in the internal table     *
-*************************************************/
+/**
+* See if an OID exists in the internal table.
+* @param oid the oid to check for
+* @return true if the oid is registered
+*/
 BOTAN_DLL bool have_oid(const std::string&);
 
-/*************************************************
-* Perform OID<->string mappings                  *
-*************************************************/
+/**
+* Resolve an OID
+* @param oid the OID to look up
+* @return the name associated with this OID
+*/
 BOTAN_DLL std::string lookup(const OID&);
+
+/**
+* Find the OID to a name. The lookup will be performed in the
+* general OID section of the configuration.
+* @param name the name to resolve
+* @return the OID associated with the specified name
+*/
 BOTAN_DLL OID lookup(const std::string&);
+
+/**
+* Tests whether the specified OID stands for the specified name.
+* @param oid the OID to check
+* @param name the name to check
+* @return true if the specified OID stands for the specified name
+*/
 BOTAN_DLL bool name_of(const OID&, const std::string&);
 
 }