diff options
author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2005-08-06 11:48:27 (GMT) |
---|---|---|
committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2005-08-06 11:48:27 (GMT) |
commit | 624a187c926b69bdfc11fca8e929b71938b28eff (patch) | |
tree | 340cca67808f566b0c458391835834e717e26a61 /examples | |
parent | e2bafacf8c0f6ef0dd7f9f4958a125761bda31ec (diff) | |
download | Doxygen-624a187c926b69bdfc11fca8e929b71938b28eff.zip Doxygen-624a187c926b69bdfc11fca8e929b71938b28eff.tar.gz Doxygen-624a187c926b69bdfc11fca8e929b71938b28eff.tar.bz2 |
Release-1.4.4-20050806
Diffstat (limited to 'examples')
-rw-r--r-- | examples/Makefile.in | 13 | ||||
-rw-r--r-- | examples/Makefile.win.in | 13 | ||||
-rw-r--r-- | examples/docstring.cfg | 9 | ||||
-rw-r--r-- | examples/docstring.py | 26 | ||||
-rw-r--r-- | examples/example.tag | 2 | ||||
-rw-r--r-- | examples/pyexample.cfg | 9 | ||||
-rw-r--r-- | examples/pyexample.py | 29 | ||||
-rw-r--r-- | examples/templ.cpp | 2 |
8 files changed, 97 insertions, 6 deletions
diff --git a/examples/Makefile.in b/examples/Makefile.in index 07906aa..e0c591f 100644 --- a/examples/Makefile.in +++ b/examples/Makefile.in @@ -21,13 +21,15 @@ all: class/html/index.html \ tag/html/index.html \ group/html/index.html \ diagrams/html/index.html \ - memgrp/html/index.html + memgrp/html/index.html \ + docstring/html/index.html \ + pyexample/html/index.html clean: rm -rf class define enum file func page relates author \ par overload example include qtstyle jdstyle structcmd \ autolink tag restypedef afterdoc template tag group diagrams \ - memgrp + memgrp docstring pyexample class/html/index.html: class.h class.cfg $(DOXYGEN)/bin/doxygen class.cfg @@ -97,7 +99,14 @@ group/html/index.html: group.cpp group.cfg memgrp/html/index.html: memgrp.cpp memgrp.cfg $(DOXYGEN)/bin/doxygen memgrp.cfg +pyexample/html/index.html: pyexample.py pyexample.cfg + $(DOXYGEN)/bin/doxygen pyexample.cfg + +docstring/html/index.html: docstring.py docstring.cfg + $(DOXYGEN)/bin/doxygen docstring.cfg + diagrams/html/index.html: diagrams_a.h diagrams_b.h diagrams_c.h diagrams_d.h diagrams_e.h diagrams.cfg ifneq ($(HAVE_DOT),) $(DOXYGEN)/bin/doxygen diagrams.cfg endif + diff --git a/examples/Makefile.win.in b/examples/Makefile.win.in index 1caef19..86e2a94 100644 --- a/examples/Makefile.win.in +++ b/examples/Makefile.win.in @@ -22,10 +22,12 @@ all: class/html/index.html \ tag/html/index.html \ group/html/index.html \ diagrams/html/index.html \ - memgrp/html/index.html + memgrp/html/index.html \ + docstring/html/index.html \ + pyexample/html/index.html clean: - deltree /y class define enum file + deltree /y class define enum file pyexample docstring deltree /y func page relates author deltree /y par overload example include qtstyle deltree /y jdstyle structcmd autolink resdefine @@ -97,5 +99,12 @@ group/html/index.html: group.cpp group.cfg memgrp/html/index.html: memgrp.cpp memgrp.cfg $(DOXYDIR)\doxygen memgrp.cfg +pyexample/html/index.html: pyexample.py pyexample.cfg + $(DOXYDIR)\doxygen pyexample.cfg + +docstring/html/index.html: docstring.py docstring.cfg + $(DOXYDIR)\doxygen docstring.cfg + diagrams/html/index.html: diagrams_a.h diagrams_b.h diagrams_c.h diagrams_d.h diagrams_e.h diagrams.cfg $(DOXYDIR)\doxygen diagrams.cfg + diff --git a/examples/docstring.cfg b/examples/docstring.cfg new file mode 100644 index 0000000..d185998 --- /dev/null +++ b/examples/docstring.cfg @@ -0,0 +1,9 @@ +PROJECT_NAME = "Python" +OUTPUT_DIRECTORY = docstring +GENERATE_LATEX = NO +GENERATE_MAN = NO +GENERATE_RTF = NO +OPTIMIZE_OUTPUT_JAVA = YES +INPUT = docstring.py +QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/docstring.py b/examples/docstring.py new file mode 100644 index 0000000..ab185b6 --- /dev/null +++ b/examples/docstring.py @@ -0,0 +1,26 @@ +"""Documentation for this module. + +More details. +""" + +def func(): + """Documentation for a function. + + More details. + """ + pass + +class PyClass: + """Documentation for a class. + + More details. + """ + + def __init__(self): + """The constructor.""" + self._memVar = 0; + + def PyMethod(self): + """Documentation for a method.""" + pass + diff --git a/examples/example.tag b/examples/example.tag index e5c228e..c67e49a 100644 --- a/examples/example.tag +++ b/examples/example.tag @@ -7,7 +7,7 @@ <type>void</type> <name>example</name> <anchorfile>class_test.html</anchorfile> - <anchor>a0</anchor> + <anchor>example_28_29</anchor> <arglist>()</arglist> </member> </compound> diff --git a/examples/pyexample.cfg b/examples/pyexample.cfg new file mode 100644 index 0000000..c6fc3fa --- /dev/null +++ b/examples/pyexample.cfg @@ -0,0 +1,9 @@ +PROJECT_NAME = "Python" +OUTPUT_DIRECTORY = pyexample +GENERATE_LATEX = NO +GENERATE_MAN = NO +GENERATE_RTF = NO +OPTIMIZE_OUTPUT_JAVA = YES +INPUT = pyexample.py +QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/pyexample.py b/examples/pyexample.py new file mode 100644 index 0000000..de04c28 --- /dev/null +++ b/examples/pyexample.py @@ -0,0 +1,29 @@ +## Documentation for this module. +# +# More details. + +## Documentation for a function. +# +# More details. +def func(): + pass + +## Documentation for a class. +# +# More details. +class PyClass: + + ## The constructor. + def __init__(self): + self._memVar = 0; + + ## Documentation for a method. + # @param self The object pointer. + def PyMethod(self): + pass + + ## A class variable. + classVar = 0; + + ## @var _memVar + # a member variable diff --git a/examples/templ.cpp b/examples/templ.cpp index 3250abc..9ed48fb 100644 --- a/examples/templ.cpp +++ b/examples/templ.cpp @@ -25,7 +25,7 @@ template<class T> class Test<T *> : public Test<void *,200> template<class T,int i> Test<T,i>::Test() {} /*! The copy constructor */ -template<class T,int i> Test<T,i>::Test(const Test<T,i> &t) {} +template<class T,int i> Test<T,i>::Test(const Test &t) {} /*! The constructor of the partial specilization */ template<class T> Test<T *>::Test() {} |