Top "Documentation" questions

THIS TAG IS FOR DOCUMENT GENERATORS ONLY.

iOS Private API Documentation

Is there a web site or project documenting private APIs for the iPhone SDK?

iphone api ios4 documentation iphone-privateapi
Using OpenGL with Python

So, I only know how to use Python, but I also know how to model in 3d. I've heard of …

python opengl documentation pyopengl
Documenting Node.js projects

I'm currently using JSDoc Toolkit to document my code, but it doesn't quite fit - namely, it seem to struggle …

documentation node.js code-documentation
javadoc: @version and @since

Is there a reason to include both @version and @since as part of a class? They seem to be mutually …

java documentation javadoc
What is self-documenting code and can it replace well documented code?

I have a colleague who insists that his code doesn't need comments, it's "self documenting." I've reviewed his code, and …

documentation comments
FFmpeg C API documentation/tutorial

I am trying to find documentation to use the FFmpeg C API. It seems that only command line documentation is …

c api documentation ffmpeg
How do you document your PHP functions and classes inline?

I know there are many different standards for PHP code inline documentation. Here's what I mean by inline documentation, and …

php documentation comments
Node.js request object documentation?

This is a pretty straight forward question, but I haven't found anything on Google. I'm looking for documentation on the …

node.js documentation request
Syntax for documenting JSON structure

So I'm trying to document the format of the json returned by an api I am writing against and I'd …

json documentation notation
Standard methods for documenting a RESTful API

I'm writing a specification for a RESTful API for a new internal web service. It's not hugely long and fairly …

rest documentation