...
Software documentation is automatically generated by Sphinx, and published nightly at http://openwsn-berkeley.github.io/. For more examples of Sphinx documentation, see the Sphinx Module-specific markup page and the Python Sphinx documentation page.
| Code Block | ||||
|---|---|---|---|---|
| ||||
# license: https://openwsn.atlassian.net/wiki/display/OW/License
'''
Introductory text to this module
.. moduleauthor:: First Last <first.last@domain.com>
'''
#============================ import ==========================================
import os
#============================ body ============================================
class MyClass(object):
'''
Description of class.
'''
def myMethod(self,myParam,myKey="value"):
'''
Description of method.
.. note::
Something to note.
:param myParam: Description of myParam
:type myParam: str
:key myKey: Description of myKey
:type myKey: str
:raise: Description of exception raised.
:returns: Description of the return value.
:rtype: Return type.
'''
return None |