From f1c03b463e125869e6e34809563cacfe5a9dd353 Mon Sep 17 00:00:00 2001 From: Marenz Date: Sun, 17 Apr 2011 14:47:25 +0200 Subject: [PATCH] added some documentation --- include/psyc/parser.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/include/psyc/parser.h b/include/psyc/parser.h index 467fc8b..0e49b7e 100644 --- a/include/psyc/parser.h +++ b/include/psyc/parser.h @@ -36,13 +36,22 @@ typedef struct } PSYC_State; #ifndef PSYC_COMPILE_LIBRARY +/* @brief shortcut for creating an array + * + * @param memory pointer to the buffer + * @param length length of that buffer + * + * @returns an instance of the PSYC_Array struct */ inline PSYC_Array PSYC_CreateArray (uint8_t* const memory, unsigned int length) { PSYC_Array arr = {length, memory}; return arr; } - +/* @brief initiates the state struct with flags + * + * @param state pointer to the state struct that should be initiated + * @param flags the flags that one ones to set, se PSYC_Flags */ inline void PSYC_initState2 (PSYC_State* state, uint8_t flags ) { memset(state, 0, sizeof(PSYC_State));