DocTest
testing Doxygen for my C library
 All Data Structures Files Functions
Typedefs | Functions
DtMyParser.h File Reference

API for the DtMyParser class. More...

#include <stdio.h>
#include "DtMyObject.h"

Go to the source code of this file.

Typedefs

typedef struct DtMyParser DtMyParser
 

Functions

void dt_my_parser_delete (DtMyParser *parser)
 Destructor for DtMyParser class. More...
 
DtMyParserdt_my_parser_new (const char *filename)
 Constructor for DtMyParser class. More...
 
DtMyParserdt_my_parser_new_from_fh (FILE *file)
 Constructor for DtMyParser class. More...
 
DtMyObjectdt_my_parser_next_object (DtMyParser *parser)
 Retrieve the next object from the data file. More...
 

Detailed Description

API for the DtMyParser class.

The DtMyParser class is used for parsing DtMyObjects from data files.

Function Documentation

void dt_my_parser_delete ( DtMyParser parser)

Destructor for DtMyParser class.

Parameters
parserparser object to be destroyed
DtMyParser* dt_my_parser_new ( const char *  filename)

Constructor for DtMyParser class.

Parameters
filenamepath of the data file to be parsed
Returns
a new parser object
DtMyParser* dt_my_parser_new_from_fh ( FILE *  file)

Constructor for DtMyParser class.

Alternative constructor for the DtMyParser class, using a filehandle instead of a filename. The user is responsible to close the file handle after destroying this object.

Parameters
filehandle to the data file to be parsed
Returns
a new parser object
DtMyObject* dt_my_parser_next_object ( DtMyParser parser)

Retrieve the next object from the data file.

Parameters
parserparser object
Returns
the next object in the data file, or NULL if the object stream is exhausted