\warning Not thread safe!

*/

/*! \fn int open(const char *pathname,int flags)

    \brief Opens a file descriptor.

    \param pathname The name of the descriptor.

    \param flags Opening flags.

*/

/*! \fn int close(int fd)

    \brief Closes the file descriptor \a fd.

    \param fd The descriptor to close.

*/

/*! \fn size_t write(int fd,const char *buf, size_t count)

    \brief Writes \a count bytes from \a buf to the filedescriptor \a fd.

    \param fd The descriptor to write to.

    \param buf The data buffer to write.

    \param count The number of bytes to write.

*/

/*! \fn int read(int fd,char *buf,size_t count)

    \brief Read bytes from a file descriptor.

    \param fd The descriptor to read from.

    \param buf The buffer to read into.

    \param count The number of bytes to read.

*/

#define MAX(a,b) (((a)>(b))?(a):(b))

typedef unsigned int UINT32;

int errno;

int open(const char *,int);

int close(int);

size_t write(int,const char *, size_t);

int read(int,char *,size_t);

Click here for the corresponding HTML documentation that is generated by doxygen.

Because each comment block in the example above contains a structural command, all the comment blocks could be moved to another location or input file (the source file for instance), without affecting the generated documentation. The disadvantage of this approach is that prototypes are duplicated, so all changes have to be made twice! Because of this you should first consider if this is really needed, and avoid structural commands if possible. I often receive examples that contain \fn command in comment blocks which are place in front of a function. This is clearly a case where the \fn command is redundant and will only lead to problems.

因为上例中每个注释块都包含一个结构化命令，所有注释快都可以放在其他位置或input文件（例如source file），都不会影像文档的生成。这种做法的缺点是原型被复制了，所以每次都要写两遍。因为如此，你应该首先考虑是否有必要，并尽可能避免structural commands。我常常收到含有这种文件，在一个函数前的注释中有“\fn”命令。这样是冗余的，导致容易出错。

上一页  [1] [2]