ipc.c: documentation fixes

diff --git a/ipc.c b/ipc.c
index 49d2d96515dbf49bc5a9f7ace0786d5f68acc936..b6c525ab07311a14dbfaefe637781e163c24dba5 100644 (file)
--- a/ipc.c
+++ b/ipc.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2007 Andre Noll <maan@systemlinux.org>
  *
  *     This program is free software; you can redistribute it and/or modify
  *     it under the terms of the GNU General Public License as published by
@@ -31,7 +31,7 @@
 /**
  * define a new mutex
  *
- * \return the identifier for the new mutex on success, -E_SEM_GET
+ * \return the identifier for the new mutex on success, \a -E_SEM_GET
  * on errors.
  *
  * \sa semget(2)
@@ -47,7 +47,7 @@ int mutex_new(void)
  *
  * \param id the identifier of the mutex to be destroyed
  *
- * \returns Positive on success, -E_SEM_REMOVE on errors.
+ * \return Positive on success, \a -E_SEM_REMOVE on errors.
  *
  * \sa semctl(2)
  */
@@ -71,6 +71,8 @@ static void para_semop(int id, struct sembuf *sops, int num)
 /**
  * lock the given mutex
  *
+ * \param id of the shared memory area to lock
+ *
  * This function either succeeds or aborts.
  *
  * \sa semop(2), struct misc_meta_data
@@ -115,7 +117,11 @@ void mutex_unlock(int id)
 
 /**
  * create a new shared memory area of given size
- * 
+ *
+ * \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)
  */
 int shm_new(size_t size)
@@ -126,8 +132,14 @@ int shm_new(size_t size)
 
 /**
  * destroy the given shared memory area
+ *
+ * \param id the shared memory id
+ *
+ * \return The return value of the underlying shmctl() call on success,
+ * \a -E_SHM_DESTROY on errors.
+ *
  * \sa shmctl(2)
- **/
+ */
 int shm_destroy(int id)
 {
        struct shmid_ds shm_desc;
@@ -140,9 +152,9 @@ int shm_destroy(int id)
  *
  * \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 arer which to the
+ * \param result points to the attached area just attached
  *
- * \returns positive on success, -E_SHM_ATTACH on errrors.
+ * \return positive on success, \a -E_SHM_ATTACH on errors.
  *
  * \sa shmat(2)
  */
@@ -161,7 +173,7 @@ int shm_attach(int id, enum shm_attach_mode mode, void **result)
  *
  * \param addr the address of the attached segment
  *
- * \returns positive on success, -E_SHM_DETACH on errors.
+ * \return positive on success, \a -E_SHM_DETACH on errors.
  *
  * \sa shmdt(2)
  */