Doxygen or Sandcastle help file builder are the primary tools that will extract XML documentation into HTML (and other forms) of external documentation. Note that you can combine these documentation exporters with documentation generators – as you’ve discovered, Resharper has some rudimentary helpers, but there are also much more advanced tools to do this specific … Read more
You don’t need and should not write the name of the file in the @file directive, doxygen reads the name of the file automatically. The problem with writing the name of the file is that when you rename the file you will have to change the @file directive as well. Providing @author and @date information … Read more
ApiGen http://apigen.org/ ApiGen has support for PHP 5.3 namespaces, packages, linking between documentation, cross referencing to PHP standard classes and general documentation, creation of highlighted source code and experimental support for PHP 5.4 traits. DocBlox http://www.docblox-project.org/ PHP 5.3 compatible API Documentation generator aimed at projects of all sizes and Continuous Integration. able to fully parse … Read more
You should go on and read a OpenGL tutorial. Here’s a pyopengl demo; other samples are over here. Also, you can use pygame together with pyopengl; an example is here.
You can put example source code in a special path defined in the doxygen config under EXAMPLE_PATH, and then insert examples with the @example tag. Doxygen will then generate an extra page containing the source of the example. It will also set a link to it from the class documentation containing the example tag. Alternatively … Read more
You can specifically list all undocumented objects (and their file locations) with the –list-undoc option. yard stats –list-undoc or even yard –list-undoc
A good documentation MUST have: datatypes specs – often more essential than actual functions. Do NOT treat this lightly. function specs (this is obvious). Including What given function does, why it does it (if not obvious), and caveats if any. an introduction document that binds the whole into a logical entity, explaining the intentions, correct … Read more
Ruby does not have a Python __doc__ equivalent. They often use Rdoc Format for documentation, for example: # For example, a square or circle. class Shape # A horizontal position. def x end # A vertical position. def y end end
As described in this post, use <see cref=”T:byte[]” />
I think only HTML is available and you get it by installing the Documentation using the Android SDK tool: (See the 4th item in the list).