Add Python doxygen example
This commit is contained in:
parent
12e7926ee2
commit
89a25055d9
7 changed files with 380 additions and 0 deletions
28
Examples/python/doxygen/runme.py
Normal file
28
Examples/python/doxygen/runme.py
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
# This example shows simple usage of the wrapped Shape classes.
|
||||
# The main purpose of this example is to show the doxygen comments translation to PyDoc comments.
|
||||
# Users should look at the generated example.py file.
|
||||
# The generated PyDoc can be viewed in a browser by opening the example.html file.
|
||||
|
||||
import example
|
||||
|
||||
print "Creating some objects:"
|
||||
c = example.MakeCircle(10)
|
||||
print " Created circle", c
|
||||
s = example.MakeSquare(10)
|
||||
print " Created square", s
|
||||
r = example.MakeRectangleInt(10, 20)
|
||||
print " Created rectangle", r
|
||||
|
||||
print "\nHere are some properties of the shapes:"
|
||||
for o in [c, s, r]:
|
||||
print " ", o
|
||||
print " area = ", o.area()
|
||||
print " perimeter = ", o.perimeter()
|
||||
|
||||
print "\nRunning pydoc, this is the equivalent to executing: pydoc -w ./example.py"
|
||||
|
||||
import pydoc
|
||||
|
||||
pydoc.writedoc("example")
|
||||
|
||||
print "Open example.html in your browser to view the generated python docs"
|
||||
Loading…
Add table
Add a link
Reference in a new issue