net.c: Add documentation of flowopt_new().
authorAndre Noll <maan@systemlinux.org>
Sat, 6 Jul 2013 18:20:41 +0000 (20:20 +0200)
committerAndre Noll <maan@systemlinux.org>
Sat, 13 Jul 2013 17:58:22 +0000 (19:58 +0200)
It's not obvious that the returned structure does not need to
be freed by the caller, so let's document this fact.

net.c

diff --git a/net.c b/net.c
index c18e7a0..2ec3f03 100644 (file)
--- 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));