psyc-mirrors/libpsyc
1
0
Fork 0
mirror of git://git.psyc.eu/libpsyc synced 2024-08-15 03:19:02 +00:00
Code Issues Releases Wiki Activity

doxygen

Browse source
This commit is contained in:
Gabor Adam Toth 2011-04-19 22:31:43 +02:00
parent 2b9190b8c0
commit 7ccc4e661a
3 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -1,3 +1,4 @@
doc/
.config .config
~$* ~$*
.DS_Store .DS_Store

4
Makefile Normal file
View file

@ -0,0 +1,4 @@
.PHONY: doc
doc:
doxygen

11
include/psyc/parser.h
View file

@ -21,7 +21,7 @@ enum PSYC_Types {
enum PSYC_Flags enum PSYC_Flags
{ {
PSYC_HEADER_ONLY = 1 PSYC_HEADER_ONLY = 1,
}; };
@ -174,8 +174,17 @@ inline size_t PSYC_getContentLength (PSYC_State* s)
#endif #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); 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); int PSYC_parseList(PSYC_ListState* state, PSYC_Array *name, PSYC_Array* value, PSYC_Array* elem);
#endif // PSYC_PARSER_H #endif // PSYC_PARSER_H