From bf16028740ae84c7ad060447e036b35f89a06e5d Mon Sep 17 00:00:00 2001
From: "tg(x)" <*@tg-x.net>
Date: Tue, 19 Apr 2011 22:31:43 +0200
Subject: [PATCH] doxygen

---
 .gitignore            |  1 +
 Makefile              |  4 ++++
 include/psyc/parser.h | 11 ++++++++++-
 3 files changed, 15 insertions(+), 1 deletion(-)
 create mode 100644 Makefile

diff --git a/.gitignore b/.gitignore
index 30cd0c5..94dda61 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
+doc/
 .config
 ~$*
 .DS_Store
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..987a385
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,4 @@
+.PHONY: doc
+
+doc:
+	doxygen
diff --git a/include/psyc/parser.h b/include/psyc/parser.h
index 1b739a5..0d42c36 100644
--- a/include/psyc/parser.h
+++ b/include/psyc/parser.h
@@ -21,7 +21,7 @@ enum PSYC_Types {
 
 enum PSYC_Flags
 {
-	PSYC_HEADER_ONLY = 1
+	PSYC_HEADER_ONLY = 1,
 };
 
 
@@ -174,8 +174,17 @@ inline size_t PSYC_getContentLength (PSYC_State* s)
 
 #endif
 
+/**
+ * Parse PSYC packets.
+ * Generalized line-based parser.
+ * @return see PSYC_ReturnCodes
+ */
 int PSYC_parse(PSYC_State* state, uint8_t* modifier, PSYC_Array* name, PSYC_Array* value);
 
+/**
+ * List value parser.
+ * @return see PSYC_ListReturnCodes.
+ */
 int PSYC_parseList(PSYC_ListState* state, PSYC_Array *name, PSYC_Array* value, PSYC_Array* elem);
 
 #endif // PSYC_PARSER_H