Blame examples/structcmd.h

Packit 1c1d7e
/*! \file structcmd.h
Packit 1c1d7e
    \brief A Documented file.
Packit 1c1d7e
    
Packit 1c1d7e
    Details.
Packit 1c1d7e
*/
Packit 1c1d7e
Packit 1c1d7e
/*! \def MAX(a,b)
Packit 1c1d7e
    \brief A macro that returns the maximum of \a a and \a b.
Packit 1c1d7e
   
Packit 1c1d7e
    Details.
Packit 1c1d7e
*/
Packit 1c1d7e
Packit 1c1d7e
/*! \var typedef unsigned int UINT32
Packit 1c1d7e
    \brief A type definition for a .
Packit 1c1d7e
    
Packit 1c1d7e
    Details.
Packit 1c1d7e
*/
Packit 1c1d7e
Packit 1c1d7e
/*! \var int errno
Packit 1c1d7e
    \brief Contains the last error code.
Packit 1c1d7e
Packit 1c1d7e
    \warning Not thread safe!
Packit 1c1d7e
*/
Packit 1c1d7e
Packit 1c1d7e
/*! \fn int open(const char *pathname,int flags)
Packit 1c1d7e
    \brief Opens a file descriptor.
Packit 1c1d7e
Packit 1c1d7e
    \param pathname The name of the descriptor.
Packit 1c1d7e
    \param flags Opening flags.
Packit 1c1d7e
*/
Packit 1c1d7e
Packit 1c1d7e
/*! \fn int close(int fd)
Packit 1c1d7e
    \brief Closes the file descriptor \a fd.
Packit 1c1d7e
    \param fd The descriptor to close.
Packit 1c1d7e
*/
Packit 1c1d7e
Packit 1c1d7e
/*! \fn size_t write(int fd,const char *buf, size_t count)
Packit 1c1d7e
    \brief Writes \a count bytes from \a buf to the filedescriptor \a fd.
Packit 1c1d7e
    \param fd The descriptor to write to.
Packit 1c1d7e
    \param buf The data buffer to write.
Packit 1c1d7e
    \param count The number of bytes to write.
Packit 1c1d7e
*/
Packit 1c1d7e
Packit 1c1d7e
/*! \fn int read(int fd,char *buf,size_t count)
Packit 1c1d7e
    \brief Read bytes from a file descriptor.
Packit 1c1d7e
    \param fd The descriptor to read from.
Packit 1c1d7e
    \param buf The buffer to read into.
Packit 1c1d7e
    \param count The number of bytes to read.
Packit 1c1d7e
*/
Packit 1c1d7e
Packit 1c1d7e
#define MAX(a,b) (((a)>(b))?(a):(b))
Packit 1c1d7e
typedef unsigned int UINT32;
Packit 1c1d7e
int errno;
Packit 1c1d7e
int open(const char *,int);
Packit 1c1d7e
int close(int);
Packit 1c1d7e
size_t write(int,const char *, size_t);
Packit 1c1d7e
int read(int,char *,size_t);