doc: Convert documentation to Doxygen

Automated conversion based on a few regexes.

threads.c

@@ -48,8 +48,7 @@
 static xmlRMutex xmlLibraryLock;
 
 /**
- * xmlInitMutex:
- * @mutex:  the mutex
+ * @param mutex  the mutex
  *
  * Initialize a mutex.
  */
@@ -66,12 +65,11 @@ xmlInitMutex(xmlMutexPtr mutex)
 }
 
 /**
- * xmlNewMutex:
  *
  * xmlNewMutex() is used to allocate a libxml2 token struct for use in
  * synchronizing access to data.
  *
- * Returns a new simple mutex pointer or NULL in case of error
+ * @returns a new simple mutex pointer or NULL in case of error
  */
 xmlMutexPtr
 xmlNewMutex(void)
@@ -86,8 +84,7 @@ xmlNewMutex(void)
 }
 
 /**
- * xmlCleanupMutex:
- * @mutex:  the simple mutex
+ * @param mutex  the simple mutex
  *
  * Reclaim resources associated with a mutex.
  */
@@ -104,8 +101,7 @@ xmlCleanupMutex(xmlMutexPtr mutex)
 }
 
 /**
- * xmlFreeMutex:
- * @tok:  the simple mutex
+ * @param tok  the simple mutex
  *
  * Free a mutex.
  */
@@ -120,8 +116,7 @@ xmlFreeMutex(xmlMutexPtr tok)
 }
 
 /**
- * xmlMutexLock:
- * @tok:  the simple mutex
+ * @param tok  the simple mutex
  *
  * xmlMutexLock() is used to lock a libxml2 token.
  */
@@ -143,8 +138,7 @@ xmlMutexLock(xmlMutexPtr tok)
 }
 
 /**
- * xmlMutexUnlock:
- * @tok:  the simple mutex
+ * @param tok  the simple mutex
  *
  * xmlMutexUnlock() is used to unlock a libxml2 token.
  */
@@ -161,8 +155,7 @@ xmlMutexUnlock(xmlMutexPtr tok)
 }
 
 /**
- * xmlInitRMutex:
- * @tok:  mutex
+ * @param tok  mutex
  *
  * Initialize the mutex.
  */
@@ -181,14 +174,13 @@ xmlInitRMutex(xmlRMutexPtr tok) {
 }
 
 /**
- * xmlNewRMutex:
  *
  * xmlRNewMutex() is used to allocate a reentrant mutex for use in
  * synchronizing access to data. token_r is a re-entrant lock and thus useful
  * for synchronizing access to data structures that may be manipulated in a
  * recursive fashion.
  *
- * Returns the new reentrant mutex pointer or NULL in case of error
+ * @returns the new reentrant mutex pointer or NULL in case of error
  */
 xmlRMutexPtr
 xmlNewRMutex(void)
@@ -203,8 +195,7 @@ xmlNewRMutex(void)
 }
 
 /**
- * xmlCleanupRMutex:
- * @tok:  mutex
+ * @param tok  mutex
  *
  * Cleanup the mutex.
  */
@@ -221,8 +212,7 @@ xmlCleanupRMutex(xmlRMutexPtr tok) {
 }
 
 /**
- * xmlFreeRMutex:
- * @tok:  the reentrant mutex
+ * @param tok  the reentrant mutex
  *
  * xmlRFreeMutex() is used to reclaim resources associated with a
  * reentrant mutex.
@@ -237,8 +227,7 @@ xmlFreeRMutex(xmlRMutexPtr tok)
 }
 
 /**
- * xmlRMutexLock:
- * @tok:  the reentrant mutex
+ * @param tok  the reentrant mutex
  *
  * xmlRMutexLock() is used to lock a libxml2 token_r.
  */
@@ -270,8 +259,7 @@ xmlRMutexLock(xmlRMutexPtr tok)
 }
 
 /**
- * xmlRMutexUnlock:
- * @tok:  the reentrant mutex
+ * @param tok  the reentrant mutex
  *
  * xmlRMutexUnlock() is used to unlock a libxml2 token_r.
  */
@@ -301,7 +289,6 @@ xmlRMutexUnlock(xmlRMutexPtr tok ATTRIBUTE_UNUSED)
  ************************************************************************/
 
 /**
- * xmlLockLibrary:
  *
  * xmlLockLibrary() is used to take out a re-entrant lock on the libxml2
  * library.
@@ -313,7 +300,6 @@ xmlLockLibrary(void)
 }
 
 /**
- * xmlUnlockLibrary:
  *
  * xmlUnlockLibrary() is used to release a re-entrant lock on the libxml2
  * library.
@@ -325,9 +311,8 @@ xmlUnlockLibrary(void)
 }
 
 /**
- * xmlInitThreads:
  *
- * DEPRECATED: Alias for xmlInitParser.
+ * @deprecated Alias for xmlInitParser.
  */
 void
 xmlInitThreads(void)
@@ -336,9 +321,8 @@ xmlInitThreads(void)
 }
 
 /**
- * xmlCleanupThreads:
  *
- * DEPRECATED: This function is a no-op. Call xmlCleanupParser
+ * @deprecated This function is a no-op. Call xmlCleanupParser
  * to free global state but see the warnings there. xmlCleanupParser
  * should be only called once at program exit. In most cases, you don't
  * have call cleanup functions at all.
@@ -407,7 +391,6 @@ xmlInitParserWinWrapper(INIT_ONCE *initOnce ATTRIBUTE_UNUSED,
 #endif
 
 /**
- * xmlInitParser:
  *
  * Initialization function for the XML parser.
  *
@@ -433,7 +416,6 @@ xmlInitParser(void) {
 }
 
 /**
- * xmlCleanupParser:
  *
  * This function is named somewhat misleadingly. It does not clean up
  * parser state but global memory allocated by the library itself.