[backend/mutex] Update Doxygen documentation.
authorMaximilian Wilhelm <max@rfc2324.org>
Thu, 14 Jan 2010 18:25:02 +0000 (19:25 +0100)
committerMaximilian Wilhelm <max@rfc2324.org>
Thu, 14 Jan 2010 18:25:02 +0000 (19:25 +0100)
Signed-off-by: Maximilian Wilhelm <max@rfc2324.org>

backend/mutex/mutex.h
backend/mutex/none/mutex.c
backend/mutex/pthread/mutex.c

index 21fe756..ee4dfa3 100644 (file)
@@ -2,6 +2,7 @@
  * mutex.h: Internal mutex backend for Virtualized Supercomputer Management
  *
  * Copyright (C) 2009 Matthias Bolte <matthias.bolte@googlemail.com>
+ * Copyright (C) 2010 Maximilian Wilhelm <max@rfc2324.org>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -49,9 +50,17 @@ _vsc_mgmt_mutex_new_recursive (struct VscError *error);
 void
 _vsc_mgmt_mutex_free (struct VscMgmtMutex **mutex);
 
+/*!
+ * @brief Locks the given mutex.
+ * @internal
+ */
 void
 _vsc_mgmt_mutex_lock (struct VscMgmtMutex *mutex);
 
+/*!
+ * @brief Unlocks the given mutex.
+ * @internal
+ */
 void
 _vsc_mgmt_mutex_unlock (struct VscMgmtMutex *mutex);
 
index 03e6cf2..2552088 100644 (file)
@@ -2,6 +2,7 @@
  * mutex.c: None based mutex backend for Virtualized Supercomputer Management
  *
  * Copyright (C) 2009 Matthias Bolte <matthias.bolte@googlemail.com>
+ * Copyright (C) 2010 Maximilian Wilhelm <max@rfc2324.org>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -83,11 +84,19 @@ _vsc_mgmt_mutex_free (struct VscMgmtMutex **mutex)
        vsc_free (mutex);
 }
 
+/*!
+ * @brief Locks the given mutex.
+ * @internal
+ */
 void
 _vsc_mgmt_mutex_lock (struct VscMgmtMutex *mutex VSC__ATTR__UNUSED)
 {
 }
 
+/*!
+ * @brief Unlocks the given mutex.
+ * @internal
+ */
 void
 _vsc_mgmt_mutex_unlock (struct VscMgmtMutex *mutex VSC__ATTR__UNUSED)
 {
index 27f4079..9ac2f07 100644 (file)
@@ -2,6 +2,7 @@
  * mutex.c: Pthread based mutex backend for Virtualized Supercomputer Management
  *
  * Copyright (C) 2009 Matthias Bolte <matthias.bolte@googlemail.com>
+ * Copyright (C) 2010 Maximilian Wilhelm <max@rfc2324.org>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -130,6 +131,10 @@ _vsc_mgmt_mutex_free (struct VscMgmtMutex **mutex)
        vsc_free (mutex);
 }
 
+/*!
+ * @brief Locks the given mutex.
+ * @internal
+ */
 void
 _vsc_mgmt_mutex_lock (struct VscMgmtMutex *mutex)
 {
@@ -138,6 +143,10 @@ _vsc_mgmt_mutex_lock (struct VscMgmtMutex *mutex)
        pthread_mutex_lock (&mutex->handle);
 }
 
+/*!
+ * @brief Unlocks the given mutex.
+ * @internal
+ */
 void
 _vsc_mgmt_mutex_unlock (struct VscMgmtMutex *mutex)
 {