X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=ipc.c;h=58e697880be7b17f6be94d29f73604c7c0b41951;hp=674d1cb01e5fae9c5ae2ecb8f8ceec92fa9faa62;hb=4744d937c4160898d1fe151257606430750e580c;hpb=4a0c8e1fb760134609dcf2c06cd1b9b76953d606

diff --git a/ipc.c b/ipc.c
index 674d1cb0..58e69788 100644
--- a/ipc.c
+++ b/ipc.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006-2011 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2012 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -184,6 +184,15 @@ int shm_detach(void *addr)
 #	undef SYSCTL_SHMMAX_VARIABLE
 # endif
 
+/**
+ * Get the maximal size of a shared memory area.
+ *
+ * The value is only computed once when the function is called for the first
+ * time.  Subsequent calls return the number which was computed during the
+ * first call.
+ *
+ * \return A number suitable as an argument to \ref shm_new().
+ */
 size_t shm_get_shmmax(void)
 {
 	static size_t shmmax;