X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fgraph_list.h;h=a2a61e62ec0fc0b4ca936d8ab7a5365e1543de79;hb=334145367a589792b49db6d0b84cc0e5bcaf2b1a;hp=ff35f18e06d545fbb38fca7d7c2364c2017def00;hpb=33e56e5052a805658254653ea7721bbd95a7fd51;p=collection4.git

diff --git a/src/graph_list.h b/src/graph_list.h
index ff35f18..a2a61e6 100644
--- a/src/graph_list.h
+++ b/src/graph_list.h
@@ -38,6 +38,15 @@ int gl_config_submit (void);
 
 int gl_register_data_provider (const char *name, data_provider_t *p);
 
+/*
+ * Returns the currently "selected" graph config.
+ *
+ * This function evaluates the HTTP query parameters and searches for a
+ * matching graph config structure. If a matching graph config is found, it
+ * will return a pointer to the graph config. Do *not* free or call
+ * graph_destroy() on this pointer. If no graph is found or parameters are
+ * incomplete, NULL is returned.
+ */
 graph_config_t *gl_graph_get_selected (void);
 
 int gl_graph_get_all (_Bool include_dynamic,