Report
6 years, 2 months ago.

Auto documentation question

Hello!

I am trying to document an API where I have some macros (#define). I am trying to force Doxygen to help me out but cannot get anywhere.

is #define documentation disabled?

I have some code that works with an offline version of Doxygen but the MBED API generator won't work.

Comment on this question

1 Answer

4 years, 7 months ago.

I seem to have stumbled across this same issue/question. I tried cutting and pasting an example in from the doxygen manual, and it did not work in mbed. (code is inserted below)

So *IS* it disabled in MBED?

/*! \def MAX(a,b) \brief A macro that returns the maximum of \a a and \a b.

Details.

  • / /*! \var typedef unsigned int UINT32 \brief A type definition for a .

Details.

  • / /*! \var int errno \brief Contains the last error code. \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.
  • /
  1. 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);


You need to log in to post a question