diff options
author | (no author) <(no author)@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2005-08-08 20:01:03 (GMT) |
---|---|---|
committer | (no author) <(no author)@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2005-08-08 20:01:03 (GMT) |
commit | 001e27ddbb1bfaa351b5f268b22418fb0557d6c2 (patch) | |
tree | a390a2400721fd1ed137738bd2679ab33ed0306f /examples | |
parent | 0559d5795f6e2adc993577a4dd55b5370d31677c (diff) | |
download | Doxygen-Release_1_4_4_20050804.zip Doxygen-Release_1_4_4_20050804.tar.gz Doxygen-Release_1_4_4_20050804.tar.bz2 |
This commit was manufactured by cvs2svn to create tagRelease_1_4_4_20050804
'Release_1_4_4_20050804'.
Diffstat (limited to 'examples')
59 files changed, 0 insertions, 1285 deletions
diff --git a/examples/.cvsignore b/examples/.cvsignore deleted file mode 100644 index f3c7a7c..0000000 --- a/examples/.cvsignore +++ /dev/null @@ -1 +0,0 @@ -Makefile diff --git a/examples/Makefile.in b/examples/Makefile.in deleted file mode 100644 index e0c591f..0000000 --- a/examples/Makefile.in +++ /dev/null @@ -1,112 +0,0 @@ - -all: class/html/index.html \ - define/html/index.html \ - enum/html/index.html \ - file/html/index.html \ - func/html/index.html \ - page/html/index.html \ - relates/html/index.html \ - author/html/index.html \ - par/html/index.html \ - overload/html/index.html \ - example/html/index.html \ - include/html/index.html \ - qtstyle/html/index.html \ - jdstyle/html/index.html \ - structcmd/html/index.html \ - autolink/html/index.html \ - restypedef/html/index.html \ - afterdoc/html/index.html \ - template/html/index.html \ - tag/html/index.html \ - group/html/index.html \ - diagrams/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 docstring pyexample - -class/html/index.html: class.h class.cfg - $(DOXYGEN)/bin/doxygen class.cfg - -define/html/index.html: define.h define.cfg - $(DOXYGEN)/bin/doxygen define.cfg - -enum/html/index.html: enum.h enum.cfg - $(DOXYGEN)/bin/doxygen enum.cfg - -file/html/index.html: file.h file.cfg - $(DOXYGEN)/bin/doxygen file.cfg - -func/html/index.html: func.h func.cfg - $(DOXYGEN)/bin/doxygen func.cfg - -page/html/index.html: page.doc page.cfg - $(DOXYGEN)/bin/doxygen page.cfg - -relates/html/index.html: relates.cpp relates.cfg - $(DOXYGEN)/bin/doxygen relates.cfg - -author/html/index.html: author.cpp author.cfg - $(DOXYGEN)/bin/doxygen author.cfg - -par/html/index.html: par.cpp par.cfg - $(DOXYGEN)/bin/doxygen par.cfg - -overload/html/index.html: overload.cpp overload.cfg - $(DOXYGEN)/bin/doxygen overload.cfg - -example/html/index.html: example.cpp example_test.cpp example.cfg - $(DOXYGEN)/bin/doxygen example.cfg - -include/html/index.html: include.cpp example_test.cpp include.cfg - $(DOXYGEN)/bin/doxygen include.cfg - -qtstyle/html/index.html: qtstyle.cpp qtstyle.cfg - $(DOXYGEN)/bin/doxygen qtstyle.cfg - -jdstyle/html/index.html: jdstyle.cpp jdstyle.cfg - $(DOXYGEN)/bin/doxygen jdstyle.cfg - -structcmd/html/index.html: structcmd.h structcmd.cfg - $(DOXYGEN)/bin/doxygen structcmd.cfg - -autolink/html/index.html: autolink.cpp autolink.cfg - $(DOXYGEN)/bin/doxygen autolink.cfg - -tag/html/index.html: tag.cpp tag.cfg example/html/index.html - $(DOXYGEN)/bin/doxygen tag.cfg -# sed -e "1,1s#perl#$(PERL)#g" tag/html/installdox >tag/html/installdox.perl -# cd tag/html ; $(PERL) installdox.perl -lexample.tag@../../example/html - -restypedef/html/index.html: restypedef.cpp restypedef.cfg - $(DOXYGEN)/bin/doxygen restypedef.cfg - -afterdoc/html/index.html: afterdoc.h afterdoc.cfg - $(DOXYGEN)/bin/doxygen afterdoc.cfg - -template/html/index.html: templ.cpp templ.cfg - $(DOXYGEN)/bin/doxygen templ.cfg - -group/html/index.html: group.cpp group.cfg - $(DOXYGEN)/bin/doxygen 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 deleted file mode 100644 index 86e2a94..0000000 --- a/examples/Makefile.win.in +++ /dev/null @@ -1,110 +0,0 @@ -DOXYDIR = ..\bin - -all: class/html/index.html \ - define/html/index.html \ - enum/html/index.html \ - file/html/index.html \ - func/html/index.html \ - page/html/index.html \ - relates/html/index.html \ - author/html/index.html \ - par/html/index.html \ - overload/html/index.html \ - example/html/index.html \ - include/html/index.html \ - qtstyle/html/index.html \ - jdstyle/html/index.html \ - structcmd/html/index.html \ - autolink/html/index.html \ - restypedef/html/index.html \ - afterdoc/html/index.html \ - template/html/index.html \ - tag/html/index.html \ - group/html/index.html \ - diagrams/html/index.html \ - memgrp/html/index.html \ - docstring/html/index.html \ - pyexample/html/index.html - -clean: - 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 - deltree /y restypedef afterdoc template tag group diagrams memgrp - -class/html/index.html: class.h class.cfg - $(DOXYDIR)\doxygen class.cfg - -define/html/index.html: define.h define.cfg - $(DOXYDIR)\doxygen define.cfg - -enum/html/index.html: enum.h enum.cfg - $(DOXYDIR)\doxygen enum.cfg - -file/html/index.html: file.h file.cfg - $(DOXYDIR)\doxygen file.cfg - -func/html/index.html: func.h func.cfg - $(DOXYDIR)\doxygen func.cfg - -page/html/index.html: page.doc page.cfg - $(DOXYDIR)\doxygen page.cfg - -relates/html/index.html: relates.cpp relates.cfg - $(DOXYDIR)\doxygen relates.cfg - -author/html/index.html: author.cpp author.cfg - $(DOXYDIR)\doxygen author.cfg - -par/html/index.html: par.cpp par.cfg - $(DOXYDIR)\doxygen par.cfg - -overload/html/index.html: overload.cpp overload.cfg - $(DOXYDIR)\doxygen overload.cfg - -example/html/index.html: example.cpp example_test.cpp example.cfg - $(DOXYDIR)\doxygen example.cfg - -include/html/index.html: include.cpp example_test.cpp include.cfg - $(DOXYDIR)\doxygen include.cfg - -qtstyle/html/index.html: qtstyle.cpp qtstyle.cfg - $(DOXYDIR)\doxygen qtstyle.cfg - -jdstyle/html/index.html: jdstyle.cpp jdstyle.cfg - $(DOXYDIR)\doxygen jdstyle.cfg - -structcmd/html/index.html: structcmd.h structcmd.cfg - $(DOXYDIR)\doxygen structcmd.cfg - -autolink/html/index.html: autolink.cpp autolink.cfg - $(DOXYDIR)\doxygen autolink.cfg - -tag/html/index.html: tag.cpp tag.cfg - $(DOXYDIR)\doxygen tag.cfg - -restypedef/html/index.html: restypedef.cpp restypedef.cfg - $(DOXYDIR)\doxygen restypedef.cfg - -afterdoc/html/index.html: afterdoc.h afterdoc.cfg - $(DOXYDIR)\doxygen afterdoc.cfg - -template/html/index.html: templ.cpp templ.cfg - $(DOXYDIR)\doxygen templ.cfg - -group/html/index.html: group.cpp group.cfg - $(DOXYDIR)\doxygen 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/afterdoc.cfg b/examples/afterdoc.cfg deleted file mode 100644 index 25e1358..0000000 --- a/examples/afterdoc.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "AfterDocs" -OUTPUT_DIRECTORY = afterdoc -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = afterdoc.h -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/afterdoc.h b/examples/afterdoc.h deleted file mode 100644 index 907dabe..0000000 --- a/examples/afterdoc.h +++ /dev/null @@ -1,18 +0,0 @@ -/*! A test class */ - -class Test -{ - public: - /** An enum type. - * The documentation block cannot be put after the enum! - */ - enum EnumType - { - int EVal1, /**< enum value 1 */ - int EVal2 /**< enum value 2 */ - }; - void member(); //!< a member function. - - protected: - int value; /*!< an integer value */ -}; diff --git a/examples/author.cfg b/examples/author.cfg deleted file mode 100644 index f1db227..0000000 --- a/examples/author.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "Author Command" -OUTPUT_DIRECTORY = author -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = author.cpp -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/author.cpp b/examples/author.cpp deleted file mode 100644 index 59cc7ab..0000000 --- a/examples/author.cpp +++ /dev/null @@ -1,14 +0,0 @@ -/*! \class WindowsNT - * \brief Windows Nice Try. - * \author Bill Gates - * \author Several species of small furry animals gathered together - * in a cave and grooving with a pict. - * \version 4.0 - * \date 1996-1998 - * \bug It crashes a lot and requires huge amounts of memory. - * \bug The class introduces the more bugs, the longer it is used. - * \warning This class may explode in your face. - * \warning If you inherit anything from this class, you're doomed. - */ - -class WindowsNT {}; diff --git a/examples/autolink.cfg b/examples/autolink.cfg deleted file mode 100644 index 49367fc..0000000 --- a/examples/autolink.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "Automatic link generation" -OUTPUT_DIRECTORY = autolink -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = autolink.cpp -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/autolink.cpp b/examples/autolink.cpp deleted file mode 100644 index e028f22..0000000 --- a/examples/autolink.cpp +++ /dev/null @@ -1,99 +0,0 @@ -/*! \file autolink.cpp - Testing automatic link generation. - - A link to a member of the Test class: Test::member, - - More specific links to the each of the overloaded members: - Test::member(int) and Test#member(int,int) - - A link to a protected member variable of Test: Test#var, - - A link to the global enumeration type #GlobEnum. - - A link to the define #ABS(x). - - A link to the destructor of the Test class: Test::~Test, - - A link to the typedef ::B. - - A link to the enumeration type Test::EType - - A link to some enumeration values Test::Val1 and ::GVal2 -*/ - -/*! - Since this documentation block belongs to the class Test no link to - Test is generated. - - Two ways to link to a constructor are: #Test and Test(). - - Links to the destructor are: #~Test and ~Test(). - - A link to a member in this class: member(). - - More specific links to the each of the overloaded members: - member(int) and member(int,int). - - A link to the variable #var. - - A link to the global typedef ::B. - - A link to the global enumeration type #GlobEnum. - - A link to the define ABS(x). - - A link to a variable \link #var using another text\endlink as a link. - - A link to the enumeration type #EType. - - A link to some enumeration values: \link Test::Val1 Val1 \endlink and ::GVal1. - - And last but not least a link to a file: autolink.cpp. - - \sa Inside a see also section any word is checked, so EType, - Val1, GVal1, ~Test and member will be replaced by links in HTML. -*/ - -class Test -{ - public: - Test(); //!< constructor - ~Test(); //!< destructor - void member(int); /**< A member function. Details. */ - void member(int,int); /**< An overloaded member function. Details */ - - /** An enum type. More details */ - enum EType { - Val1, /**< enum value 1 */ - Val2 /**< enum value 2 */ - }; - - protected: - int var; /**< A member variable */ -}; - -/*! details. */ -Test::Test() { } - -/*! details. */ -Test::~Test() { } - -/*! A global variable. */ -int globVar; - -/*! A global enum. */ -enum GlobEnum { - GVal1, /*!< global enum value 1 */ - GVal2 /*!< global enum value 2 */ - }; - -/*! - * A macro definition. - */ -#define ABS(x) (((x)>0)?(x):-(x)) - -typedef Test B; - -/*! \fn typedef Test B - * A type definition. - */ diff --git a/examples/class.cfg b/examples/class.cfg deleted file mode 100644 index 99570b8..0000000 --- a/examples/class.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "Class Command" -OUTPUT_DIRECTORY = class -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = class.h -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/class.h b/examples/class.h deleted file mode 100644 index e5a9121..0000000 --- a/examples/class.h +++ /dev/null @@ -1,11 +0,0 @@ -/* A dummy class */ - -class Test -{ -}; - -/*! \class Test class.h "inc/class.h" - * \brief This is a test class. - * - * Some details about the Test class - */ diff --git a/examples/define.cfg b/examples/define.cfg deleted file mode 100644 index 30ed03f..0000000 --- a/examples/define.cfg +++ /dev/null @@ -1,10 +0,0 @@ -PROJECT_NAME = "Define Command" -OUTPUT_DIRECTORY = define -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = define.h -ENABLE_PREPROCESSING = YES -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/define.h b/examples/define.h deleted file mode 100644 index c330447..0000000 --- a/examples/define.h +++ /dev/null @@ -1,18 +0,0 @@ -/*! \file define.h - \brief testing defines - - This is to test the documentation of defines. -*/ - -/*! - \def MAX(x,y) - Computes the maximum of \a x and \a y. -*/ - -/*! - Computes the absolute value of its argument \a x. -*/ -#define ABS(x) (((x)>0)?(x):-(x)) -#define MAX(x,y) ((x)>(y)?(x):(y)) -#define MIN(x,y) ((x)>(y)?(y):(x)) - /*!< Computes the minimum of \a x and \a y. */ diff --git a/examples/diagrams.cfg b/examples/diagrams.cfg deleted file mode 100644 index d343a66..0000000 --- a/examples/diagrams.cfg +++ /dev/null @@ -1,13 +0,0 @@ -PROJECT_NAME = "Diagrams" -OUTPUT_DIRECTORY = diagrams -HAVE_DOT = YES -EXTRACT_ALL = YES -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -ENABLE_PREPROCESSING = YES -INPUT = . -FILE_PATTERNS = diagrams_*.h -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/diagrams_a.h b/examples/diagrams_a.h deleted file mode 100644 index 047a8ab..0000000 --- a/examples/diagrams_a.h +++ /dev/null @@ -1,4 +0,0 @@ -#ifndef _DIAGRAMS_A_H -#define _DIAGRAMS_A_H -class A { public: A *m_self; }; -#endif diff --git a/examples/diagrams_b.h b/examples/diagrams_b.h deleted file mode 100644 index 5fcd247..0000000 --- a/examples/diagrams_b.h +++ /dev/null @@ -1,5 +0,0 @@ -#ifndef _DIAGRAMS_B_H -#define _DIAGRAMS_B_H -class A; -class B { public: A *m_a; }; -#endif diff --git a/examples/diagrams_c.h b/examples/diagrams_c.h deleted file mode 100644 index e4ec11d..0000000 --- a/examples/diagrams_c.h +++ /dev/null @@ -1,6 +0,0 @@ -#ifndef _DIAGRAMS_C_H -#define _DIAGRAMS_C_H -#include "diagrams_c.h" -class D; -class C : public A { public: D *m_d; }; -#endif diff --git a/examples/diagrams_d.h b/examples/diagrams_d.h deleted file mode 100644 index 3e635ce..0000000 --- a/examples/diagrams_d.h +++ /dev/null @@ -1,7 +0,0 @@ -#ifndef _DIAGRAM_D_H -#define _DIAGRAM_D_H -#include "diagrams_a.h" -#include "diagrams_b.h" -class C; -class D : virtual protected A, private B { public: C m_c; }; -#endif diff --git a/examples/diagrams_e.h b/examples/diagrams_e.h deleted file mode 100644 index 5282388..0000000 --- a/examples/diagrams_e.h +++ /dev/null @@ -1,5 +0,0 @@ -#ifndef _DIAGRAM_E_H -#define _DIAGRAM_E_H -#include "diagrams_d.h" -class E : public D {}; -#endif diff --git a/examples/docstring.cfg b/examples/docstring.cfg deleted file mode 100644 index d185998..0000000 --- a/examples/docstring.cfg +++ /dev/null @@ -1,9 +0,0 @@ -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 deleted file mode 100644 index ab185b6..0000000 --- a/examples/docstring.py +++ /dev/null @@ -1,26 +0,0 @@ -"""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/enum.cfg b/examples/enum.cfg deleted file mode 100644 index 05703cc..0000000 --- a/examples/enum.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "Enum Command" -OUTPUT_DIRECTORY = enum -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = enum.h -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/enum.h b/examples/enum.h deleted file mode 100644 index 4c54fab..0000000 --- a/examples/enum.h +++ /dev/null @@ -1,24 +0,0 @@ -class Test -{ - public: - enum TEnum { Val1, Val2 }; - - /*! Another enum, with inline docs */ - enum AnotherEnum - { - V1, /*!< value 1 */ - V2 /*!< value 2 */ - }; -}; - -/*! \class Test - * The class description. - */ - -/*! \enum Test::TEnum - * A description of the enum type. - */ - -/*! \var Test::TEnum Test::Val1 - * The description of the first enum value. - */ diff --git a/examples/example.cfg b/examples/example.cfg deleted file mode 100644 index 1815a76..0000000 --- a/examples/example.cfg +++ /dev/null @@ -1,11 +0,0 @@ -PROJECT_NAME = "Example Command" -OUTPUT_DIRECTORY = example -GENERATE_TAGFILE = example.tag -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = example.cpp -EXAMPLE_PATH = example_test.cpp -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/example.cpp b/examples/example.cpp deleted file mode 100644 index 230d6ec..0000000 --- a/examples/example.cpp +++ /dev/null @@ -1,19 +0,0 @@ -/** A Test class. - * More details about this class. - */ - -class Test -{ - public: - /** An example member function. - * More details about this function. - */ - void example(); -}; - -void Test::example() {} - -/** \example example_test.cpp - * This is an example of how to use the Test class. - * More details about this example. - */ diff --git a/examples/example.tag b/examples/example.tag deleted file mode 100644 index c67e49a..0000000 --- a/examples/example.tag +++ /dev/null @@ -1,14 +0,0 @@ -<?xml version='1.0' encoding='ISO-8859-1' standalone='yes' ?> -<tagfile> - <compound kind="class"> - <name>Test</name> - <filename>class_test.html</filename> - <member kind="function"> - <type>void</type> - <name>example</name> - <anchorfile>class_test.html</anchorfile> - <anchor>example_28_29</anchor> - <arglist>()</arglist> - </member> - </compound> -</tagfile> diff --git a/examples/example_test.cpp b/examples/example_test.cpp deleted file mode 100644 index a7e1643..0000000 --- a/examples/example_test.cpp +++ /dev/null @@ -1,5 +0,0 @@ -void main() -{ - Test t; - t.example(); -} diff --git a/examples/file.cfg b/examples/file.cfg deleted file mode 100644 index be0ecfb..0000000 --- a/examples/file.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "File Command" -OUTPUT_DIRECTORY = file -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = file.h -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/file.h b/examples/file.h deleted file mode 100644 index 8dff6cb..0000000 --- a/examples/file.h +++ /dev/null @@ -1,10 +0,0 @@ -/** \file file.h - * A brief file description. - * A more elaborated file description. - */ - -/** - * A global integer value. - * More details about this value. - */ -extern int globalValue; diff --git a/examples/func.cfg b/examples/func.cfg deleted file mode 100644 index 6071ac7..0000000 --- a/examples/func.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "Fn Command" -OUTPUT_DIRECTORY = func -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = func.h -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/func.h b/examples/func.h deleted file mode 100644 index b335448..0000000 --- a/examples/func.h +++ /dev/null @@ -1,21 +0,0 @@ -class Test -{ - public: - const char *member(char,int) throw(std::out_of_range); -}; - -const char *Test::member(char c,int n) throw(std::out_of_range) {} - -/*! \class Test - * \brief Test class. - * - * Details about Test. - */ - -/*! \fn const char *Test::member(char c,int n) - * \brief A member function. - * \param c a character. - * \param n an integer. - * \exception std::out_of_range parameter is out of range. - * \return a character pointer. - */ diff --git a/examples/group.cfg b/examples/group.cfg deleted file mode 100644 index f37ebd6..0000000 --- a/examples/group.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "Grouping" -OUTPUT_DIRECTORY = group -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = group.cpp -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/group.cpp b/examples/group.cpp deleted file mode 100644 index b120b90..0000000 --- a/examples/group.cpp +++ /dev/null @@ -1,88 +0,0 @@ -/** @defgroup group1 The First Group - * This is the first group - * @{ - */ - -/** @brief class C1 in group 1 */ -class C1 {}; - -/** @brief class C2 in group 1 */ -class C2 {}; - -/** function in group 1 */ -void func() {} - -/** @} */ // end of group1 - -/** - * @defgroup group2 The Second Group - * This is the second group - */ - -/** @defgroup group3 The Third Group - * This is the third group - */ - -/** @defgroup group4 The Fourth Group - * @ingroup group3 - * Group 4 is a subgroup of group 3 - */ - -/** - * @ingroup group2 - * @brief class C3 in group 2 - */ -class C3 {}; - -/** @ingroup group2 - * @brief class C4 in group 2 - */ -class C4 {}; - -/** @ingroup group3 - * @brief class C5 in @link group3 the third group@endlink. - */ -class C5 {}; - -/** @ingroup group1 group2 group3 group4 - * namespace N1 is in four groups - * @sa @link group1 The first group@endlink, group2, group3, group4 - * - * Also see @ref mypage2 - */ -namespace N1 {}; - -/** @file - * @ingroup group3 - * @brief this file in group 3 - */ - -/** @defgroup group5 The Fifth Group - * This is the fifth group - * @{ - */ - -/** @page mypage1 This is a section in group 5 - * Text of the first section - */ - -/** @page mypage2 This is another section in group 5 - * Text of the second section - */ - -/** @} */ // end of group5 - -/** @addtogroup group1 - * - * More documentation for the first group. - * @{ - */ - -/** another function in group 1 */ -void func2() {} - -/** yet another function in group 1 */ -void func3() {} - -/** @} */ // end of group1 - diff --git a/examples/include.cfg b/examples/include.cfg deleted file mode 100644 index 20c11c0..0000000 --- a/examples/include.cfg +++ /dev/null @@ -1,10 +0,0 @@ -PROJECT_NAME = "Include Command" -OUTPUT_DIRECTORY = include -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = include.cpp -EXAMPLE_PATH = example_test.cpp -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/include.cpp b/examples/include.cpp deleted file mode 100644 index c50ab96..0000000 --- a/examples/include.cpp +++ /dev/null @@ -1,22 +0,0 @@ - -/*! A test class. */ - -class Test -{ - public: - /// a member function - void example(); -}; - -/*! \page example - * \dontinclude example_test.cpp - * Our main function starts like this: - * \skip main - * \until { - * First we create a object \c t of the Test class. - * \skipline Test - * Then we call the example member function - * \line example - * After that our little test routine ends. - * \line } - */ diff --git a/examples/jdstyle.cfg b/examples/jdstyle.cfg deleted file mode 100644 index c79a551..0000000 --- a/examples/jdstyle.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "JavaDoc Style" -OUTPUT_DIRECTORY = jdstyle -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = jdstyle.cpp -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/jdstyle.cpp b/examples/jdstyle.cpp deleted file mode 100644 index bd8b9a7..0000000 --- a/examples/jdstyle.cpp +++ /dev/null @@ -1,66 +0,0 @@ -/** - * A test class. A more elaborate class description. - */ - -class Test -{ - public: - - /** - * An enum. - * More detailed enum description. - */ - - enum TEnum { - TVal1, /**< enum value TVal1. */ - TVal2, /**< enum value TVal2. */ - TVal3 /**< enum value TVal3. */ - } - *enumPtr, /**< enum pointer. Details. */ - enumVar; /**< enum variable. Details. */ - - /** - * A constructor. - * A more elaborate description of the constructor. - */ - Test(); - - /** - * A destructor. - * A more elaborate description of the destructor. - */ - ~Test(); - - /** - * a normal member taking two arguments and returning an integer value. - * @param a an integer argument. - * @param s a constant character pointer. - * @see Test() - * @see ~Test() - * @see testMeToo() - * @see publicVar() - * @return The test results - */ - int testMe(int a,const char *s); - - /** - * A pure virtual member. - * @see testMe() - * @param c1 the first argument. - * @param c2 the second argument. - */ - virtual void testMeToo(char c1,char c2) = 0; - - /** - * a public variable. - * Details. - */ - int publicVar; - - /** - * a function variable. - * Details. - */ - int (*handler)(int a,int b); -}; - diff --git a/examples/memgrp.cfg b/examples/memgrp.cfg deleted file mode 100644 index ee7545b..0000000 --- a/examples/memgrp.cfg +++ /dev/null @@ -1,10 +0,0 @@ -PROJECT_NAME = "Member Grouping" -OUTPUT_DIRECTORY = memgrp -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = memgrp.cpp -QUIET = YES -DISTRIBUTE_GROUP_DOC = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/memgrp.cpp b/examples/memgrp.cpp deleted file mode 100644 index 394cdbc..0000000 --- a/examples/memgrp.cpp +++ /dev/null @@ -1,41 +0,0 @@ -/** A class. Details */ -class Test -{ - public: - //@{ - /** Same documentation for both members. Details */ - void func1InGroup1(); - void func2InGroup1(); - //@} - - /** Function without group. Details. */ - void ungroupedFunction(); - void func1InGroup2(); - protected: - void func2InGroup2(); -}; - -void Test::func1InGroup1() {} -void Test::func2InGroup1() {} - -/** @name Group2 - * Description of group 2. - */ -//@{ -/** Function 2 in group 2. Details. */ -void Test::func2InGroup2() {} -/** Function 1 in group 2. Details. */ -void Test::func1InGroup2() {} -//@} - -/*! \file - * docs for this file - */ - -//@{ -//! one description for all members of this group -//! (because DISTRIBUTE_GROUP_DOC is YES in the config file) -#define A 1 -#define B 2 -void glob_func(); -//@} diff --git a/examples/overload.cfg b/examples/overload.cfg deleted file mode 100644 index ee6cfc9..0000000 --- a/examples/overload.cfg +++ /dev/null @@ -1,10 +0,0 @@ -PROJECT_NAME = "Overloaded Command" -OUTPUT_DIRECTORY = overload -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -SORT_MEMBER_DOCS = NO -INPUT = overload.cpp -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/overload.cpp b/examples/overload.cpp deleted file mode 100644 index 02bcced..0000000 --- a/examples/overload.cpp +++ /dev/null @@ -1,25 +0,0 @@ -class Test -{ - public: - void drawRect(int,int,int,int); - void drawRect(const Rect &r); -}; - -void Test::drawRect(int x,int y,int w,int h) {} -void Test::drawRect(const Rect &r) {} - -/*! \class Test - * \brief A short description. - * - * More text. - */ - -/*! \fn void Test::drawRect(int x,int y,int w,int h) - * This command draws a rectangle with a left upper corner at ( \a x , \a y ), - * width \a w and height \a h. - */ - -/*! - * \overload void Test::drawRect(const Rect &r) - */ - diff --git a/examples/page.cfg b/examples/page.cfg deleted file mode 100644 index 7dd9ee2..0000000 --- a/examples/page.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "Page Command" -OUTPUT_DIRECTORY = page -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = page.doc -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/page.doc b/examples/page.doc deleted file mode 100644 index 747a4b8..0000000 --- a/examples/page.doc +++ /dev/null @@ -1,14 +0,0 @@ -/*! \page page1 A documentation page - Leading text. - \section sec An example section - This page contains the subsections \ref subsection1 and \ref subsection2. - For more info see page \ref page2. - \subsection subsection1 The first subsection - Text. - \subsection subsection2 The second subsection - More text. -*/ - -/*! \page page2 Another page - Even more info. -*/ diff --git a/examples/par.cfg b/examples/par.cfg deleted file mode 100644 index 299eee8..0000000 --- a/examples/par.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "Par Command" -OUTPUT_DIRECTORY = par -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = par.cpp -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/par.cpp b/examples/par.cpp deleted file mode 100644 index 6fd2c4e..0000000 --- a/examples/par.cpp +++ /dev/null @@ -1,20 +0,0 @@ -/*! \class Test - * Normal text. - * - * \par User defined paragraph: - * Contents of the paragraph. - * - * \par - * New paragraph under the same heading. - * - * \note - * This note consists of two paragraphs. - * This is the first paragraph. - * - * \par - * And this is the second paragraph. - * - * More normal text. - */ - -class Test {}; diff --git a/examples/pyexample.cfg b/examples/pyexample.cfg deleted file mode 100644 index c6fc3fa..0000000 --- a/examples/pyexample.cfg +++ /dev/null @@ -1,9 +0,0 @@ -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 deleted file mode 100644 index de04c28..0000000 --- a/examples/pyexample.py +++ /dev/null @@ -1,29 +0,0 @@ -## 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/qtstyle.cfg b/examples/qtstyle.cfg deleted file mode 100644 index 741b42b..0000000 --- a/examples/qtstyle.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "Qt Style" -OUTPUT_DIRECTORY = qtstyle -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = qtstyle.cpp -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/qtstyle.cpp b/examples/qtstyle.cpp deleted file mode 100644 index e24d541..0000000 --- a/examples/qtstyle.cpp +++ /dev/null @@ -1,65 +0,0 @@ -//! A test class. -/*! - A more elaborate class description. -*/ - -class Test -{ - public: - - //! An enum. - /*! More detailed enum description. */ - enum TEnum { - TVal1, /*!< Enum value TVal1. */ - TVal2, /*!< Enum value TVal2. */ - TVal3 /*!< Enum value TVal3. */ - } - //! Enum pointer. - /*! Details. */ - *enumPtr, - //! Enum variable. - /*! Details. */ - enumVar; - - //! A constructor. - /*! - A more elaborate description of the constructor. - */ - Test(); - - //! A destructor. - /*! - A more elaborate description of the destructor. - */ - ~Test(); - - //! A normal member taking two arguments and returning an integer value. - /*! - \param a an integer argument. - \param s a constant character pointer. - \return The test results - \sa Test(), ~Test(), testMeToo() and publicVar() - */ - int testMe(int a,const char *s); - - //! A pure virtual member. - /*! - \sa testMe() - \param c1 the first argument. - \param c2 the second argument. - */ - virtual void testMeToo(char c1,char c2) = 0; - - //! A public variable. - /*! - Details. - */ - int publicVar; - - //! A function variable. - /*! - Details. - */ - int (*handler)(int a,int b); -}; - diff --git a/examples/relates.cfg b/examples/relates.cfg deleted file mode 100644 index 7eb8f22..0000000 --- a/examples/relates.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "Relates Command" -OUTPUT_DIRECTORY = relates -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = relates.cpp -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/relates.cpp b/examples/relates.cpp deleted file mode 100644 index c6f7dc9..0000000 --- a/examples/relates.cpp +++ /dev/null @@ -1,23 +0,0 @@ -/*! - * A String class. - */ - -class String -{ - friend int strcmp(const String &,const String &); -}; - -/*! - * Compares two strings. - */ - -int strcmp(const String &s1,const String &s2) -{ -} - -/*! \relates String - * A string debug function. - */ -void stringDebug() -{ -} diff --git a/examples/restypedef.cfg b/examples/restypedef.cfg deleted file mode 100644 index 5c2214f..0000000 --- a/examples/restypedef.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "Resolving Typedefs" -OUTPUT_DIRECTORY = restypedef -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = restypedef.cpp -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/restypedef.cpp b/examples/restypedef.cpp deleted file mode 100644 index 923cf70..0000000 --- a/examples/restypedef.cpp +++ /dev/null @@ -1,25 +0,0 @@ -/*! \file restypedef.cpp - * An example of resolving typedefs. - */ - -/*! \struct CoordStruct - * A coordinate pair. - */ -struct CoordStruct -{ - /*! The x coordinate */ - float x; - /*! The y coordinate */ - float y; -}; - -/*! Creates a type name for CoordStruct */ -typedef CoordStruct Coord; - -/*! - * This function returns the addition of \a c1 and \a c2, i.e: - * (c1.x+c2.x,c1.y+c2.y) - */ -Coord add(Coord c1,Coord c2) -{ -} diff --git a/examples/structcmd.cfg b/examples/structcmd.cfg deleted file mode 100644 index a3d70bf..0000000 --- a/examples/structcmd.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "Structural commands" -OUTPUT_DIRECTORY = structcmd -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = structcmd.h -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/structcmd.h b/examples/structcmd.h deleted file mode 100644 index 3e27029..0000000 --- a/examples/structcmd.h +++ /dev/null @@ -1,57 +0,0 @@ -/*! \file structcmd.h - \brief A Documented file. - - Details. -*/ - -/*! \def MAX(a,b) - \brief A macro that returns the maximum of \a a and \a b. - - Details. -*/ - -/*! \var typedef unsigned int UINT32 - \brief A type definition for a . - - Details. -*/ - -/*! \var int errno - \brief Contains the last error code. - - \warning Not thread safe! -*/ - -/*! \fn int open(const char *pathname,int flags) - \brief Opens a file descriptor. - - \param pathname The name of the descriptor. - \param flags Opening flags. -*/ - -/*! \fn int close(int fd) - \brief Closes the file descriptor \a fd. - \param fd The descriptor to close. -*/ - -/*! \fn size_t write(int fd,const char *buf, size_t count) - \brief Writes \a count bytes from \a buf to the filedescriptor \a fd. - \param fd The descriptor to write to. - \param buf The data buffer to write. - \param count The number of bytes to write. -*/ - -/*! \fn int read(int fd,char *buf,size_t count) - \brief Read bytes from a file descriptor. - \param fd The descriptor to read from. - \param buf The buffer to read into. - \param count The number of bytes to read. -*/ - -#define MAX(a,b) (((a)>(b))?(a):(b)) -typedef unsigned int UINT32; -int errno; -int open(const char *,int); -int close(int); -size_t write(int,const char *, size_t); -int read(int,char *,size_t); diff --git a/examples/tag.cfg b/examples/tag.cfg deleted file mode 100644 index 9e79152..0000000 --- a/examples/tag.cfg +++ /dev/null @@ -1,11 +0,0 @@ -PROJECT_NAME = "Tag Files" -OUTPUT_DIRECTORY = tag -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = tag.cpp -TAGFILES = example.tag=../../example/html -PERL_PATH = perl -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/tag.cpp b/examples/tag.cpp deleted file mode 100644 index 6497dd4..0000000 --- a/examples/tag.cpp +++ /dev/null @@ -1,9 +0,0 @@ -/*! A class that is inherited from the external class Test. -*/ - -class Tag : public Test -{ - public: - /*! an overloaded member. */ - void example(); -}; diff --git a/examples/templ.cfg b/examples/templ.cfg deleted file mode 100644 index 4d85734..0000000 --- a/examples/templ.cfg +++ /dev/null @@ -1,9 +0,0 @@ -PROJECT_NAME = "Template Test" -OUTPUT_DIRECTORY = template -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = templ.cpp -QUIET = YES -JAVADOC_AUTOBRIEF = YES diff --git a/examples/templ.cpp b/examples/templ.cpp deleted file mode 100644 index 9ed48fb..0000000 --- a/examples/templ.cpp +++ /dev/null @@ -1,35 +0,0 @@ - -/*! A template class */ -template<class T,int i=100> class Test -{ - public: - Test(); - Test(const Test &); -}; - -/*! complete specialization */ -template<> class Test<void *,200> -{ - public: - Test(); -}; - -/*! A partial template specialization */ -template<class T> class Test<T *> : public Test<void *,200> -{ - public: - Test(); -}; - -/*! The constructor of the template class*/ -template<class T,int i> Test<T,i>::Test() {} - -/*! The copy constructor */ -template<class T,int i> Test<T,i>::Test(const Test &t) {} - -/*! The constructor of the partial specilization */ -template<class T> Test<T *>::Test() {} - -/*! The constructor of the specilization */ -template<> Test<void *,200>::Test() {} - |