Add documentation for lasso_get_relaystate_from_query

 * lasso/xml/tools.c:
   add documentation on the internal function
   lasso_get_relaystate_from_query

1 files changed, 9 insertions, 0 deletions

diff --git a/lasso/xml/tools.c b/lasso/xml/tools.c
index 8924927c..47d9b775 100644
--- a/lasso/xml/tools.c
+++ b/lasso/xml/tools.c
@@ -1553,6 +1553,15 @@ xmlDetectSAX2(xmlParserCtxtPtr ctxt) {
 	}
 }
 
+/**
+ * lasso_get_relaystate_from_query:
+ * @query: a C-string containing the query part of an URL
+ *
+ * Extracts the relaystate argument contained in an URL query string.
+ *
+ * Return value: NULL if not relaystate is present in the URL, the RelayState decoded value
+ * otherwise.
+ */
 char *
 lasso_get_relaystate_from_query(const char *query) {
 	char *start, *end;