How to do "See Also" to a book using doxygen

Posted by Paul J. Lucas on Stack Overflow See other posts from Stack Overflow or by Paul J. Lucas
Published on 2010-05-14T17:14:41Z Indexed on 2010/06/17 5:43 UTC
Read the original article Hit count: 288

Filed under:

The Javadoc @see allows a simple string as an argument to refer to something like a book, e.g.:

@see "The Java Programming Language."

As far as I can tell, the Doxygen \see offers no equivalent. Is there any way to have a book reference generated in the documentation, e.g.:

See Also
The C++ Programming Language, Bjarne Stroustrup, Addison-Wesley, 2000, section 19.4.1: The Standard Allocator

?

Clarification

This question is about how to do a "See Also" as part of a comment, e.g.:

/**
 * Allocates memory in an amazing way.
 * \param size The number of bytes to allocate.
 * \return Returns a pointer to the start of the allocated memory.
 * \see MyOtherClass::alloc()
 * \see "The C++ Programming Language," Bjarne Stroustrup, Addison-Wesley, 2000,
 * section 19.4.1: The Standard Allocator.
 */
void* my_alloc( size_t size );

Of course the above does not work in Doxygen. Note that if there are multiple \see tags, they should be merged into a single "See Also" section (like the way \see normally works.

© Stack Overflow or respective owner

Related posts about doxygen