[Doxygen-users] Doxygen Example Command - Appears Out of Order
Brought to you by:
dimitri
From: Moses E. <io...@ne...> - 2007-05-23 00:30:09
|
Hi all, When I run the following piece of code with the \include statement against doxygen I get output as expected. The example program attached to the \include statement gets incorporated immediately after the function exactly where I want and expect it to appear. /*! \file example.cpp * \brief description */ void example1(int a); void example2(char c); /*! \fn void example1(int a) * \brief a brief description of example1 * \param a an integer parameter * \return a void pointer * \par Example: * \include example_test.cpp */ /*! \fn void example2(char c) * \brief a brief description of example2 * \param c a character parameter */ However, when I replace the \include statement with the \example statement - the order gets shifted. A "link" does not get created immedicately after the function or in the order I expect. Instead the examples either get bunched up together at the end of the file or I else have to access them through the Examples page that is created. I want to associate particular functions with particular snippets of code - and have them appear directly under each other. I had hoped to control function documentation so they appear in the following order. Function declaration, function parameters, returns, see also (with a link), include, examples (with a link), etc. appear in that order. However when it came to the \example statement that order gets messed up. Is there any way to get the \example statement to behave like the \see statement - except instead of linking to a particular function, a ink is created to a particular code snippet? Regards, Moses |