Index: libyaml/trunk/include/yaml.h =================================================================== --- libyaml/trunk/include/yaml.h (revision 219) +++ libyaml/trunk/include/yaml.h (revision 220) @@ -5,5 +5,5 @@ * Include the header file with the code: * @code - * #include + * #include * @endcode */ @@ -286,5 +286,5 @@ * Free any memory allocated for a token object. * - * @param[in] token A token object. + * @param[in,out] token A token object. */ @@ -417,5 +417,5 @@ * Create the STREAM-START event. * - * @param[in] event An empty event object. + * @param[out] event An empty event object. * @param[in] encoding The stream encoding. * @@ -430,5 +430,5 @@ * Create the STREAM-END event. * - * @param[in] event An empty event object. + * @param[out] event An empty event object. * * @returns @c 1 if the function succeeded, @c 0 on error. @@ -444,5 +444,5 @@ * ignored by the emitter. * - * @param[in] event An empty event object. + * @param[out] event An empty event object. * @param[in] version_directive The %YAML directive value or @c NULL. * @param[in] tag_directives_start The beginning of the %TAG directives list. @@ -466,5 +466,5 @@ * ignored by the emitter. * - * @param[in] event An empty event object. + * @param[out] event An empty event object. * @param[in] implicit If the document end indicator is implicit. * @@ -478,5 +478,5 @@ * Create an ALIAS event. * - * @param[in] event An empty event object. + * @param[out] event An empty event object. * @param[in] anchor The anchor value. * @@ -495,5 +495,5 @@ * @a quoted_implicit flags must be set. * - * @param[in] event An empty event object. + * @param[out] event An empty event object. * @param[in] anchor The scalar anchor or @c NULL. * @param[in] tag The scalar tag or @c NULL. @@ -521,5 +521,5 @@ * Either the @a tag attribute or the @a implicit flag must be set. * - * @param[in] event An empty event object. + * @param[out] event An empty event object. * @param[in] anchor The sequence anchor or @c NULL. * @param[in] tag The sequence tag or @c NULL. @@ -538,5 +538,5 @@ * Create a SEQUENCE-END event. * - * @param[in] event An empty event object. + * @param[out] event An empty event object. * * @returns @c 1 if the function succeeded, @c 0 on error. @@ -553,5 +553,5 @@ * Either the @a tag attribute or the @a implicit flag must be set. * - * @param[in] event An empty event object. + * @param[out] event An empty event object. * @param[in] anchor The mapping anchor or @c NULL. * @param[in] tag The mapping tag or @c NULL. @@ -570,5 +570,5 @@ * Create a MAPPING-END event. * - * @param[in] event An empty event object. + * @param[out] event An empty event object. * * @returns @c 1 if the function succeeded, @c 0 on error. @@ -581,5 +581,5 @@ * Free any memory allocated for an event object. * - * @param[in] event An event object. + * @param[out] event An event object. */ @@ -601,9 +601,9 @@ * buffer. The number of written bytes should be set to the @a length variable. * - * @param[in] data A pointer to an application data specified by - * @c yaml_parser_set_read_handler. - * @param[out] buffer The buffer to write the data from the source. - * @param[in] size The size of the buffer. - * @param[out] size_read The actual number of bytes read from the source. + * @param[in,out] data A pointer to an application data specified by + * yaml_parser_set_input(). + * @param[out] buffer The buffer to write the data from the source. + * @param[in] size The size of the buffer. + * @param[out] size_read The actual number of bytes read from the source. * * @returns On success, the handler should return @c 1. If the handler failed, @@ -876,7 +876,7 @@ * * This function creates a new parser object. An application is responsible - * for destroying the object using the @c yaml_parser_delete function. - * - * @param[in] parser An empty parser object. + * for destroying the object using the yaml_parser_delete() function. + * + * @param[out] parser An empty parser object. * * @returns @c 1 if the function succeeded, @c 0 on error. @@ -889,5 +889,5 @@ * Destroy a parser. * - * @param[in] parser A parser object. + * @param[in,out] parser A parser object. */ @@ -902,7 +902,7 @@ * destroying the @a parser. * - * @param[in] parser A parser object. - * @param[in] input A source data. - * @param[in] size The length of the source data in bytes. + * @param[in,out] parser A parser object. + * @param[in] input A source data. + * @param[in] size The length of the source data in bytes. */ @@ -917,6 +917,6 @@ * responsible for closing the @a file. * - * @param[in] parser A parser object. - * @param[in] file An open file. + * @param[in,out] parser A parser object. + * @param[in] file An open file. */ @@ -927,7 +927,8 @@ * Set a generic input handler. * - * @param[in] parser A parser object. - * @param[in] handler A read handler. - * @param[in] data Any application data for passing to the read handler. + * @param[in,out] parser A parser object. + * @param[in] handler A read handler. + * @param[in] data Any application data for passing to the read + * handler. */ @@ -939,6 +940,6 @@ * Set the source encoding. * - * @param[in] parser A parser object. - * @param[in] encoding The source encoding. + * @param[in,out] parser A parser object. + * @param[in] encoding The source encoding. */ @@ -957,9 +958,9 @@ * produced token object using the @c yaml_token_delete function. * - * An application must not alternate the calls of @c yaml_parser_scan with the - * calls of @c yaml_parser_parse. Doing this will break the parser. - * - * @param[in] parser A parser object. - * @param[in] token An empty token object. + * An application must not alternate the calls of yaml_parser_scan() with the + * calls of yaml_parser_parse(). Doing this will break the parser. + * + * @param[in,out] parser A parser object. + * @param[out] token An empty token object. * * @returns @c 1 if the function succeeded, @c 0 on error. @@ -978,11 +979,11 @@ * * An application is responsible for freeing any buffers associated with the - * produced event object using the @c yaml_event_delete function. - * - * An application must not alternate the calls of @c yaml_parser_scan with the - * calls of @c yaml_parser_parse. Doing this will break the parser. - * - * @param[in] parser A parser object. - * @param[in] event An empty event object. + * produced event object using the yaml_event_delete() function. + * + * An application must not alternate the calls of yaml_parser_scan() with the + * calls of yaml_parser_parse(). Doing this will break the parser. + * + * @param[in,out] parser A parser object. + * @param[out] event An empty event object. * * @returns @c 1 if the function succeeded, @c 0 on error. @@ -1006,8 +1007,8 @@ * @a buffer to the output. * - * @param[in] data A pointer to an application data specified by - * @c yaml_emitter_set_write_handler. - * @param[out] buffer The buffer with bytes to be written. - * @param[in] size The size of the buffer. + * @param[in,out] data A pointer to an application data specified by + * yaml_emitter_set_output(). + * @param[in] buffer The buffer with bytes to be written. + * @param[in] size The size of the buffer. * * @returns On success, the handler should return @c 1. If the handler failed, @@ -1257,7 +1258,7 @@ * * This function creates a new emitter object. An application is responsible - * for destroying the object using the @c yaml_emitter_delete function. - * - * @param[in] emitter An empty parser object. + * for destroying the object using the yaml_emitter_delete() function. + * + * @param[out] emitter An empty parser object. * * @returns @c 1 if the function succeeded, @c 0 on error. @@ -1270,5 +1271,5 @@ * Destroy an emitter. * - * @param[in] emitter An emitter object. + * @param[in,out] emitter An emitter object. */ @@ -1284,8 +1285,9 @@ * YAML_WRITE_ERROR error. * - * @param[in] emitter An emitter object. - * @param[in] output An output buffer. - * @param[in] size The buffer size. - * @param[in] size_written The pointer to save the number of written bytes. + * @param[in,out] emitter An emitter object. + * @param[in] output An output buffer. + * @param[in] size The buffer size. + * @param[in] size_written The pointer to save the number of written + * bytes. */ @@ -1300,6 +1302,6 @@ * responsible for closing the @a file. * - * @param[in] emitter An emitter object. - * @param[in] file An open file. + * @param[in,out] emitter An emitter object. + * @param[in] file An open file. */ @@ -1310,7 +1312,8 @@ * Set a generic output handler. * - * @param[in] emitter An emitter object. - * @param[in] handler A write handler. - * @param[in] data Any application data for passing to the write handler. + * @param[in,out] emitter An emitter object. + * @param[in] handler A write handler. + * @param[in] data Any application data for passing to the write + * handler. */ @@ -1322,6 +1325,6 @@ * Set the output encoding. * - * @param[in] emitter An emitter object. - * @param[in] encoding The output encoding. + * @param[in,out] emitter An emitter object. + * @param[in] encoding The output encoding. */ @@ -1333,6 +1336,6 @@ * specification. * - * @param[in] emitter An emitter object. - * @param[in] canonical If the output is canonical. + * @param[in,out] emitter An emitter object. + * @param[in] canonical If the output is canonical. */ @@ -1343,6 +1346,6 @@ * Set the intendation increment. * - * @param[in] emitter An emitter object. - * @param[in] indent The indentation increment (1 < . < 10). + * @param[in,out] emitter An emitter object. + * @param[in] indent The indentation increment (1 < . < 10). */ @@ -1353,6 +1356,6 @@ * Set the preferred line width. @c -1 means unlimited. * - * @param[in] emitter An emitter object. - * @param[in] width The preferred line width. + * @param[in,out] emitter An emitter object. + * @param[in] width The preferred line width. */ @@ -1363,6 +1366,6 @@ * Set if unescaped non-ASCII characters are allowed. * - * @param[in] emitter An emitter object. - * @param[in] unicode If unescaped Unicode characters are allowed. + * @param[in,out] emitter An emitter object. + * @param[in] unicode If unescaped Unicode characters are allowed. */ @@ -1373,6 +1376,6 @@ * Set the preferred line break. * - * @param[in] emitter An emitter object. - * @param[in] line_break The preferred line break. + * @param[in,out] emitter An emitter object. + * @param[in] line_break The preferred line break. */ @@ -1383,11 +1386,11 @@ * Emit an event. * - * The event object may be generated using the @c yaml_parser_parse function. + * The event object may be generated using the yaml_parser_parse() function. * The emitter takes the responsibility for the event object and destroys its * content after it is emitted. The event object is destroyed even if the * function fails. * - * @param[in] emitter An emitter object. - * @param[in] event An event object. + * @param[in,out] emitter An emitter object. + * @param[in,out] event An event object. * * @returns @c 1 if the function succeeded, @c 0 on error. @@ -1400,5 +1403,5 @@ * Flush the accumulated characters to the output. * - * @param[in] emitter An emitter object. + * @param[in,out] emitter An emitter object. * * @returns @c 1 if the function succeeded, @c 0 on error.