How does one view the "inline docs" of a .cpp file?

Posted by Mala on Super User See other posts from Super User or by Mala
Published on 2011-02-23T20:25:23Z Indexed on 2011/02/23 23:27 UTC
Read the original article Hit count: 159

Filed under:
|

I have cpp files peppered with comments such as the following before every function:

/**
 *  @brief Set the normal and expansion handshake timeouts.
 *
 *  @param wm               Array of wiimote_t structures.
 *  @param wiimotes         Number of objects in the wm array.
 *  @param normal_timeout   The timeout in milliseconds for a normal read.
 *  @param exp_timeout      The timeout in millisecondsd to wait for an expansion handshake.
 */

I assume from the format that there has to be some way of exporting this into a "friendly" format, perhaps html, which can then be read in a manner similar to the Java API. How would I do this?

(I'm on Windows 7, running MS Visual Studio 2010)

© Super User or respective owner

Related posts about documentation

Related posts about comments