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 c18e7a0a19cfa1ff741fee6b8f3e0232a4813b7d..2ec3f03e546b3b1f3c038b7eea2e9cf8cf8a3438 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));