Ignore:
Timestamp:
08/01/06 07:28:16 (8 years ago)
Author:
xi
Message:

Prepare the initial release.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • libyaml/trunk/include/yaml.h

    r219 r220  
    55 * Include the header file with the code: 
    66 * @code 
    7  * #include <yaml/yaml.h> 
     7 * #include <yaml.h> 
    88 * @endcode 
    99 */ 
     
    286286 * Free any memory allocated for a token object. 
    287287 * 
    288  * @param[in]   token   A token object. 
     288 * @param[in,out]   token   A token object. 
    289289 */ 
    290290 
     
    417417 * Create the STREAM-START event. 
    418418 * 
    419  * @param[in]   event       An empty event object. 
     419 * @param[out]  event       An empty event object. 
    420420 * @param[in]   encoding    The stream encoding. 
    421421 * 
     
    430430 * Create the STREAM-END event. 
    431431 * 
    432  * @param[in]   event       An empty event object. 
     432 * @param[out]  event       An empty event object. 
    433433 * 
    434434 * @returns @c 1 if the function succeeded, @c 0 on error. 
     
    444444 * ignored by the emitter. 
    445445 * 
    446  * @param[in]   event                   An empty event object. 
     446 * @param[out]  event                   An empty event object. 
    447447 * @param[in]   version_directive       The %YAML directive value or @c NULL. 
    448448 * @param[in]   tag_directives_start    The beginning of the %TAG directives list. 
     
    466466 * ignored by the emitter. 
    467467 * 
    468  * @param[in]   event       An empty event object. 
     468 * @param[out]  event       An empty event object. 
    469469 * @param[in]   implicit    If the document end indicator is implicit. 
    470470 * 
     
    478478 * Create an ALIAS event. 
    479479 * 
    480  * @param[in]   event       An empty event object. 
     480 * @param[out]  event       An empty event object. 
    481481 * @param[in]   anchor      The anchor value. 
    482482 * 
     
    495495 * @a quoted_implicit flags must be set. 
    496496 * 
    497  * @param[in]   event           An empty event object. 
     497 * @param[out]  event           An empty event object. 
    498498 * @param[in]   anchor          The scalar anchor or @c NULL. 
    499499 * @param[in]   tag             The scalar tag or @c NULL. 
     
    521521 * Either the @a tag attribute or the @a implicit flag must be set. 
    522522 * 
    523  * @param[in]   event       An empty event object. 
     523 * @param[out]  event       An empty event object. 
    524524 * @param[in]   anchor      The sequence anchor or @c NULL. 
    525525 * @param[in]   tag         The sequence tag or @c NULL. 
     
    538538 * Create a SEQUENCE-END event. 
    539539 * 
    540  * @param[in]   event       An empty event object. 
     540 * @param[out]  event       An empty event object. 
    541541 * 
    542542 * @returns @c 1 if the function succeeded, @c 0 on error. 
     
    553553 * Either the @a tag attribute or the @a implicit flag must be set. 
    554554 * 
    555  * @param[in]   event       An empty event object. 
     555 * @param[out]  event       An empty event object. 
    556556 * @param[in]   anchor      The mapping anchor or @c NULL. 
    557557 * @param[in]   tag         The mapping tag or @c NULL. 
     
    570570 * Create a MAPPING-END event. 
    571571 * 
    572  * @param[in]   event       An empty event object. 
     572 * @param[out]  event       An empty event object. 
    573573 * 
    574574 * @returns @c 1 if the function succeeded, @c 0 on error. 
     
    581581 * Free any memory allocated for an event object. 
    582582 * 
    583  * @param[in]   event   An event object. 
     583 * @param[out]  event   An event object. 
    584584 */ 
    585585 
     
    601601 * buffer.  The number of written bytes should be set to the @a length variable. 
    602602 * 
    603  * @param[in]   data        A pointer to an application data specified by 
    604  *                          @c yaml_parser_set_read_handler. 
    605  * @param[out]  buffer      The buffer to write the data from the source. 
    606  * @param[in]   size        The size of the buffer. 
    607  * @param[out]  size_read   The actual number of bytes read from the source. 
     603 * @param[in,out]   data        A pointer to an application data specified by 
     604 *                              yaml_parser_set_input(). 
     605 * @param[out]      buffer      The buffer to write the data from the source. 
     606 * @param[in]       size        The size of the buffer. 
     607 * @param[out]      size_read   The actual number of bytes read from the source. 
    608608 * 
    609609 * @returns On success, the handler should return @c 1.  If the handler failed, 
     
    876876 * 
    877877 * This function creates a new parser object.  An application is responsible 
    878  * for destroying the object using the @c yaml_parser_delete function. 
    879  * 
    880  * @param[in]   parser  An empty parser object. 
     878 * for destroying the object using the yaml_parser_delete() function. 
     879 * 
     880 * @param[out]  parser  An empty parser object. 
    881881 * 
    882882 * @returns @c 1 if the function succeeded, @c 0 on error. 
     
    889889 * Destroy a parser. 
    890890 * 
    891  * @param[in]   parser  A parser object. 
     891 * @param[in,out]   parser  A parser object. 
    892892 */ 
    893893 
     
    902902 * destroying the @a parser. 
    903903 * 
    904  * @param[in]   parser  A parser object. 
    905  * @param[in]   input   A source data. 
    906  * @param[in]   size    The length of the source data in bytes. 
     904 * @param[in,out]   parser  A parser object. 
     905 * @param[in]       input   A source data. 
     906 * @param[in]       size    The length of the source data in bytes. 
    907907 */ 
    908908 
     
    917917 * responsible for closing the @a file. 
    918918 * 
    919  * @param[in]   parser  A parser object. 
    920  * @param[in]   file    An open file. 
     919 * @param[in,out]   parser  A parser object. 
     920 * @param[in]       file    An open file. 
    921921 */ 
    922922 
     
    927927 * Set a generic input handler. 
    928928 * 
    929  * @param[in]   parser  A parser object. 
    930  * @param[in]   handler A read handler. 
    931  * @param[in]   data    Any application data for passing to the read handler. 
     929 * @param[in,out]   parser  A parser object. 
     930 * @param[in]       handler A read handler. 
     931 * @param[in]       data    Any application data for passing to the read 
     932 *                          handler. 
    932933 */ 
    933934 
     
    939940 * Set the source encoding. 
    940941 * 
    941  * @param[in]   parser      A parser object. 
    942  * @param[in]   encoding    The source encoding. 
     942 * @param[in,out]   parser      A parser object. 
     943 * @param[in]       encoding    The source encoding. 
    943944 */ 
    944945 
     
    957958 * produced token object using the @c yaml_token_delete function. 
    958959 * 
    959  * An application must not alternate the calls of @c yaml_parser_scan with the 
    960  * calls of @c yaml_parser_parse. Doing this will break the parser. 
    961  * 
    962  * @param[in]   parser      A parser object. 
    963  * @param[in]   token       An empty token object. 
     960 * An application must not alternate the calls of yaml_parser_scan() with the 
     961 * calls of yaml_parser_parse(). Doing this will break the parser. 
     962 * 
     963 * @param[in,out]   parser      A parser object. 
     964 * @param[out]      token       An empty token object. 
    964965 * 
    965966 * @returns @c 1 if the function succeeded, @c 0 on error. 
     
    978979 * 
    979980 * An application is responsible for freeing any buffers associated with the 
    980  * produced event object using the @c yaml_event_delete function. 
    981  * 
    982  * An application must not alternate the calls of @c yaml_parser_scan with the 
    983  * calls of @c yaml_parser_parse. Doing this will break the parser. 
    984  * 
    985  * @param[in]   parser      A parser object. 
    986  * @param[in]   event       An empty event object. 
     981 * produced event object using the yaml_event_delete() function. 
     982 * 
     983 * An application must not alternate the calls of yaml_parser_scan() with the 
     984 * calls of yaml_parser_parse(). Doing this will break the parser. 
     985 * 
     986 * @param[in,out]   parser      A parser object. 
     987 * @param[out]      event       An empty event object. 
    987988 * 
    988989 * @returns @c 1 if the function succeeded, @c 0 on error. 
     
    10061007 * @a buffer to the output. 
    10071008 * 
    1008  * @param[in]   data        A pointer to an application data specified by 
    1009  *                          @c yaml_emitter_set_write_handler. 
    1010  * @param[out]  buffer      The buffer with bytes to be written. 
    1011  * @param[in]   size        The size of the buffer. 
     1009 * @param[in,out]   data        A pointer to an application data specified by 
     1010 *                              yaml_emitter_set_output(). 
     1011 * @param[in]       buffer      The buffer with bytes to be written. 
     1012 * @param[in]       size        The size of the buffer. 
    10121013 * 
    10131014 * @returns On success, the handler should return @c 1.  If the handler failed, 
     
    12571258 * 
    12581259 * This function creates a new emitter object.  An application is responsible 
    1259  * for destroying the object using the @c yaml_emitter_delete function. 
    1260  * 
    1261  * @param[in]   emitter An empty parser object. 
     1260 * for destroying the object using the yaml_emitter_delete() function. 
     1261 * 
     1262 * @param[out]      emitter    An empty parser object. 
    12621263 * 
    12631264 * @returns @c 1 if the function succeeded, @c 0 on error. 
     
    12701271 * Destroy an emitter. 
    12711272 * 
    1272  * @param[in]   emitter An emitter object. 
     1273 * @param[in,out]   emitter    An emitter object. 
    12731274 */ 
    12741275 
     
    12841285 * YAML_WRITE_ERROR error. 
    12851286 * 
    1286  * @param[in]   emitter         An emitter object. 
    1287  * @param[in]   output          An output buffer. 
    1288  * @param[in]   size            The buffer size. 
    1289  * @param[in]   size_written    The pointer to save the number of written bytes. 
     1287 * @param[in,out]   emitter         An emitter object. 
     1288 * @param[in]       output          An output buffer. 
     1289 * @param[in]       size            The buffer size. 
     1290 * @param[in]       size_written    The pointer to save the number of written 
     1291 *                                  bytes. 
    12901292 */ 
    12911293 
     
    13001302 * responsible for closing the @a file. 
    13011303 * 
    1302  * @param[in]   emitter An emitter object. 
    1303  * @param[in]   file    An open file. 
     1304 * @param[in,out]   emitter    An emitter object. 
     1305 * @param[in]       file        An open file. 
    13041306 */ 
    13051307 
     
    13101312 * Set a generic output handler. 
    13111313 * 
    1312  * @param[in]   emitter An emitter object. 
    1313  * @param[in]   handler A write handler. 
    1314  * @param[in]   data    Any application data for passing to the write handler. 
     1314 * @param[in,out]   emitter     An emitter object. 
     1315 * @param[in]       handler     A write handler. 
     1316 * @param[in]       data        Any application data for passing to the write 
     1317 *                              handler. 
    13151318 */ 
    13161319 
     
    13221325 * Set the output encoding. 
    13231326 * 
    1324  * @param[in]   emitter     An emitter object. 
    1325  * @param[in]   encoding    The output encoding. 
     1327 * @param[in,out]   emitter     An emitter object. 
     1328 * @param[in]       encoding    The output encoding. 
    13261329 */ 
    13271330 
     
    13331336 * specification. 
    13341337 * 
    1335  * @param[in]   emitter     An emitter object. 
    1336  * @param[in]   canonical   If the output is canonical. 
     1338 * @param[in,out]   emitter     An emitter object. 
     1339 * @param[in]       canonical   If the output is canonical. 
    13371340 */ 
    13381341 
     
    13431346 * Set the intendation increment. 
    13441347 * 
    1345  * @param[in]   emitter     An emitter object. 
    1346  * @param[in]   indent      The indentation increment (1 < . < 10). 
     1348 * @param[in,out]   emitter     An emitter object. 
     1349 * @param[in]       indent      The indentation increment (1 < . < 10). 
    13471350 */ 
    13481351 
     
    13531356 * Set the preferred line width. @c -1 means unlimited. 
    13541357 * 
    1355  * @param[in]   emitter     An emitter object. 
    1356  * @param[in]   width       The preferred line width. 
     1358 * @param[in,out]   emitter     An emitter object. 
     1359 * @param[in]       width       The preferred line width. 
    13571360 */ 
    13581361 
     
    13631366 * Set if unescaped non-ASCII characters are allowed. 
    13641367 * 
    1365  * @param[in]   emitter     An emitter object. 
    1366  * @param[in]   unicode     If unescaped Unicode characters are allowed. 
     1368 * @param[in,out]   emitter     An emitter object. 
     1369 * @param[in]       unicode     If unescaped Unicode characters are allowed. 
    13671370 */ 
    13681371 
     
    13731376 * Set the preferred line break. 
    13741377 * 
    1375  * @param[in]   emitter     An emitter object. 
    1376  * @param[in]   line_break  The preferred line break. 
     1378 * @param[in,out]   emitter     An emitter object. 
     1379 * @param[in]       line_break  The preferred line break. 
    13771380 */ 
    13781381 
     
    13831386 * Emit an event. 
    13841387 * 
    1385  * The event object may be generated using the @c yaml_parser_parse function. 
     1388 * The event object may be generated using the yaml_parser_parse() function. 
    13861389 * The emitter takes the responsibility for the event object and destroys its 
    13871390 * content after it is emitted. The event object is destroyed even if the 
    13881391 * function fails. 
    13891392 * 
    1390  * @param[in]   emitter     An emitter object. 
    1391  * @param[in]   event       An event object. 
     1393 * @param[in,out]   emitter     An emitter object. 
     1394 * @param[in,out]   event       An event object. 
    13921395 * 
    13931396 * @returns @c 1 if the function succeeded, @c 0 on error. 
     
    14001403 * Flush the accumulated characters to the output. 
    14011404 * 
    1402  * @param[in]   emitter     An emitter object. 
     1405 * @param[in,out]   emitter     An emitter object. 
    14031406 * 
    14041407 * @returns @c 1 if the function succeeded, @c 0 on error. 
Note: See TracChangeset for help on using the changeset viewer.