From 919ac96907fdabd6bab16aa5a6439657add43340 Mon Sep 17 00:00:00 2001
From: Marenz <marenz@supradigital.org>
Date: Mon, 9 May 2011 01:49:04 +0200
Subject: [PATCH] enhancement in the documentation

---
 include/psyc.h        | 11 +++++++++--
 include/psyc/parser.h |  8 ++++----
 2 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/include/psyc.h b/include/psyc.h
index c4fca1d..5446e80 100644
--- a/include/psyc.h
+++ b/include/psyc.h
@@ -82,10 +82,17 @@ typedef enum
 	PSYC_LIST_BINARY = 2,
 } psycListType;
 
+/**
+ * String struct.
+ *
+ * Contains pointer and length for a buffer.
+ */
 typedef struct
 {
-	size_t length;
-	const char *ptr;
+	/// Length of the data pointed to by ptr
+	size_t length; 	
+	/// pointer to the data
+	const char *ptr;  
 } psycString;
 
 typedef struct
diff --git a/include/psyc/parser.h b/include/psyc/parser.h
index b5b6984..0e2928b 100644
--- a/include/psyc/parser.h
+++ b/include/psyc/parser.h
@@ -20,7 +20,7 @@
  * @endcode
  *
  * Note that there is also psyc_initParseState2 if you want to fine-tune what
- * should be parsed.
+ * part of the packet should be parsed. @see psycParseFlag
  *
  * Next, you have to tell the parser what it should parse. Assuming the variable
  * raw_data points to our packet and raw_len contains the length, you can pass
@@ -69,7 +69,7 @@
  * 			printf("Variable: %.*s  Value: %.*s Operator: %c\n", 
  * 			        name.length, name.ptr,
  * 			        value.length, value.ptr,
- * 			        operator);
+ * 			        oper);
  * 			// Note that the .ptr member still points at your original buffer. If
  * 			// you want to reuse that buffer for the next packet, you better copy it
  * 			// before passing it to the parser or you copy each variable now.
@@ -94,7 +94,7 @@
  * recieve incomplete packets but still want to access the data. This code would
  * simply reject incomplete packets as error. A more detailed tutorial for
  * incomplete packets will follow, in the mean time, have look at the return
- * codes in psycParseRC and their explainations.
+ * codes in psycParseRC and their explainations. @see psycParseRC
  */
 
 /** @{ */ // end of parser group
@@ -109,7 +109,7 @@ typedef enum
 {
 	/// Parse only the header
 	PSYC_PARSE_ROUTING_ONLY = 1,
-	/// Expects only the content part of a packet. The buffer should contain the whole content in this case.
+	/// Parse only the content. This means that there is no header and parsing will fail if there is one. The beginning of the content is expected.
 	PSYC_PARSE_START_AT_CONTENT = 2,
 } psycParseFlag;