RestKit/RestKit — pull request #554 by bmorton (2012-02-09 23:02:51+00:00)
Title: Cleanup network docs

I have cleaned up and added documentation for every class in the Network directory. I touched just about every header file and a couple implementation files as necessary.

This gives us a much cleaner documentation generation through appledoc and sets some standards moving forward for documentation and coding styles. I plan to put together a document for the wiki that details some of these styles, but they can mostly be determined by mimicking the header files in the Network directory or Apple's class reference documentation.

Here's an overview of the things that happened in most of these commits:

* Added section headings and reorganized the properties and methods in the headers to generate clear and organized appledoc. This also gives us some organization for the header files.
* Filled in any missing documentation, parameter definitions, and return values.
* Fixed inconsistent documentation styles and comment blocks.
* Cleaned up inconsistent asterisk placements in variable and method declarations.
* Cleaned up some whitespace inconsistencies, though this is still somewhat of a work-in-progress.

This is mostly a janitorial fix and should provide us a basis for moving forward.