diff options
author | Dimitri van Heesch <dimitri@stack.nl> | 2011-08-14 13:56:38 (GMT) |
---|---|---|
committer | Dimitri van Heesch <dimitri@stack.nl> | 2011-08-14 13:56:38 (GMT) |
commit | 9be758009e1a4c616377dc33ccf1e55dd8b04d9b (patch) | |
tree | 3138a0d18d53a00498b4cad59f934a4e64762cf8 /examples | |
parent | 64f0c97c3adaa28edf6f1da3264621a18c1d1adb (diff) | |
download | Doxygen-9be758009e1a4c616377dc33ccf1e55dd8b04d9b.zip Doxygen-9be758009e1a4c616377dc33ccf1e55dd8b04d9b.tar.gz Doxygen-9be758009e1a4c616377dc33ccf1e55dd8b04d9b.tar.bz2 |
Release-1.7.5
Diffstat (limited to 'examples')
-rw-r--r-- | examples/Makefile.in | 6 | ||||
-rw-r--r-- | examples/Makefile.win.in | 6 | ||||
-rw-r--r-- | examples/tclexample.cfg | 13 | ||||
-rw-r--r-- | examples/tclexample.tcl | 82 |
4 files changed, 105 insertions, 2 deletions
diff --git a/examples/Makefile.in b/examples/Makefile.in index 55bce8f..26b7c24 100644 --- a/examples/Makefile.in +++ b/examples/Makefile.in @@ -24,6 +24,7 @@ all: class/html/index.html \ memgrp/html/index.html \ docstring/html/index.html \ pyexample/html/index.html \ + tclexample/html/index.html \ mux/html/index.html \ manual/html/index.html @@ -34,7 +35,7 @@ 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 mux manual dbusxml + memgrp docstring pyexample mux manual dbusxml tclexample class/html/index.html: class.h class.cfg $(DOXYGEN)/bin/doxygen class.cfg @@ -107,6 +108,9 @@ memgrp/html/index.html: memgrp.cpp memgrp.cfg pyexample/html/index.html: pyexample.py pyexample.cfg $(DOXYGEN)/bin/doxygen pyexample.cfg +tclexample/html/index.html: tclexample.tcl tclexample.cfg + $(DOXYGEN)/bin/doxygen tclexample.cfg + mux/html/index.html: mux.vhdl mux.cfg $(DOXYGEN)/bin/doxygen mux.cfg diff --git a/examples/Makefile.win.in b/examples/Makefile.win.in index 0d5e64e..914c5ed 100644 --- a/examples/Makefile.win.in +++ b/examples/Makefile.win.in @@ -25,11 +25,12 @@ all: class/html/index.html \ memgrp/html/index.html \ docstring/html/index.html \ pyexample/html/index.html \ + tclexample/html/index.html \ mux/html/index.html \ manual/html/index.html clean: - del /s/y class define enum file pyexample docstring + del /s/y class define enum file pyexample tclexample docstring del /s/y func page relates author del /s/y par overload example include qtstyle del /s/y jdstyle structcmd autolink resdefine mux manual @@ -104,6 +105,9 @@ memgrp/html/index.html: memgrp.cpp memgrp.cfg pyexample/html/index.html: pyexample.py pyexample.cfg $(DOXYDIR)\doxygen pyexample.cfg +tclexample/html/index.html: tclexample.tcl tclexample.cfg + $(DOXYDIR)\doxygen tclexample.cfg + mux/html/index.html: mux.vhdl mux.cfg $(DOXYDIR)\doxygen mux.cfg diff --git a/examples/tclexample.cfg b/examples/tclexample.cfg new file mode 100644 index 0000000..a02bb2b --- /dev/null +++ b/examples/tclexample.cfg @@ -0,0 +1,13 @@ +PROJECT_NAME = "Tcl" +OUTPUT_DIRECTORY = tclexample +GENERATE_LATEX = NO +GENERATE_MAN = NO +GENERATE_RTF = NO +CASE_SENSE_NAMES = NO +INPUT = tclexample.tcl +QUIET = YES +JAVADOC_AUTOBRIEF = YES +SEARCHENGINE = NO +INLINE_SOURCES = YES +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES diff --git a/examples/tclexample.tcl b/examples/tclexample.tcl new file mode 100644 index 0000000..6edef66 --- /dev/null +++ b/examples/tclexample.tcl @@ -0,0 +1,82 @@ +## \file tclexample.tcl +# File documentation. +#\verbatim + +# Startup code:\ +exec tclsh "$0" "$@" +#\endverbatim +## Documented namespace \c ns . +# The code is inserted here: +#\code +namespace eval ns { + ## Documented proc \c ns_proc . + # param[in] arg some argument + proc ns_proc {arg} {} + ## Documented var \c ns_var . + # Some documentation. + variable ns_var + ## Documented itcl class \c itcl_class . + itcl::class itcl_class { + ## Create object. + constructor {args} {eval $args} + ## Destroy object. + destructor {exit} + ## Documented itcl method \c itcl_method_x . + # param[in] arg Argument + private method itcl_method_x {arg} + ## Documented itcl method \c itcl_method_y . + # param[in] arg Argument + protected method itcl_method_y {arg} {} + ## Documented itcl method \c itcl_method_z . + # param[in] arg Argument + public method itcl_method_z {arg} {} + ## Documented common itcl var \c itcl_Var . + common itcl_Var + ## \protectedsection + + variable itcl_var1;#< Documented itcl var \c itcl_var1 . + variable itcl_var2;#< Documented itcl var \c itcl_var2 . + } + ## Documented oo class \c oo_class . + oo::class create oo_class { + ## Create object. + # Configure with args + constructor {args} {eval $args} + ## Destroy object. + # Exit. + destructor {exit} + ## Documented oo var \c oo_var . + # Defined inside class + variable oo_var + ## \private Documented oo method \c oo_method_x . + # param[in] arg Argument + method oo_method_x {arg} {} + ## \protected Documented oo method \c oo_method_y . + # param[in] arg Argument + method oo_method_y {arg} {} + ## \public Documented oo method \c oo_method_z . + # param[in] arg Argument + method oo_method_z {arg} {} + } +} +#\endcode + +itcl::body ::ns::itcl_class::itcl_method_x {argx} { + puts "$argx OK" +} + +oo::define ns::oo_class { + ## \public Outside defined variable \c oo_var_out . + # Inside oo_class + variable oo_var_out +} + +## Documented global proc \c glob_proc . +# param[in] arg Argument +proc glob_proc {arg} {puts $arg} + +variable glob_var;#< Documented global var \c glob_var\ + with newline +#< and continued line + +# end of file |