Add a ton of docstrings and add to official docs

This commit is contained in:
Jason Paryani
2013-08-26 16:16:58 -07:00
parent 0856cf413b
commit 7b33513bdb
3 changed files with 181 additions and 7 deletions

View File

@@ -26,10 +26,51 @@ Readers
:undoc-members:
:inherited-members:
Writers
Builders
-------------
.. autoclass:: MessageBuilder
:members:
:undoc-members:
:inherited-members:
.. autoclass:: MallocMessageBuilder
:members:
:undoc-members:
:inherited-members:
Internal Classes
----------------
These classes are internal to the library. You will never need to allocate
one yourself, but you may end up using some of their member methods.
Readers
~~~~~~~~~~
.. autoclass:: _DynamicStructReader
:members:
:undoc-members:
:inherited-members:
.. autoclass:: _DynamicListReader
:members:
:undoc-members:
:inherited-members:
Builders
~~~~~~~~~~
.. autoclass:: _DynamicStructBuilder
:members:
:undoc-members:
:inherited-members:
.. autoclass:: _DynamicListBuilder
:members:
:undoc-members:
:inherited-members:
Miscellaneous
~~~~~~~~~~~~~
.. autoclass:: _DynamicOrphan
:members:
:undoc-members:
:inherited-members: