| Index: doxypypy/doxypypy/test/sample_docexample.py
|
| diff --git a/doxypypy/doxypypy/test/sample_docexample.py b/doxypypy/doxypypy/test/sample_docexample.py
|
| new file mode 100755
|
| index 0000000000000000000000000000000000000000..7454ce4a7287d7cf0cff2bea4f1760fa7b73535b
|
| --- /dev/null
|
| +++ b/doxypypy/doxypypy/test/sample_docexample.py
|
| @@ -0,0 +1,57 @@
|
| +#!/usr/bin/env python
|
| +# -*- coding: utf-8 -*-
|
| +"""
|
| +Documentation Example
|
| +
|
| +This is the example used in the doxypypy documentation.
|
| +It demonstrates basic docstring usage (including doctests).
|
| +"""
|
| +
|
| +
|
| +def myfunction(arg1, arg2, kwarg='whatever.'):
|
| + """
|
| + Does nothing more than demonstrate syntax.
|
| +
|
| + This is an example of how a Pythonic human-readable docstring can
|
| + get parsed by doxypypy and marked up with Doxygen commands as a
|
| + regular input filter to Doxygen.
|
| +
|
| + Args:
|
| + arg1: A positional argument.
|
| + arg2: Another positional argument.
|
| +
|
| + Kwargs:
|
| + kwarg: A keyword argument.
|
| +
|
| + Returns:
|
| + A string holding the result.
|
| +
|
| + Raises:
|
| + ZeroDivisionError, AssertionError, & ValueError.
|
| +
|
| + Examples:
|
| + >>> myfunction(2, 3)
|
| + '5 - 0, whatever.'
|
| + >>> myfunction(5, 0, 'oops.')
|
| + Traceback (most recent call last):
|
| + ...
|
| + ZeroDivisionError: integer division or modulo by zero
|
| + >>> myfunction(4, 1, 'got it.')
|
| + '5 - 4, got it.'
|
| + >>> myfunction(23.5, 23, 'oh well.')
|
| + Traceback (most recent call last):
|
| + ...
|
| + AssertionError
|
| + >>> myfunction(5, 50, 'too big.')
|
| + Traceback (most recent call last):
|
| + ...
|
| + ValueError
|
| + """
|
| + assert isinstance(arg1, int)
|
| + if arg2 > 23:
|
| + raise ValueError
|
| + return '{0} - {1}, {2}'.format(arg1 + arg2, arg1 / arg2, kwarg)
|
| +
|
| +if __name__ == "__main__":
|
| + import doctest
|
| + doctest.testmod()
|
|
|