ipc.c: Cosmetics.
authorAndre Noll <maan@systemlinux.org>
Sat, 12 Apr 2008 18:02:23 +0000 (20:02 +0200)
committerAndre Noll <maan@systemlinux.org>
Sat, 12 Apr 2008 18:02:23 +0000 (20:02 +0200)
ipc.c

diff --git a/ipc.c b/ipc.c
index 40a9057..37d3071 100644 (file)
--- a/ipc.c
+++ b/ipc.c
@@ -4,7 +4,7 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file ipc.c interprocess communication and shared memory helpers */
+/** \file ipc.c Inter-process communication and shared memory helpers. */
 
 #include "para.h"
 #include "error.h"
 #include <sys/sem.h>
 
 /**
- * define a new mutex
+ * Define a new mutex.
  *
- * \return the identifier for the new mutex on success, \a -E_SEM_GET
+ * \return The identifier for the new mutex on success, \a -E_SEM_GET
  * on errors.
  *
- * \sa semget(2)
+ * \sa semget(2).
  */
 int mutex_new(void)
 {
@@ -28,9 +28,9 @@ int mutex_new(void)
 }
 
 /**
- * destroy a mutex
+ * Destroy a mutex.
  *
- * \param id the identifier of the mutex to be destroyed
+ * \param id The identifier of the mutex to be destroyed.
  *
  * \return Positive on success, \a -E_SEM_REMOVE on errors.
  *
@@ -58,13 +58,13 @@ static void para_semop(int id, struct sembuf *sops, int num)
 }
 
 /**
- * lock the given mutex
+ * Lock the given mutex.
  *
- * \param id of the shared memory area to lock
+ * \param id The identifier of the shared memory area to lock.
  *
  * This function either succeeds or aborts.
  *
- * \sa semop(2), struct misc_meta_data
+ * \sa semop(2), struct misc_meta_data.
  */
 void mutex_lock(int id)
 {
@@ -84,13 +84,13 @@ void mutex_lock(int id)
 }
 
 /**
- * unlock a mutex
+ * Unlock a mutex.
  *
- * \param id the identifier of the mutex
+ * \param id The identifier of the mutex.
  *
  * This function either succeeds or aborts.
  *
- * \sa semop(2), struct misc_meta_data
+ * \sa semop(2), struct misc_meta_data.
  */
 void mutex_unlock(int id)
 {
@@ -105,13 +105,13 @@ void mutex_unlock(int id)
 }
 
 /**
- * create a new shared memory area of given size
+ * Create a new shared memory area of given size.
  *
- * \param size the size of the shared memory area to create
+ * \param size The size of the shared memory area to create.
  *
  * \return The id of the shared memory areay on success, \a -E_SHM_GET on errors.
  *
- * \sa shmget(2)
+ * \sa shmget(2).
  */
 int shm_new(size_t size)
 {
@@ -120,14 +120,14 @@ int shm_new(size_t size)
 }
 
 /**
- * destroy the given shared memory area
+ * Destroy the given shared memory area.
  *
- * \param id the shared memory id
+ * \param id The shared memory identifier.
  *
  * \return The return value of the underlying shmctl() call on success,
  * \a -E_SHM_DESTROY on errors.
  *
- * \sa shmctl(2)
+ * \sa shmctl(2).
  */
 int shm_destroy(int id)
 {
@@ -137,15 +137,15 @@ int shm_destroy(int id)
 }
 
 /**
- * attach a shared memory segment
+ * Attach a shared memory segment.
  *
- * \param id the identifier of the shared memory segment to attach
- * \param mode either ATTACH_RO (read only) or ATTACH_RW (read/write)
- * \param result points to the attached area just attached
+ * \param id The identifier of the shared memory segment to attach.
+ * \param mode either ATTACH_RO (read only) or ATTACH_RW (read/write).
+ * \param result points to the attached area just attached.
  *
  * \return positive on success, \a -E_SHM_ATTACH on errors.
  *
- * \sa shmat(2)
+ * \sa shmat(2).
  */
 int shm_attach(int id, enum shm_attach_mode mode, void **result)
 {
@@ -158,13 +158,13 @@ int shm_attach(int id, enum shm_attach_mode mode, void **result)
 }
 
 /**
- * detach a shared memory segment
+ * Detach a shared memory segment.
  *
- * \param addr the address of the attached segment
+ * \param addr The address of the attached segment.
  *
- * \return positive on success, \a -E_SHM_DETACH on errors.
+ * \return Positive on success, \a -E_SHM_DETACH on errors.
  *
- * \sa shmdt(2)
+ * \sa shmdt(2).
  */
 int shm_detach(void *addr)
 {