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