Blame examples/structcmd.h

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