From: Andre Noll <maan@systemlinux.org>
Date: Sat, 6 Jul 2013 18:20:41 +0000 (+0200)
Subject: net.c: Add documentation of flowopt_new().
X-Git-Tag: v0.4.13~11
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=0fd87393066ba5a6f0245b8a54b4fd47b281dfce

net.c: Add documentation of flowopt_new().

It's not obvious that the returned structure does not need to
be freed by the caller, so let's document this fact.
---

diff --git a/net.c b/net.c
index c18e7a0a..2ec3f03e 100644
--- a/net.c
+++ b/net.c
@@ -264,6 +264,12 @@ struct flowopts {
 	struct list_head sockopts;
 };
 
+/**
+ * Allocate and initialize a flowopt queue.
+ *
+ * \return A new structure to be passed to \ref flowopt_add(). It is
+ * automatically deallocated in \ref makesock().
+ */
 struct flowopts *flowopt_new(void)
 {
 	struct flowopts *new = para_malloc(sizeof(*new));