X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=ipc.c;h=576bfe5bcd815ee296da0b56d49a7f3ea5d97e4e;hp=674d1cb01e5fae9c5ae2ecb8f8ceec92fa9faa62;hb=89f2de1016601e523fd456e0e2fa650fa695ecaa;hpb=63aab30b55d5809704a2d0e1c4e8de20e8228d7d

diff --git a/ipc.c b/ipc.c
index 674d1cb0..576bfe5b 100644
--- a/ipc.c
+++ b/ipc.c
@@ -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;