*
* Include the header file with the code:
* @code
- * #include <yaml/yaml.h>
+ * #include <yaml.h>
* @endcode
*/
/**
* Free any memory allocated for a token object.
*
- * @param[in] token A token object.
+ * @param[in,out] token A token object.
*/
YAML_DECLARE(void)
/**
* 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.
*
* @returns @c 1 if the function succeeded, @c 0 on error.
/**
* 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.
*/
* The @a implicit argument is considered as a stylistic parameter and may be
* 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.
* @param[in] tag_directives_end The end of the %TAG directives list.
* The @a implicit argument is considered as a stylistic parameter and may be
* 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.
*
* @returns @c 1 if the function succeeded, @c 0 on error.
/**
* Create an ALIAS event.
*
- * @param[in] event An empty event object.
+ * @param[out] event An empty event object.
* @param[in] anchor The anchor value.
*
* @returns @c 1 if the function succeeded, @c 0 on error.
* Either the @a tag attribute or one of the @a plain_implicit and
* @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.
* @param[in] value The scalar value.
*
* 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.
* @param[in] implicit If the tag may be omitted.
/**
* 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.
*/
*
* 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.
* @param[in] implicit If the tag may be omitted.
/**
* 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.
*/
/**
* Free any memory allocated for an event object.
*
- * @param[in] event An event object.
+ * @param[out] event An event object.
*/
YAML_DECLARE(void)
* source. The handler should write not more than @a size bytes to the @a
* 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,
* the returned value should be @c 0. On EOF, the handler should set the
* Initialize a parser.
*
* This function creates a new parser object. An application is responsible
- * for destroying the object using the @c yaml_parser_delete function.
+ * for destroying the object using the yaml_parser_delete() function.
*
- * @param[in] parser An empty parser object.
+ * @param[out] parser An empty parser object.
*
* @returns @c 1 if the function succeeded, @c 0 on error.
*/
/**
* Destroy a parser.
*
- * @param[in] parser A parser object.
+ * @param[in,out] parser A parser object.
*/
YAML_DECLARE(void)
* exists. The application is responsible for destroing @a input after
* 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.
*/
YAML_DECLARE(void)
* @a file should be a file object open for reading. The application is
* 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.
*/
YAML_DECLARE(void)
/**
* 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.
*/
YAML_DECLARE(void)
/**
* 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.
*/
YAML_DECLARE(void)
* An application is responsible for freeing any buffers associated with the
* 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.
+ * 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] parser A parser object.
- * @param[in] token An empty token object.
+ * @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.
*/
* @c YAML_STREAM_END_EVENT.
*
* An application is responsible for freeing any buffers associated with the
- * produced event object using the @c yaml_event_delete function.
+ * produced event object using the 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.
+ * 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] parser A parser object.
- * @param[in] event An empty event object.
+ * @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.
*/
* characters to the output. The handler should write @a size bytes of the
* @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,
* the returned value should be @c 0.
* Initialize an emitter.
*
* This function creates a new emitter object. An application is responsible
- * for destroying the object using the @c yaml_emitter_delete function.
+ * for destroying the object using the yaml_emitter_delete() function.
*
- * @param[in] emitter An empty parser object.
+ * @param[out] emitter An empty parser object.
*
* @returns @c 1 if the function succeeded, @c 0 on error.
*/
/**
* Destroy an emitter.
*
- * @param[in] emitter An emitter object.
+ * @param[in,out] emitter An emitter object.
*/
YAML_DECLARE(void)
* bytes. If the buffer is smaller than required, the emitter produces the
* 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.
*/
YAML_DECLARE(void)
* @a file should be a file object open for writing. The application is
* 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.
*/
YAML_DECLARE(void)
/**
* 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.
*/
YAML_DECLARE(void)
/**
* 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.
*/
YAML_DECLARE(void)
* Set if the output should be in the "canonical" format as in the YAML
* 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.
*/
YAML_DECLARE(void)
/**
* 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).
*/
YAML_DECLARE(void)
/**
* 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.
*/
YAML_DECLARE(void)
/**
* 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.
*/
YAML_DECLARE(void)
/**
* 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.
*/
YAML_DECLARE(void)
/**
* 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.
*/
/**
* 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.
*/