diff options
| author | Karl Berry <karl@freefriends.org> | 2012-07-27 23:39:36 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2012-07-27 23:39:36 +0000 |
| commit | 667c94d4c814daec165a23fb251a7c38f37e202d (patch) | |
| tree | afb5f123bcb70a169633701290e90e4049c48bf7 /Master | |
| parent | e5a3f502a0f8618b02616ad91af5595471381723 (diff) | |
new support package lua2dox (20jul12)
git-svn-id: svn://tug.org/texlive/trunk@27205 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master')
147 files changed, 12853 insertions, 21 deletions
diff --git a/Master/bin/alpha-linux/lua2dox_filter b/Master/bin/alpha-linux/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/alpha-linux/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/alpha-linux/lua2dox_lua b/Master/bin/alpha-linux/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/alpha-linux/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/amd64-freebsd/lua2dox_filter b/Master/bin/amd64-freebsd/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/amd64-freebsd/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/amd64-freebsd/lua2dox_lua b/Master/bin/amd64-freebsd/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/amd64-freebsd/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/amd64-kfreebsd/lua2dox_filter b/Master/bin/amd64-kfreebsd/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/amd64-kfreebsd/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/amd64-kfreebsd/lua2dox_lua b/Master/bin/amd64-kfreebsd/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/amd64-kfreebsd/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/armel-linux/lua2dox_filter b/Master/bin/armel-linux/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/armel-linux/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/armel-linux/lua2dox_lua b/Master/bin/armel-linux/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/armel-linux/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/i386-cygwin/lua2dox_filter b/Master/bin/i386-cygwin/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/i386-cygwin/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/i386-cygwin/lua2dox_lua b/Master/bin/i386-cygwin/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/i386-cygwin/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/i386-freebsd/lua2dox_filter b/Master/bin/i386-freebsd/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/i386-freebsd/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/i386-freebsd/lua2dox_lua b/Master/bin/i386-freebsd/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/i386-freebsd/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/i386-kfreebsd/lua2dox_filter b/Master/bin/i386-kfreebsd/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/i386-kfreebsd/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/i386-kfreebsd/lua2dox_lua b/Master/bin/i386-kfreebsd/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/i386-kfreebsd/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/i386-linux/lua2dox_filter b/Master/bin/i386-linux/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/i386-linux/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/i386-linux/lua2dox_lua b/Master/bin/i386-linux/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/i386-linux/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/i386-solaris/lua2dox_filter b/Master/bin/i386-solaris/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/i386-solaris/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/i386-solaris/lua2dox_lua b/Master/bin/i386-solaris/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/i386-solaris/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/mipsel-linux/lua2dox_filter b/Master/bin/mipsel-linux/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/mipsel-linux/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/mipsel-linux/lua2dox_lua b/Master/bin/mipsel-linux/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/mipsel-linux/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/powerpc-aix/lua2dox_filter b/Master/bin/powerpc-aix/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/powerpc-aix/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/powerpc-aix/lua2dox_lua b/Master/bin/powerpc-aix/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/powerpc-aix/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/powerpc-linux/lua2dox_filter b/Master/bin/powerpc-linux/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/powerpc-linux/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/powerpc-linux/lua2dox_lua b/Master/bin/powerpc-linux/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/powerpc-linux/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/sparc-solaris/lua2dox_filter b/Master/bin/sparc-solaris/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/sparc-solaris/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/sparc-solaris/lua2dox_lua b/Master/bin/sparc-solaris/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/sparc-solaris/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/universal-darwin/lua2dox_filter b/Master/bin/universal-darwin/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/universal-darwin/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/universal-darwin/lua2dox_lua b/Master/bin/universal-darwin/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/universal-darwin/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/x86_64-darwin/lua2dox_filter b/Master/bin/x86_64-darwin/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/x86_64-darwin/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/x86_64-darwin/lua2dox_lua b/Master/bin/x86_64-darwin/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/x86_64-darwin/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/x86_64-linux/lua2dox_filter b/Master/bin/x86_64-linux/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/x86_64-linux/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/x86_64-linux/lua2dox_lua b/Master/bin/x86_64-linux/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/x86_64-linux/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/x86_64-solaris/lua2dox_filter b/Master/bin/x86_64-solaris/lua2dox_filter new file mode 120000 index 00000000000..813f7749250 --- /dev/null +++ b/Master/bin/x86_64-solaris/lua2dox_filter @@ -0,0 +1 @@ +lua2dox_lua
\ No newline at end of file diff --git a/Master/bin/x86_64-solaris/lua2dox_lua b/Master/bin/x86_64-solaris/lua2dox_lua new file mode 120000 index 00000000000..3dcc4b61c72 --- /dev/null +++ b/Master/bin/x86_64-solaris/lua2dox_lua @@ -0,0 +1 @@ +../../texmf-dist/scripts/lua2dox/lua2dox_lua
\ No newline at end of file diff --git a/Master/texmf-dist/doc/support/lua2dox/Doxyfile b/Master/texmf-dist/doc/support/lua2dox/Doxyfile new file mode 100644 index 00000000000..dd9865d6497 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/Doxyfile @@ -0,0 +1,1422 @@ +# Doxyfile 1.5.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = "Lua2dox.lua" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = "0.1 20120704" + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = docs + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# and Ukrainian. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 2 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +#EXTRACT_ALL = NO +EXTRACT_ALL = yes + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +#SORT_BRIEF_DOCS = NO +SORT_BRIEF_DOCS = yes + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command <command> <input-file>, where <command> is the value of +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = *.lua + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command <filter> <input-file>, where <filter> +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = *.lua=lua2dox_filter + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +#SOURCE_BROWSER = NO +SOURCE_BROWSER = yes + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentstion. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +#ALPHABETICAL_INDEX = NO +ALPHABETICAL_INDEX = yes + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to FRAME, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. Other possible values +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hiererachy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# respectively. + +GENERATE_TREEVIEW = NONE + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +#GENERATE_LATEX = YES +GENERATE_LATEX = no + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is enabled by default, which results in a transparent +# background. Warning: Depending on the platform used, enabling this option +# may lead to badly anti-aliased labels on the edges of a graph (i.e. they +# become hard to read). + +DOT_TRANSPARENT = YES + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/Master/texmf-dist/doc/support/lua2dox/INSTALL b/Master/texmf-dist/doc/support/lua2dox/INSTALL new file mode 100644 index 00000000000..9a1cc4886af --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/INSTALL @@ -0,0 +1,42 @@ +////////////////////// +// INSTALL +////////////////////// + +Only tested for linux, but should work for any unix-like OS. + +For other OS you need to figure it out yourself. +If you do, then please email me with the code/suggestions. + +/////////////// +// requirements +/////////////// +A reasonably recent: doxygen and luatex. + +Whilst luatex isn't strictly required to make it run for TeX users +we are more likely to have a recent version (via texlive) of texlua +rather than relying on you, possibly aging, distro's lua. + +/////////////// +linux/unix: +/////////////// + +1) manually check if lua2dox_lua runs on your system. + +From the commandline run "./lua2dox_lua --help". +If it runs and produces a sensible result then it probably works. + +2) Manually pick an appropriate directory for this system. + +Make this new directory and copy/mv all these files into there. +If you are installing it as a personal app then put it somewhere in your +userspace. For system-wide: ask sysadmin. + +3) Run "install.sh". +This makes the links to the active code. + +Default is to put in "~/bin". For system-wide: ask sysadmin. + +Erm, that's about it. + +Simon + diff --git a/Master/texmf-dist/doc/support/lua2dox/README b/Master/texmf-dist/doc/support/lua2dox/README new file mode 100644 index 00000000000..eefefecd7d1 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/README @@ -0,0 +1,17 @@ +########## +lua2dox_lua + +This is a hack to enable doxygen to document lua. + +It uses the wellknown doxygen filter mechanism to fool doxygen into reading foreign languages. + +If this works for you then enjoy. + +Files: + INSTALL -- help with installation + lua2dox-refm.pdf -- more extensive documentation + +Simon Dales +18/5/2012 + +##
\ No newline at end of file diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/doxygen.css b/Master/texmf-dist/doc/support/lua2dox/docs/html/doxygen.css new file mode 100644 index 00000000000..22c484301dd --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/doxygen.css @@ -0,0 +1,473 @@ +BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { + font-family: Geneva, Arial, Helvetica, sans-serif; +} +BODY,TD { + font-size: 90%; +} +H1 { + text-align: center; + font-size: 160%; +} +H2 { + font-size: 120%; +} +H3 { + font-size: 100%; +} +CAPTION { + font-weight: bold +} +DIV.qindex { + width: 100%; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.navpath { + width: 100%; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.navtab { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +TD.navtab { + font-size: 70%; +} +A.qindex { + text-decoration: none; + font-weight: bold; + color: #1A419D; +} +A.qindex:visited { + text-decoration: none; + font-weight: bold; + color: #1A419D +} +A.qindex:hover { + text-decoration: none; + background-color: #ddddff; +} +A.qindexHL { + text-decoration: none; + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} +A.qindexHL:hover { + text-decoration: none; + background-color: #6666cc; + color: #ffffff; +} +A.qindexHL:visited { + text-decoration: none; + background-color: #6666cc; + color: #ffffff +} +A.el { + text-decoration: none; + font-weight: bold +} +A.elRef { + font-weight: bold +} +A.code:link { + text-decoration: none; + font-weight: normal; + color: #0000FF +} +A.code:visited { + text-decoration: none; + font-weight: normal; + color: #0000FF +} +A.codeRef:link { + font-weight: normal; + color: #0000FF +} +A.codeRef:visited { + font-weight: normal; + color: #0000FF +} +A:hover { + text-decoration: none; + background-color: #f2f2ff +} +DL.el { + margin-left: -1cm +} +.fragment { + font-family: monospace, fixed; + font-size: 95%; +} +PRE.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + margin-top: 4px; + margin-bottom: 4px; + margin-left: 2px; + margin-right: 8px; + padding-left: 6px; + padding-right: 6px; + padding-top: 4px; + padding-bottom: 4px; +} +DIV.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px +} + +DIV.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} +DIV.groupText { + margin-left: 16px; + font-style: italic; + font-size: 90% +} +BODY { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} +TD.indexkey { + background-color: #e8eef2; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TD.indexvalue { + background-color: #e8eef2; + font-style: italic; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TR.memlist { + background-color: #f0f0f0; +} +P.formulaDsp { + text-align: center; +} +IMG.formulaDsp { +} +IMG.formulaInl { + vertical-align: middle; +} +SPAN.keyword { color: #008000 } +SPAN.keywordtype { color: #604020 } +SPAN.keywordflow { color: #e08000 } +SPAN.comment { color: #800000 } +SPAN.preprocessor { color: #806020 } +SPAN.stringliteral { color: #002080 } +SPAN.charliteral { color: #008080 } +SPAN.vhdldigit { color: #ff00ff } +SPAN.vhdlchar { color: #000000 } +SPAN.vhdlkeyword { color: #700070 } +SPAN.vhdllogic { color: #ff0000 } + +.mdescLeft { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.mdescRight { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.memItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplParams { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + color: #606060; + background-color: #FAFAFA; + font-size: 80%; +} +.search { + color: #003399; + font-weight: bold; +} +FORM.search { + margin-bottom: 0px; + margin-top: 0px; +} +INPUT.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +TD.tiny { + font-size: 75%; +} +a { + color: #1A41A8; +} +a:visited { + color: #2A3798; +} +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; +} +TH.dirtab { + background: #e8eef2; + font-weight: bold; +} +HR { + height: 1px; + border: none; + border-top: 1px solid black; +} + +/* Style for detailed member documentation */ +.memtemplate { + font-size: 80%; + color: #606060; + font-weight: normal; + margin-left: 3px; +} +.memnav { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +.memitem { + padding: 4px; + background-color: #eef3f5; + border-width: 1px; + border-style: solid; + border-color: #dedeee; + -moz-border-radius: 8px 8px 8px 8px; +} +.memname { + white-space: nowrap; + font-weight: bold; +} +.memdoc{ + padding-left: 10px; +} +.memproto { + background-color: #d5e1e8; + width: 100%; + border-width: 1px; + border-style: solid; + border-color: #84b0c7; + font-weight: bold; + -moz-border-radius: 8px 8px 8px 8px; +} +.paramkey { + text-align: right; +} +.paramtype { + white-space: nowrap; +} +.paramname { + color: #602020; + font-style: italic; + white-space: nowrap; +} +/* End Styling for detailed member documentation */ + +/* for the tree view */ +.ftvtree { + font-family: sans-serif; + margin:0.5em; +} +/* these are for tree view when used as main index */ +.directory { + font-size: 9pt; + font-weight: bold; +} +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* The following two styles can be used to replace the root node title */ +/* with an image of your choice. Simply uncomment the next two styles, */ +/* specify the name of your image and be sure to set 'height' to the */ +/* proper pixel height of your image. */ + +/* .directory h3.swap { */ +/* height: 61px; */ +/* background-repeat: no-repeat; */ +/* background-image: url("yourimage.gif"); */ +/* } */ +/* .directory h3.swap span { */ +/* display: none; */ +/* } */ + +.directory > h3 { + margin-top: 0; +} +.directory p { + margin: 0px; + white-space: nowrap; +} +.directory div { + display: none; + margin: 0px; +} +.directory img { + vertical-align: -30%; +} +/* these are for tree view when not used as main index */ +.directory-alt { + font-size: 100%; + font-weight: bold; +} +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} +.directory-alt > h3 { + margin-top: 0; +} +.directory-alt p { + margin: 0px; + white-space: nowrap; +} +.directory-alt div { + display: none; + margin: 0px; +} +.directory-alt img { + vertical-align: -30%; +} + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/doxygen.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/doxygen.png Binary files differnew file mode 100644 index 00000000000..f0a274bbaff --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/doxygen.png diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/files.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/files.html new file mode 100644 index 00000000000..09843a483b7 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/files.html @@ -0,0 +1,31 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Lua2dox.lua: File Index</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>File List</h1>Here is a list of all files with brief descriptions:<table> + <tr><td class="indexkey"><a class="el" href="lua2dox_8lua.html">lua2dox.lua</a> <a href="lua2dox_8lua-source.html">[code]</a></td><td class="indexvalue">Hack lua2dox converter </td></tr> +</table> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 4 18:43:04 2012 for Lua2dox.lua by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/globals.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/globals.html new file mode 100644 index 00000000000..c0ba18117fa --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/globals.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Lua2dox.lua: Class Members</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="globals.html"><span>All</span></a></li> + <li><a href="globals_func.html"><span>Functions</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +Here is a list of all file members with links to the files they belong to: +<p> +<ul> +<li>TApp_get_appname() +: <a class="el" href="lua2dox_8lua.html#a8d8cb1164baddf56a0f4ef092205c4e">lua2dox.lua</a> +<li>TApp_lua2dox() +: <a class="el" href="lua2dox_8lua.html#74b88070bd5a95792a78d7689683bbc5">lua2dox.lua</a> +<li>TApp_run_doxygen() +: <a class="el" href="lua2dox_8lua.html#ee20d6bfef623e5b2c79724b9f678f34">lua2dox.lua</a> +<li>TApp_run_filter() +: <a class="el" href="lua2dox_8lua.html#df242b2b881a8435694df310f4c4d4c8">lua2dox.lua</a> +<li>TClassList_method_add() +: <a class="el" href="lua2dox_8lua.html#733cdf7057ec0d5b75d3fb75c53ca1a8">lua2dox.lua</a> +<li>TClassList_method_get() +: <a class="el" href="lua2dox_8lua.html#5b7b06ae331027a06a3fc06b57d85d17">lua2dox.lua</a> +<li>TClock_GetTimeNow() +: <a class="el" href="lua2dox_8lua.html#19a8b481c5a12ffc3f25401650906ce9">lua2dox.lua</a> +<li>TClock_getTimeStamp() +: <a class="el" href="lua2dox_8lua.html#3fd5846eddbb7ec9f76d5ce2357c0e88">lua2dox.lua</a> +<li>TCommandline_getargv() +: <a class="el" href="lua2dox_8lua.html#09cdc805182dbf41bbb112a070d7f8d3">lua2dox.lua</a> +<li>TCommandline_setup() +: <a class="el" href="lua2dox_8lua.html#bee561867bc98123cb2b32cd4fcdd194">lua2dox.lua</a> +<li>TCommentary_addMethod() +: <a class="el" href="lua2dox_8lua.html#190a7dd20e13556bfc965ecb0e1daead">lua2dox.lua</a> +<li>TCommentary_close() +: <a class="el" href="lua2dox_8lua.html#6ee37dbd5aa2492ec864bab74cef9353">lua2dox.lua</a> +<li>TCommentary_open() +: <a class="el" href="lua2dox_8lua.html#d8f4828fcd44acdd083644d9a62a4634">lua2dox.lua</a> +<li>TCommentary_readFileContents() +: <a class="el" href="lua2dox_8lua.html#0745f5bf0c673993c099aa4698f63b3e">lua2dox.lua</a> +<li>TCommentary_writeln() +: <a class="el" href="lua2dox_8lua.html#11e685141b538df2a4a7ca9383e59b51">lua2dox.lua</a> +<li>TConfig_get() +: <a class="el" href="lua2dox_8lua.html#e5e473269b2227008c0f13a56ed2e813">lua2dox.lua</a> +<li>TConfig_set() +: <a class="el" href="lua2dox_8lua.html#6d8afe836be7511dd5149c14710b274b">lua2dox.lua</a> +<li>TIO_out2stream() +: <a class="el" href="lua2dox_8lua.html#a73dd4ef7ce5825633598152540e5c00">lua2dox.lua</a> +<li>TIO_out2stream_commented() +: <a class="el" href="lua2dox_8lua.html#8f7d772cf375b991ed20c07eaa77c2bd">lua2dox.lua</a> +<li>TIO_showError() +: <a class="el" href="lua2dox_8lua.html#383b6fb624afb857097cbbc1d5520ffa">lua2dox.lua</a> +<li>TIO_write() +: <a class="el" href="lua2dox_8lua.html#d0e8552aa4af17b3d2b59bf0abd352a2">lua2dox.lua</a> +<li>TIO_writeln() +: <a class="el" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5">lua2dox.lua</a> +<li>TOS_fileExists() +: <a class="el" href="lua2dox_8lua.html#ffdf3f8e4c73a649c71763128e3cf129">lua2dox.lua</a> +<li>TOS_system() +: <a class="el" href="lua2dox_8lua.html#1bda95a5b1b0216dc2ec005846137653">lua2dox.lua</a> +<li>TString_removeCommentFromLine() +: <a class="el" href="lua2dox_8lua.html#7c90afc5e8c521ab4a5cc6515e101e53">lua2dox.lua</a> +<li>TString_split() +: <a class="el" href="lua2dox_8lua.html#30ee7784cec05b0340a0a2ab3ad25f0d">lua2dox.lua</a> +<li>TString_trim() +: <a class="el" href="lua2dox_8lua.html#0cbbd73f5feb3232120247f9f8707c3e">lua2dox.lua</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 4 18:43:04 2012 for Lua2dox.lua by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/globals_func.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/globals_func.html new file mode 100644 index 00000000000..1ff826f57c1 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/globals_func.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Lua2dox.lua: Class Members</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="globals.html"><span>All</span></a></li> + <li class="current"><a href="globals_func.html"><span>Functions</span></a></li> + </ul> + </div> +</div> +<div class="contents"> + +<p> +<ul> +<li>TApp_get_appname() +: <a class="el" href="lua2dox_8lua.html#a8d8cb1164baddf56a0f4ef092205c4e">lua2dox.lua</a> +<li>TApp_lua2dox() +: <a class="el" href="lua2dox_8lua.html#74b88070bd5a95792a78d7689683bbc5">lua2dox.lua</a> +<li>TApp_run_doxygen() +: <a class="el" href="lua2dox_8lua.html#ee20d6bfef623e5b2c79724b9f678f34">lua2dox.lua</a> +<li>TApp_run_filter() +: <a class="el" href="lua2dox_8lua.html#df242b2b881a8435694df310f4c4d4c8">lua2dox.lua</a> +<li>TClassList_method_add() +: <a class="el" href="lua2dox_8lua.html#733cdf7057ec0d5b75d3fb75c53ca1a8">lua2dox.lua</a> +<li>TClassList_method_get() +: <a class="el" href="lua2dox_8lua.html#5b7b06ae331027a06a3fc06b57d85d17">lua2dox.lua</a> +<li>TClock_GetTimeNow() +: <a class="el" href="lua2dox_8lua.html#19a8b481c5a12ffc3f25401650906ce9">lua2dox.lua</a> +<li>TClock_getTimeStamp() +: <a class="el" href="lua2dox_8lua.html#3fd5846eddbb7ec9f76d5ce2357c0e88">lua2dox.lua</a> +<li>TCommandline_getargv() +: <a class="el" href="lua2dox_8lua.html#09cdc805182dbf41bbb112a070d7f8d3">lua2dox.lua</a> +<li>TCommandline_setup() +: <a class="el" href="lua2dox_8lua.html#bee561867bc98123cb2b32cd4fcdd194">lua2dox.lua</a> +<li>TCommentary_addMethod() +: <a class="el" href="lua2dox_8lua.html#190a7dd20e13556bfc965ecb0e1daead">lua2dox.lua</a> +<li>TCommentary_close() +: <a class="el" href="lua2dox_8lua.html#6ee37dbd5aa2492ec864bab74cef9353">lua2dox.lua</a> +<li>TCommentary_open() +: <a class="el" href="lua2dox_8lua.html#d8f4828fcd44acdd083644d9a62a4634">lua2dox.lua</a> +<li>TCommentary_readFileContents() +: <a class="el" href="lua2dox_8lua.html#0745f5bf0c673993c099aa4698f63b3e">lua2dox.lua</a> +<li>TCommentary_writeln() +: <a class="el" href="lua2dox_8lua.html#11e685141b538df2a4a7ca9383e59b51">lua2dox.lua</a> +<li>TConfig_get() +: <a class="el" href="lua2dox_8lua.html#e5e473269b2227008c0f13a56ed2e813">lua2dox.lua</a> +<li>TConfig_set() +: <a class="el" href="lua2dox_8lua.html#6d8afe836be7511dd5149c14710b274b">lua2dox.lua</a> +<li>TIO_out2stream() +: <a class="el" href="lua2dox_8lua.html#a73dd4ef7ce5825633598152540e5c00">lua2dox.lua</a> +<li>TIO_out2stream_commented() +: <a class="el" href="lua2dox_8lua.html#8f7d772cf375b991ed20c07eaa77c2bd">lua2dox.lua</a> +<li>TIO_showError() +: <a class="el" href="lua2dox_8lua.html#383b6fb624afb857097cbbc1d5520ffa">lua2dox.lua</a> +<li>TIO_write() +: <a class="el" href="lua2dox_8lua.html#d0e8552aa4af17b3d2b59bf0abd352a2">lua2dox.lua</a> +<li>TIO_writeln() +: <a class="el" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5">lua2dox.lua</a> +<li>TOS_fileExists() +: <a class="el" href="lua2dox_8lua.html#ffdf3f8e4c73a649c71763128e3cf129">lua2dox.lua</a> +<li>TOS_system() +: <a class="el" href="lua2dox_8lua.html#1bda95a5b1b0216dc2ec005846137653">lua2dox.lua</a> +<li>TString_removeCommentFromLine() +: <a class="el" href="lua2dox_8lua.html#7c90afc5e8c521ab4a5cc6515e101e53">lua2dox.lua</a> +<li>TString_split() +: <a class="el" href="lua2dox_8lua.html#30ee7784cec05b0340a0a2ab3ad25f0d">lua2dox.lua</a> +<li>TString_trim() +: <a class="el" href="lua2dox_8lua.html#0cbbd73f5feb3232120247f9f8707c3e">lua2dox.lua</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 4 18:43:04 2012 for Lua2dox.lua by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/index.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/index.html new file mode 100644 index 00000000000..4a3774bdb25 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/index.html @@ -0,0 +1,43 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Lua2dox.lua: Main Page</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li class="current"><a href="index.html"><span>Main Page</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Lua2dox.lua Documentation</h1> +<p> +<h3 align="center">0.1 20120704 </h3>A hack lua2dox converter Version 0.1<p> +This lets us make Doxygen output some documentation to let us develop this code.<p> +It is partially cribbed from the functionality of lua2dox (<a href="http://search.cpan.org/~alec/Doxygen-Lua-0.02/lib/Doxygen/Lua.pm">http://search.cpan.org/~alec/Doxygen-Lua-0.02/lib/Doxygen/Lua.pm</a>). Found on CPAN when looking for something else; kinda handy.<p> +Improved from lua2dox to make the doxygen output more friendly. Also it runs faster in lua rather than Perl.<p> +Because this Perl based system is called "lua2dox"., I have decided to add ".lua" to the name to keep the two separate.<p> +0. Ensure doxygen is installed on your system and that you are familiar with its use. Best is to try to make and document some simple C/C++/PHP to see what it produces.<p> +1. Run "lua2dox_lua -g" to create a default Doxyfile.<p> +Then alter it to let it recognise lua. Add the two following lines:<p> +FILE_PATTERNS = *.lua<p> +FILTER_PATTERNS = *.lua=lua2dox_filter<p> +Either add them to the end or find the appropriate entry in Doxyfile.<p> +2. When Doxyfile is edited run as "lua2dox_lua"<p> +When reading source with classes multiple passes are needed. Each pass generates a list of member functions (as a file) that were found on this pass. This list is read in on the next pass. If the class+methods haven't changed this time then you only need to run it once, else run twice.<p> +The core function reads the input file (filename or stdin) and outputs some pseudo C-ish language. It only has to be good enough for doxygen to see it as legal. Therefore our lua interpreter is fairly limited, but "good enough".<p> +One limitation is that each line is treated separately (except for long comments). The implication is that class and function declarations must be on the same line. Some functions can have their parameter lists extended over multiple lines to make it look neat. Managing this where there are also some comments is a bit more coding than I want to do at this stage, so it will probably not document accurately if we do do this.<p> +However I have put in a hack that will insert the "missing" close paren. The effect is that you will get the function documented, but not with the parameter list you might expect.<p> +Installation:<p> +Here for linux or unix-like, for any other OS you need to refer to other documentation.<p> +This file is "lua2dox.lua". It gets called by "lua2dox_lua". Somewhere in your path (e.g. "~/bin" or "/usr/local/bin") put two links to "lua2dox_lua". Names to use are "lua2dox_lua" and "lua2dox_filter".<p> +Call it as "lua2dox_lua" and the filter that gets called by doxygen is "lua2dox_filter". </div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 4 18:43:04 2012 for Lua2dox.lua by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua-source.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua-source.html new file mode 100644 index 00000000000..1fd59491e0e --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua-source.html @@ -0,0 +1,638 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Lua2dox.lua: lua2dox.lua Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +<h1>lua2dox.lua</h1><a href="lua2dox_8lua.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 --[[-------------------------------------------------------------------------- +<a name="l00002"></a>00002 -- Copyright (C) 2012 by Simon Dales -- +<a name="l00003"></a>00003 -- simon@purrsoft.co.uk -- +<a name="l00004"></a>00004 -- -- +<a name="l00005"></a>00005 -- This program is free software; you can redistribute it and/or modify -- +<a name="l00006"></a>00006 -- it under the terms of the GNU General Public License as published by -- +<a name="l00007"></a>00007 -- the Free Software Foundation; either version 2 of the License, or -- +<a name="l00008"></a>00008 -- (at your option) any later version. -- +<a name="l00009"></a>00009 -- -- +<a name="l00010"></a>00010 -- This program is distributed in the hope that it will be useful, -- +<a name="l00011"></a>00011 -- but WITHOUT ANY WARRANTY; without even the implied warranty of -- +<a name="l00012"></a>00012 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -- +<a name="l00013"></a>00013 -- GNU General Public License <span class="keywordflow">for</span> more details. -- +<a name="l00014"></a>00014 -- -- +<a name="l00015"></a>00015 -- You should have received a copy of the GNU General Public License -- +<a name="l00016"></a>00016 -- along with <span class="keyword">this</span> program; <span class="keywordflow">if</span> not, write to the -- +<a name="l00017"></a>00017 -- Free Software Foundation, Inc., -- +<a name="l00018"></a>00018 -- 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -- +<a name="l00019"></a>00019 ----------------------------------------------------------------------------]] +<a name="l00020"></a>00020 +<a name="l00021"></a>00021 --[[! +<a name="l00022"></a>00022 \file +<a name="l00023"></a>00023 \brief a hack lua2dox converter +<a name="l00024"></a>00024 ]] +<a name="l00025"></a>00025 +<a name="l00026"></a>00026 --[[! +<a name="l00027"></a>00027 \mainpage +<a name="l00028"></a>00028 +<a name="l00029"></a>00029 +<a name="l00030"></a>00030 A hack lua2dox converter +<a name="l00031"></a>00031 Version 0.1 +<a name="l00032"></a>00032 +<a name="l00033"></a>00033 This lets us make Doxygen output some documentation to let +<a name="l00034"></a>00034 us develop <span class="keyword">this</span> code. +<a name="l00035"></a>00035 +<a name="l00036"></a>00036 It is partially cribbed from the functionality of lua2dox +<a name="l00037"></a>00037 (http:<span class="comment">//search.cpan.org/~alec/Doxygen-Lua-0.02/lib/Doxygen/Lua.pm).</span> +<a name="l00038"></a>00038 Found on CPAN when looking <span class="keywordflow">for</span> something <span class="keywordflow">else</span>; kinda handy. +<a name="l00039"></a>00039 +<a name="l00040"></a>00040 Improved from lua2dox to make the doxygen output more friendly. +<a name="l00041"></a>00041 Also it runs faster in lua rather than Perl. +<a name="l00042"></a>00042 +<a name="l00043"></a>00043 Because <span class="keyword">this</span> Perl based system is called <span class="stringliteral">"lua2dox"</span>., I have decided to <span class="keyword">add</span> <span class="stringliteral">".lua"</span> to the name +<a name="l00044"></a>00044 to keep the two separate. +<a name="l00045"></a>00045 +<a name="l00046"></a>00046 0. Ensure doxygen is installed on your system and that you are familiar with its use. +<a name="l00047"></a>00047 Best is to <span class="keywordflow">try</span> to make and document some simple C/C++/PHP to see what it produces. +<a name="l00048"></a>00048 +<a name="l00049"></a>00049 1. Run <span class="stringliteral">"lua2dox_lua -g"</span> to create a <span class="keywordflow">default</span> Doxyfile. +<a name="l00050"></a>00050 +<a name="l00051"></a>00051 Then alter it to let it recognise lua. Add the two following lines: +<a name="l00052"></a>00052 +<a name="l00053"></a>00053 FILE_PATTERNS = *.lua +<a name="l00054"></a>00054 +<a name="l00055"></a>00055 FILTER_PATTERNS = *.lua=lua2dox_filter +<a name="l00056"></a>00056 +<a name="l00057"></a>00057 Either <span class="keyword">add</span> them to the end or find the appropriate entry in Doxyfile. +<a name="l00058"></a>00058 +<a name="l00059"></a>00059 2. When Doxyfile is edited run as <span class="stringliteral">"lua2dox_lua"</span> +<a name="l00060"></a>00060 +<a name="l00061"></a>00061 When reading source with classes multiple passes are needed. +<a name="l00062"></a>00062 Each pass generates a list of member functions (as a file) that were found on <span class="keyword">this</span> pass. +<a name="l00063"></a>00063 This list is read in on the next pass. +<a name="l00064"></a>00064 If the <span class="keyword">class</span>+methods haven<span class="stringliteral">'t changed this time then you only need to run it once, else run twice.</span> +<a name="l00065"></a>00065 <span class="stringliteral"> </span> +<a name="l00066"></a>00066 <span class="stringliteral"> The core function reads the input file (filename or stdin) and outputs some pseudo C-ish language.</span> +<a name="l00067"></a>00067 <span class="stringliteral"> It only has to be good enough for doxygen to see it as legal.</span> +<a name="l00068"></a>00068 <span class="stringliteral"> Therefore our lua interpreter is fairly limited, but "good enough".</span> +<a name="l00069"></a>00069 <span class="stringliteral"> </span> +<a name="l00070"></a>00070 <span class="stringliteral"> One limitation is that each line is treated separately (except for long comments).</span> +<a name="l00071"></a>00071 <span class="stringliteral"> The implication is that class and function declarations must be on the same line.</span> +<a name="l00072"></a>00072 <span class="stringliteral"> Some functions can have their parameter lists extended over multiple lines to make it look neat.</span> +<a name="l00073"></a>00073 <span class="stringliteral"> Managing this where there are also some comments is a bit more coding than I want to do at this stage,</span> +<a name="l00074"></a>00074 <span class="stringliteral"> so it will probably not document accurately if we do do this.</span> +<a name="l00075"></a>00075 <span class="stringliteral"> </span> +<a name="l00076"></a>00076 <span class="stringliteral"> However I have put in a hack that will insert the "missing" close paren.</span> +<a name="l00077"></a>00077 <span class="stringliteral"> The effect is that you will get the function documented, but not with the parameter list you might expect.</span> +<a name="l00078"></a>00078 <span class="stringliteral"> </span> +<a name="l00079"></a>00079 <span class="stringliteral"> Installation:</span> +<a name="l00080"></a>00080 <span class="stringliteral"> </span> +<a name="l00081"></a>00081 <span class="stringliteral"> Here for linux or unix-like, for any other OS you need to refer to other documentation.</span> +<a name="l00082"></a>00082 <span class="stringliteral"> </span> +<a name="l00083"></a>00083 <span class="stringliteral"> This file is "lua2dox.lua". It gets called by "lua2dox_lua".</span> +<a name="l00084"></a>00084 <span class="stringliteral"> Somewhere in your path (e.g. "~/bin" or "/usr/local/bin") put two links to "lua2dox_lua".</span> +<a name="l00085"></a>00085 <span class="stringliteral"> Names to use are "lua2dox_lua" and "lua2dox_filter".</span> +<a name="l00086"></a>00086 <span class="stringliteral"> </span> +<a name="l00087"></a>00087 <span class="stringliteral"> Call it as "lua2dox_lua" and the filter that gets called by doxygen is "lua2dox_filter".</span> +<a name="l00088"></a>00088 <span class="stringliteral"></span> +<a name="l00089"></a>00089 <span class="stringliteral"> ]]</span> +<a name="l00090"></a>00090 <span class="stringliteral"></span> +<a name="l00091"></a>00091 <span class="stringliteral">-- we won'</span>t use our library code, so <span class="keyword">this</span> becomes more portable +<a name="l00092"></a>00092 +<a name="l00093"></a>00093 local TConfig_config={ +<a name="l00094"></a>00094 [<span class="stringliteral">'LUA2DOX_COMMENTARY_FILE_IN'</span>]=<span class="stringliteral">'./killme_lua2dox.methods'</span> +<a name="l00095"></a>00095 ,[<span class="stringliteral">'LUA2DOX_COMMENTARY_FILE_OUT'</span>]=<span class="stringliteral">'./killme_lua2dox.methods.out'</span> +<a name="l00096"></a>00096 } +<a name="l00097"></a>00097 +<a name="l00098"></a>00098 --! \brief Gets a config val +<a name="l00099"></a><a class="code" href="lua2dox_8lua.html#e5e473269b2227008c0f13a56ed2e813">00099</a> local function <a class="code" href="lua2dox_8lua.html#e5e473269b2227008c0f13a56ed2e813" title="Gets a config val.">TConfig_get</a>(Key,Default) +<a name="l00100"></a>00100 local val = TConfig_config[Key] +<a name="l00101"></a>00101 if not val then +<a name="l00102"></a>00102 val = Default +<a name="l00103"></a>00103 end +<a name="l00104"></a>00104 return val +<a name="l00105"></a>00105 end +<a name="l00106"></a>00106 +<a name="l00107"></a>00107 --! \brief sets a config val +<a name="l00108"></a><a class="code" href="lua2dox_8lua.html#6d8afe836be7511dd5149c14710b274b">00108</a> local function <a class="code" href="lua2dox_8lua.html#6d8afe836be7511dd5149c14710b274b" title="sets a config val">TConfig_set</a>(Key,Val) +<a name="l00109"></a>00109 TConfig_config[Key] = Val +<a name="l00110"></a>00110 end +<a name="l00111"></a>00111 +<a name="l00112"></a>00112 --! \brief write to stdout +<a name="l00113"></a>00113 --! +<a name="l00114"></a>00114 --! writes Str (if not nil) +<a name="l00115"></a><a class="code" href="lua2dox_8lua.html#d0e8552aa4af17b3d2b59bf0abd352a2">00115</a> local function <a class="code" href="lua2dox_8lua.html#d0e8552aa4af17b3d2b59bf0abd352a2" title="write to stdout">TIO_write</a>(Str) +<a name="l00116"></a>00116 if (Str) then +<a name="l00117"></a>00117 io.write(Str) +<a name="l00118"></a>00118 end +<a name="l00119"></a>00119 end +<a name="l00120"></a>00120 +<a name="l00121"></a>00121 --! \brief write to stdout +<a name="l00122"></a>00122 --! +<a name="l00123"></a>00123 --! writelns Str (if not nil) and then an eoln. +<a name="l00124"></a><a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5">00124</a> local function <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>(Str) +<a name="l00125"></a>00125 if (Str) then +<a name="l00126"></a>00126 io.write(Str) +<a name="l00127"></a>00127 end +<a name="l00128"></a>00128 io.write("\n") +<a name="l00129"></a>00129 end +<a name="l00130"></a>00130 +<a name="l00131"></a>00131 --! \brief show error to stdout +<a name="l00132"></a>00132 --! +<a name="l00133"></a>00133 --! writelns Str (if not nil) and then an eoln. +<a name="l00134"></a><a class="code" href="lua2dox_8lua.html#383b6fb624afb857097cbbc1d5520ffa">00134</a> local function <a class="code" href="lua2dox_8lua.html#383b6fb624afb857097cbbc1d5520ffa" title="show error to stdout">TIO_showError</a>(Err,Str) +<a name="l00135"></a>00135 local err = Err +<a name="l00136"></a>00136 if not err then +<a name="l00137"></a>00137 err = 1 +<a name="l00138"></a>00138 end +<a name="l00139"></a>00139 +<a name="l00140"></a>00140 <a class="code" href="lua2dox_8lua.html#d0e8552aa4af17b3d2b59bf0abd352a2" title="write to stdout">TIO_write</a>('Error (' .. err .. '):') +<a name="l00141"></a>00141 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>(Str) +<a name="l00142"></a>00142 return err +<a name="l00143"></a>00143 end +<a name="l00144"></a>00144 +<a name="l00145"></a>00145 --! \brief run system command +<a name="l00146"></a><a class="code" href="lua2dox_8lua.html#1bda95a5b1b0216dc2ec005846137653">00146</a> local function <a class="code" href="lua2dox_8lua.html#1bda95a5b1b0216dc2ec005846137653" title="run system command">TOS_system</a>(Cmd) +<a name="l00147"></a>00147 local errno,str +<a name="l00148"></a>00148 local rtn = os.execute(Cmd) +<a name="l00149"></a>00149 if not (rtn==0) then +<a name="l00150"></a>00150 errno = rtn +<a name="l00151"></a>00151 str = 'an error occured' +<a name="l00152"></a>00152 end +<a name="l00153"></a>00153 return errno,str +<a name="l00154"></a>00154 end +<a name="l00155"></a>00155 +<a name="l00156"></a>00156 --! \brief does file exist? +<a name="l00157"></a><a class="code" href="lua2dox_8lua.html#ffdf3f8e4c73a649c71763128e3cf129">00157</a> local function <a class="code" href="lua2dox_8lua.html#ffdf3f8e4c73a649c71763128e3cf129" title="does file exist?">TOS_fileExists</a>(Filename) +<a name="l00158"></a>00158 local fh = io.open(Filename,'r') +<a name="l00159"></a>00159 if fh~=nil then +<a name="l00160"></a>00160 fh:close() +<a name="l00161"></a>00161 return true +<a name="l00162"></a>00162 end +<a name="l00163"></a>00163 return false +<a name="l00164"></a>00164 end +<a name="l00165"></a>00165 +<a name="l00166"></a>00166 --! \brief get the current time +<a name="l00167"></a><a class="code" href="lua2dox_8lua.html#19a8b481c5a12ffc3f25401650906ce9">00167</a> local function <a class="code" href="lua2dox_8lua.html#19a8b481c5a12ffc3f25401650906ce9" title="get the current time">TClock_GetTimeNow</a>() +<a name="l00168"></a>00168 if os.gettimeofday then +<a name="l00169"></a>00169 return os.gettimeofday() +<a name="l00170"></a>00170 else +<a name="l00171"></a>00171 return os.time() +<a name="l00172"></a>00172 end +<a name="l00173"></a>00173 end +<a name="l00174"></a>00174 +<a name="l00175"></a>00175 --! \brief get a timestamp +<a name="l00176"></a>00176 --! +<a name="l00177"></a>00177 --! not strictly necessary here but lets us put a timestamp on the end of the output stream. +<a name="l00178"></a>00178 --! Note that doxygen won't read this, and being off the end of the true file length (num lines), +<a name="l00179"></a>00179 --! it will have no effect. +<a name="l00180"></a>00180 --! However it lets us check the output file tail when debugging. +<a name="l00181"></a>00181 --! +<a name="l00182"></a><a class="code" href="lua2dox_8lua.html#3fd5846eddbb7ec9f76d5ce2357c0e88">00182</a> local function <a class="code" href="lua2dox_8lua.html#3fd5846eddbb7ec9f76d5ce2357c0e88" title="get a timestamp">TClock_getTimeStamp</a>() +<a name="l00183"></a>00183 local now = <a class="code" href="lua2dox_8lua.html#19a8b481c5a12ffc3f25401650906ce9" title="get the current time">TClock_GetTimeNow</a>() +<a name="l00184"></a>00184 local fraction_secs = now - math.floor(now) +<a name="l00185"></a>00185 return os.date('%c %Z',now) .. ':' .. fraction_secs +<a name="l00186"></a>00186 end +<a name="l00187"></a>00187 +<a name="l00188"></a>00188 --! \brief trims a <span class="keywordtype">string</span> from both ends +<a name="l00189"></a><a class="code" href="lua2dox_8lua.html#0cbbd73f5feb3232120247f9f8707c3e">00189</a> local function <a class="code" href="lua2dox_8lua.html#0cbbd73f5feb3232120247f9f8707c3e" title="trims a string from both ends">TString_trim</a>(Str) +<a name="l00190"></a>00190 return Str:match("^%s*(.-)%s*$") +<a name="l00191"></a>00191 end +<a name="l00192"></a>00192 +<a name="l00193"></a>00193 --! \brief split a <span class="keywordtype">string</span> +<a name="l00194"></a>00194 --! +<a name="l00195"></a>00195 --! \param Str +<a name="l00196"></a>00196 --! \param Pattern +<a name="l00197"></a>00197 --! \returns table of <span class="keywordtype">string</span> fragments +<a name="l00198"></a><a class="code" href="lua2dox_8lua.html#30ee7784cec05b0340a0a2ab3ad25f0d">00198</a> local function <a class="code" href="lua2dox_8lua.html#30ee7784cec05b0340a0a2ab3ad25f0d" title="split a string">TString_split</a>(Str, Pattern) +<a name="l00199"></a>00199 local splitStr = {} +<a name="l00200"></a>00200 local fpat = <span class="stringliteral">"(.-)"</span> .. Pattern +<a name="l00201"></a>00201 local last_end = 1 +<a name="l00202"></a>00202 local str, e, cap = <span class="keywordtype">string</span>.find(Str,fpat, 1) +<a name="l00203"></a>00203 <span class="keywordflow">while</span> str <span class="keywordflow">do</span> +<a name="l00204"></a>00204 <span class="keywordflow">if</span> str ~= 1 or cap ~= <span class="stringliteral">""</span> then +<a name="l00205"></a>00205 table.insert(splitStr,cap) +<a name="l00206"></a>00206 end +<a name="l00207"></a>00207 last_end = e+1 +<a name="l00208"></a>00208 str, e, cap = <span class="keywordtype">string</span>.find(Str,fpat, last_end) +<a name="l00209"></a>00209 end +<a name="l00210"></a>00210 <span class="keywordflow">if</span> last_end <= #Str then +<a name="l00211"></a>00211 cap = <span class="keywordtype">string</span>.sub(Str,last_end) +<a name="l00212"></a>00212 table.insert(splitStr, cap) +<a name="l00213"></a>00213 end +<a name="l00214"></a>00214 <span class="keywordflow">return</span> splitStr +<a name="l00215"></a>00215 end +<a name="l00216"></a>00216 +<a name="l00217"></a>00217 --! \brief trim comment off end of <span class="keywordtype">string</span> +<a name="l00218"></a>00218 --! +<a name="l00219"></a>00219 --! If the <span class="keywordtype">string</span> has a comment on the end, <span class="keyword">this</span> trims it off. +<a name="l00220"></a>00220 --! +<a name="l00221"></a><a class="code" href="lua2dox_8lua.html#7c90afc5e8c521ab4a5cc6515e101e53">00221</a> local function <a class="code" href="lua2dox_8lua.html#7c90afc5e8c521ab4a5cc6515e101e53" title="trim comment off end of string">TString_removeCommentFromLine</a>(Line) +<a name="l00222"></a>00222 local pos_comment = <span class="keywordtype">string</span>.find(Line,'%-%-') +<a name="l00223"></a>00223 if pos_comment then +<a name="l00224"></a>00224 Line = <span class="keywordtype">string</span>.sub(Line,1,pos_comment-1) +<a name="l00225"></a>00225 end +<a name="l00226"></a>00226 return Line +<a name="l00227"></a>00227 end +<a name="l00228"></a>00228 +<a name="l00229"></a>00229 local TClassList_methods = {} +<a name="l00230"></a>00230 --! \brief <span class="keyword">get</span> methods +<a name="l00231"></a><a class="code" href="lua2dox_8lua.html#5b7b06ae331027a06a3fc06b57d85d17">00231</a> local function <a class="code" href="lua2dox_8lua.html#5b7b06ae331027a06a3fc06b57d85d17" title="get methods">TClassList_method_get</a>(Klass) +<a name="l00232"></a>00232 return TClassList_methods[Klass] +<a name="l00233"></a>00233 end +<a name="l00234"></a>00234 +<a name="l00235"></a>00235 --! \brief add a method to list of known methods +<a name="l00236"></a><a class="code" href="lua2dox_8lua.html#733cdf7057ec0d5b75d3fb75c53ca1a8">00236</a> local function <a class="code" href="lua2dox_8lua.html#733cdf7057ec0d5b75d3fb75c53ca1a8" title="add a method to list of known methods">TClassList_method_add</a>(Klass,Method) +<a name="l00237"></a>00237 local classRec = TClassList_methods[Klass] +<a name="l00238"></a>00238 if not classRec then +<a name="l00239"></a>00239 TClassList_methods[Klass] = {} +<a name="l00240"></a>00240 classRec = TClassList_methods[Klass] +<a name="l00241"></a>00241 end +<a name="l00242"></a>00242 table.insert(classRec,Method) +<a name="l00243"></a>00243 end +<a name="l00244"></a>00244 +<a name="l00245"></a>00245 +<a name="l00246"></a>00246 local TCommentary_fh +<a name="l00247"></a>00247 +<a name="l00248"></a>00248 --! \brief write to output file +<a name="l00249"></a><a class="code" href="lua2dox_8lua.html#11e685141b538df2a4a7ca9383e59b51">00249</a> local function <a class="code" href="lua2dox_8lua.html#11e685141b538df2a4a7ca9383e59b51" title="write to output file">TCommentary_writeln</a>(Str) +<a name="l00250"></a>00250 if TCommentary_fh then +<a name="l00251"></a>00251 TCommentary_fh:write(Str .. '\n') +<a name="l00252"></a>00252 end +<a name="l00253"></a>00253 end +<a name="l00254"></a>00254 +<a name="l00255"></a>00255 local TCommentary_fileID +<a name="l00256"></a>00256 --! \brief open the commentary save file +<a name="l00257"></a><a class="code" href="lua2dox_8lua.html#d8f4828fcd44acdd083644d9a62a4634">00257</a> local function <a class="code" href="lua2dox_8lua.html#d8f4828fcd44acdd083644d9a62a4634" title="open the commentary save file">TCommentary_open</a>(Filename,InputLuaFilename) +<a name="l00258"></a>00258 TCommentary_fileID = '"' .. InputLuaFilename .. '" : ' .. <a class="code" href="lua2dox_8lua.html#3fd5846eddbb7ec9f76d5ce2357c0e88" title="get a timestamp">TClock_getTimeStamp</a>() +<a name="l00259"></a>00259 TCommentary_fh = io.open(Filename,'a+') +<a name="l00260"></a>00260 if TCommentary_fh then +<a name="l00261"></a>00261 <a class="code" href="lua2dox_8lua.html#11e685141b538df2a4a7ca9383e59b51" title="write to output file">TCommentary_writeln</a>('<span class="comment">// opened:' .. TCommentary_fileID)</span> +<a name="l00262"></a>00262 end +<a name="l00263"></a>00263 end +<a name="l00264"></a>00264 +<a name="l00265"></a>00265 --! \brief close the methods save file +<a name="l00266"></a><a class="code" href="lua2dox_8lua.html#6ee37dbd5aa2492ec864bab74cef9353">00266</a> local function <a class="code" href="lua2dox_8lua.html#6ee37dbd5aa2492ec864bab74cef9353" title="close the methods save file">TCommentary_close</a>() +<a name="l00267"></a>00267 if TCommentary_fh then +<a name="l00268"></a>00268 <a class="code" href="lua2dox_8lua.html#11e685141b538df2a4a7ca9383e59b51" title="write to output file">TCommentary_writeln</a>('<span class="comment">// closed: ' .. TCommentary_fileID)</span> +<a name="l00269"></a>00269 TCommentary_fh:close() +<a name="l00270"></a>00270 TCommentary_fh = nil +<a name="l00271"></a>00271 end +<a name="l00272"></a>00272 end +<a name="l00273"></a>00273 +<a name="l00274"></a>00274 --! \brief read stuff from save file +<a name="l00275"></a><a class="code" href="lua2dox_8lua.html#0745f5bf0c673993c099aa4698f63b3e">00275</a> local function <a class="code" href="lua2dox_8lua.html#0745f5bf0c673993c099aa4698f63b3e" title="read stuff from save file">TCommentary_readFileContents</a>(Filename) +<a name="l00276"></a>00276 if <a class="code" href="lua2dox_8lua.html#ffdf3f8e4c73a649c71763128e3cf129" title="does file exist?">TOS_fileExists</a>(Filename) then +<a name="l00277"></a>00277 local klass,method,dot +<a name="l00278"></a>00278 local cmd,colon +<a name="l00279"></a>00279 local k,v,equals +<a name="l00280"></a>00280 for line in io.lines(Filename) do +<a name="l00281"></a>00281 if <span class="keywordtype">string</span>.sub(line,1,2)=='<span class="comment">//' then</span> +<a name="l00282"></a>00282 -- it's a comment +<a name="l00283"></a>00283 else +<a name="l00284"></a>00284 colon = <span class="keywordtype">string</span>.find(line,':') +<a name="l00285"></a>00285 if colon then +<a name="l00286"></a>00286 cmd = <span class="keywordtype">string</span>.sub(line,1,colon) +<a name="l00287"></a>00287 line = <span class="keywordtype">string</span>.sub(line,colon+1) +<a name="l00288"></a>00288 else +<a name="l00289"></a>00289 cmd = nil +<a name="l00290"></a>00290 end +<a name="l00291"></a>00291 if (cmd == 'method:') then +<a name="l00292"></a>00292 dot = <span class="keywordtype">string</span>.find(line,'%.') +<a name="l00293"></a>00293 klass = <span class="keywordtype">string</span>.sub(line,1,dot-1) +<a name="l00294"></a>00294 method = <span class="keywordtype">string</span>.sub(line,dot+1) +<a name="l00295"></a>00295 <a class="code" href="lua2dox_8lua.html#733cdf7057ec0d5b75d3fb75c53ca1a8" title="add a method to list of known methods">TClassList_method_add</a>(klass,method) +<a name="l00296"></a>00296 elseif(cmd == 'set:') then +<a name="l00297"></a>00297 equals = <span class="keywordtype">string</span>.find(line,'=') +<a name="l00298"></a>00298 if equals then +<a name="l00299"></a>00299 k = <span class="keywordtype">string</span>.sub(line,1,equals-1) +<a name="l00300"></a>00300 v = <span class="keywordtype">string</span>.sub(line,equals+1) +<a name="l00301"></a>00301 <a class="code" href="lua2dox_8lua.html#6d8afe836be7511dd5149c14710b274b" title="sets a config val">TConfig_set</a>(k,v) +<a name="l00302"></a>00302 else +<a name="l00303"></a>00303 <a class="code" href="lua2dox_8lua.html#6d8afe836be7511dd5149c14710b274b" title="sets a config val">TConfig_set</a>(line,true) +<a name="l00304"></a>00304 end +<a name="l00305"></a>00305 else -- ignore +<a name="l00306"></a>00306 <a class="code" href="lua2dox_8lua.html#d0e8552aa4af17b3d2b59bf0abd352a2" title="write to stdout">TIO_write</a>('<span class="comment">/* bad command:"' .. line .. '" */</span>') +<a name="l00307"></a>00307 end +<a name="l00308"></a>00308 end +<a name="l00309"></a>00309 end +<a name="l00310"></a>00310 else +<a name="l00311"></a>00311 <a class="code" href="lua2dox_8lua.html#d0e8552aa4af17b3d2b59bf0abd352a2" title="write to stdout">TIO_write</a>('<span class="comment">/* file "' .. Filename .. '" don\'t exist */</span>') +<a name="l00312"></a>00312 end +<a name="l00313"></a>00313 end +<a name="l00314"></a>00314 +<a name="l00315"></a>00315 --! \brief method to save file +<a name="l00316"></a><a class="code" href="lua2dox_8lua.html#190a7dd20e13556bfc965ecb0e1daead">00316</a> local function <a class="code" href="lua2dox_8lua.html#190a7dd20e13556bfc965ecb0e1daead" title="method to save file">TCommentary_addMethod</a>(Klass,Method) +<a name="l00317"></a>00317 if TCommentary_fh then +<a name="l00318"></a>00318 if Klass and Method then +<a name="l00319"></a>00319 if <span class="keywordtype">string</span>.find(Klass,'%.') or <span class="keywordtype">string</span>.find(Method,'%.') then +<a name="l00320"></a>00320 -- iffy, so we discard it +<a name="l00321"></a>00321 else +<a name="l00322"></a>00322 <a class="code" href="lua2dox_8lua.html#11e685141b538df2a4a7ca9383e59b51" title="write to output file">TCommentary_writeln</a>('method:' .. Klass .. '.' .. Method) +<a name="l00323"></a>00323 end +<a name="l00324"></a>00324 end +<a name="l00325"></a>00325 end +<a name="l00326"></a>00326 end +<a name="l00327"></a>00327 +<a name="l00328"></a>00328 --! \brief output line to stream +<a name="l00329"></a>00329 --! +<a name="l00330"></a>00330 --! Wraps IO_writeln() +<a name="l00331"></a><a class="code" href="lua2dox_8lua.html#a73dd4ef7ce5825633598152540e5c00">00331</a> local function <a class="code" href="lua2dox_8lua.html#a73dd4ef7ce5825633598152540e5c00" title="output line to stream">TIO_out2stream</a>(Line) +<a name="l00332"></a>00332 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>(Line) +<a name="l00333"></a>00333 end +<a name="l00334"></a>00334 +<a name="l00335"></a>00335 --! \brief suppress line +<a name="l00336"></a><a class="code" href="lua2dox_8lua.html#8f7d772cf375b991ed20c07eaa77c2bd">00336</a> local function <a class="code" href="lua2dox_8lua.html#8f7d772cf375b991ed20c07eaa77c2bd" title="suppress line">TIO_out2stream_commented</a>(Line,Prefix,Suffix) +<a name="l00337"></a>00337 local line = Line +<a name="l00338"></a>00338 if (not Prefix) then +<a name="l00339"></a>00339 Prefix='' +<a name="l00340"></a>00340 end +<a name="l00341"></a>00341 line = Prefix .. ':' .. line +<a name="l00342"></a>00342 +<a name="l00343"></a>00343 if (Suffix) then +<a name="l00344"></a>00344 line = line .. Suffix +<a name="l00345"></a>00345 end +<a name="l00346"></a>00346 <a class="code" href="lua2dox_8lua.html#a73dd4ef7ce5825633598152540e5c00" title="output line to stream">TIO_out2stream</a>('<span class="comment">// D' .. line)</span> +<a name="l00347"></a>00347 end +<a name="l00348"></a>00348 +<a name="l00349"></a>00349 +<a name="l00350"></a>00350 TCommandline_argv = {} +<a name="l00351"></a>00351 --! \brief setup/parse the commandline +<a name="l00352"></a><a class="code" href="lua2dox_8lua.html#bee561867bc98123cb2b32cd4fcdd194">00352</a> local function <a class="code" href="lua2dox_8lua.html#bee561867bc98123cb2b32cd4fcdd194" title="setup/parse the commandline">TCommandline_setup</a>() +<a name="l00353"></a>00353 local argv1 =arg[1] +<a name="l00354"></a>00354 if not argv1 then +<a name="l00355"></a>00355 argv1 = 'base' +<a name="l00356"></a>00356 end +<a name="l00357"></a>00357 TCommandline_argv_appname = argv1 +<a name="l00358"></a>00358 +<a name="l00359"></a>00359 local i=2 +<a name="l00360"></a>00360 local argvi=1 +<a name="l00361"></a>00361 while (argvi) do +<a name="l00362"></a>00362 argvi = arg[i] +<a name="l00363"></a>00363 if argvi then +<a name="l00364"></a>00364 TCommandline_argv[i-1] = argvi +<a name="l00365"></a>00365 i = i + 1 +<a name="l00366"></a>00366 end +<a name="l00367"></a>00367 end +<a name="l00368"></a>00368 end +<a name="l00369"></a>00369 --! setup the commandline now +<a name="l00370"></a>00370 <a class="code" href="lua2dox_8lua.html#bee561867bc98123cb2b32cd4fcdd194" title="setup/parse the commandline">TCommandline_setup</a>() +<a name="l00371"></a>00371 +<a name="l00372"></a>00372 --! \brief get commandline args +<a name="l00373"></a><a class="code" href="lua2dox_8lua.html#09cdc805182dbf41bbb112a070d7f8d3">00373</a> local function <a class="code" href="lua2dox_8lua.html#09cdc805182dbf41bbb112a070d7f8d3" title="setup the commandline now">TCommandline_getargv</a>() +<a name="l00374"></a>00374 return TCommandline_argv +<a name="l00375"></a>00375 end +<a name="l00376"></a>00376 +<a name="l00377"></a>00377 --! \brief get appname +<a name="l00378"></a><a class="code" href="lua2dox_8lua.html#a8d8cb1164baddf56a0f4ef092205c4e">00378</a> local function <a class="code" href="lua2dox_8lua.html#a8d8cb1164baddf56a0f4ef092205c4e" title="get appname">TApp_get_appname</a>() +<a name="l00379"></a>00379 return TCommandline_argv_appname +<a name="l00380"></a>00380 end +<a name="l00381"></a>00381 +<a name="l00382"></a>00382 --! \brief hack converter from lua to a pseudoC-ish language for doxygen +<a name="l00383"></a>00383 --! +<a name="l00384"></a>00384 --! This is a hack to make lua readable to doxygen. +<a name="l00385"></a>00385 --! +<a name="l00386"></a>00386 --! It works well enough to document functions/methods and classes, but not assignments. +<a name="l00387"></a>00387 --! Our pseudo-C gets confused if we allow assginments to be shown. +<a name="l00388"></a>00388 --! Because these are less interesting than class/functions/methods I have decided to +<a name="l00389"></a>00389 --! live with this limitation. +<a name="l00390"></a>00390 --! +<a name="l00391"></a><a class="code" href="lua2dox_8lua.html#74b88070bd5a95792a78d7689683bbc5">00391</a> local function <a class="code" href="lua2dox_8lua.html#74b88070bd5a95792a78d7689683bbc5" title="hack converter from lua to a pseudoC-ish language for doxygen">TApp_lua2dox</a>(FileContents) +<a name="l00392"></a>00392 local err +<a name="l00393"></a>00393 local lines = FileContents +<a name="l00394"></a>00394 local maxi=<span class="preprocessor">#lines</span> +<a name="l00395"></a>00395 <span class="preprocessor"></span> +<a name="l00396"></a>00396 local i = 1 +<a name="l00397"></a>00397 local line,head +<a name="l00398"></a>00398 <span class="keywordflow">while</span> not err and (i<=maxi) do +<a name="l00399"></a>00399 line = <a class="code" href="lua2dox_8lua.html#0cbbd73f5feb3232120247f9f8707c3e" title="trims a string from both ends">TString_trim</a>(lines[i]) +<a name="l00400"></a>00400 if <span class="preprocessor">#line==0 then</span> +<a name="l00401"></a>00401 <span class="preprocessor"></span> <a class="code" href="lua2dox_8lua.html#a73dd4ef7ce5825633598152540e5c00" title="output line to stream">TIO_out2stream</a>() +<a name="l00402"></a>00402 elseif <span class="keywordtype">string</span>.sub(line,1,2)=='--' then +<a name="l00403"></a>00403 -- it's a comment of some kind +<a name="l00404"></a>00404 if <span class="keywordtype">string</span>.sub(line,1,3)=='--!' then +<a name="l00405"></a>00405 -- it's a magic comment +<a name="l00406"></a>00406 <a class="code" href="lua2dox_8lua.html#a73dd4ef7ce5825633598152540e5c00" title="output line to stream">TIO_out2stream</a>(' +<a name="l00407"></a>00407 elseif <span class="keywordtype">string</span>.sub(line,1,4)=='--[[' then +<a name="l00408"></a>00408 -- it's a multiline comment +<a name="l00409"></a>00409 -- read lines to end of comment +<a name="l00410"></a>00410 local hitend +<a name="l00411"></a>00411 local comment = '' +<a name="l00412"></a>00412 line = <span class="keywordtype">string</span>.sub(line,5) --.. sep +<a name="l00413"></a>00413 while not err and (i<maxi) and not hitend do +<a name="l00414"></a>00414 comment = comment .. line .. '\n' +<a name="l00415"></a>00415 line = lines[i+1] +<a name="l00416"></a>00416 --if (<span class="keywordtype">string</span>.sub(<a class="code" href="lua2dox_8lua.html#0cbbd73f5feb3232120247f9f8707c3e" title="trims a string from both ends">TString_trim</a>(line),1,2)==']]') then +<a name="l00417"></a>00417 if (<span class="keywordtype">string</span>.find(line,'\]\]')) then +<a name="l00418"></a>00418 local pos_close = <span class="keywordtype">string</span>.find(line,'\]\]') +<a name="l00419"></a>00419 comment = comment .. <span class="keywordtype">string</span>.sub(line,1,pos_close-1) +<a name="l00420"></a>00420 hitend=true +<a name="l00421"></a>00421 end +<a name="l00422"></a>00422 i = i + 1 +<a name="l00423"></a>00423 end +<a name="l00424"></a>00424 -- got <span class="keywordtype">long</span> comment +<a name="l00425"></a>00425 if <span class="keywordtype">string</span>.sub(comment,1,1)=='!' then +<a name="l00426"></a>00426 <a class="code" href="lua2dox_8lua.html#a73dd4ef7ce5825633598152540e5c00" title="output line to stream">TIO_out2stream</a>('<span class="comment">/*' .. comment .. '*/</span>') +<a name="l00427"></a>00427 else +<a name="l00428"></a>00428 <a class="code" href="lua2dox_8lua.html#a73dd4ef7ce5825633598152540e5c00" title="output line to stream">TIO_out2stream</a>('<span class="comment">/* (longcomment):' .. comment .. '*/</span>') +<a name="l00429"></a>00429 end +<a name="l00430"></a>00430 else +<a name="l00431"></a>00431 -- it's a boring comment +<a name="l00432"></a>00432 <a class="code" href="lua2dox_8lua.html#8f7d772cf375b991ed20c07eaa77c2bd" title="suppress line">TIO_out2stream_commented</a>(line,'--') +<a name="l00433"></a>00433 end +<a name="l00434"></a>00434 elseif <span class="keywordtype">string</span>.find(line,'^function%s') or <span class="keywordtype">string</span>.find(line,'^local%s+function%s')then +<a name="l00435"></a>00435 -- "function wibble..." +<a name="l00436"></a>00436 -- it's a function declaration +<a name="l00437"></a>00437 -- ....v... +<a name="l00438"></a>00438 local pos_fn = <span class="keywordtype">string</span>.find(line,'function') +<a name="l00439"></a>00439 if (pos_fn) then +<a name="l00440"></a>00440 local pos_local = <span class="keywordtype">string</span>.find(line,'^local%s+function%s') +<a name="l00441"></a>00441 local fn = <a class="code" href="lua2dox_8lua.html#7c90afc5e8c521ab4a5cc6515e101e53" title="trim comment off end of string">TString_removeCommentFromLine</a>(<a class="code" href="lua2dox_8lua.html#0cbbd73f5feb3232120247f9f8707c3e" title="trims a string from both ends">TString_trim</a>(<span class="keywordtype">string</span>.sub(line,pos_fn+8))) +<a name="l00442"></a>00442 +<a name="l00443"></a>00443 if (<span class="keywordtype">string</span>.sub(fn,1,1)=='(') then +<a name="l00444"></a>00444 -- anonymous function +<a name="l00445"></a>00445 <a class="code" href="lua2dox_8lua.html#8f7d772cf375b991ed20c07eaa77c2bd" title="suppress line">TIO_out2stream_commented</a>(line,'anon fn') +<a name="l00446"></a>00446 else +<a name="l00447"></a>00447 --[[ +<a name="l00448"></a>00448 we might have extracted a fn def with parameters on multilines +<a name="l00449"></a>00449 The hack is to insert a new close paren with a note to that effect. +<a name="l00450"></a>00450 ]] +<a name="l00451"></a>00451 +<a name="l00452"></a>00452 if not <span class="keywordtype">string</span>.find(fn,'%)') then +<a name="l00453"></a>00453 fn = fn .. ' ___MissingCloseParenHere___)' +<a name="l00454"></a>00454 end +<a name="l00455"></a>00455 +<a name="l00456"></a>00456 local plain_fn_str = 'function ' .. fn .. '{}<span class="stringliteral">'</span> +<a name="l00457"></a>00457 <span class="stringliteral"> if pos_local then</span> +<a name="l00458"></a>00458 <span class="stringliteral"> plain_fn_str = '</span>local <span class="stringliteral">' .. plain_fn_str</span> +<a name="l00459"></a>00459 <span class="stringliteral"> end</span> +<a name="l00460"></a>00460 <span class="stringliteral"> </span> +<a name="l00461"></a>00461 <span class="stringliteral"> local dot = string.find(fn,'</span>%.<span class="stringliteral">')</span> +<a name="l00462"></a>00462 <span class="stringliteral"> if dot then -- it'</span>s a method +<a name="l00463"></a>00463 local klass = <span class="keywordtype">string</span>.sub(fn,1,dot-1) +<a name="l00464"></a>00464 local method = <span class="keywordtype">string</span>.sub(fn,dot+1) +<a name="l00465"></a>00465 local method_str = klass .. <span class="stringliteral">'::'</span> .. method .. <span class="stringliteral">'{}'</span> +<a name="l00466"></a>00466 <a class="code" href="lua2dox_8lua.html#190a7dd20e13556bfc965ecb0e1daead" title="method to save file">TCommentary_addMethod</a>(klass,method) +<a name="l00467"></a>00467 <a class="code" href="lua2dox_8lua.html#a73dd4ef7ce5825633598152540e5c00" title="output line to stream">TIO_out2stream</a>(method_str) +<a name="l00468"></a>00468 else +<a name="l00469"></a>00469 <a class="code" href="lua2dox_8lua.html#a73dd4ef7ce5825633598152540e5c00" title="output line to stream">TIO_out2stream</a>(plain_fn_str) +<a name="l00470"></a>00470 end +<a name="l00471"></a>00471 end +<a name="l00472"></a>00472 end +<a name="l00473"></a>00473 elseif <span class="keywordtype">string</span>.find(line,'=%s+class%(') then +<a name="l00474"></a>00474 -- it's a class definition +<a name="l00475"></a>00475 line = <a class="code" href="lua2dox_8lua.html#7c90afc5e8c521ab4a5cc6515e101e53" title="trim comment off end of string">TString_removeCommentFromLine</a>(line) +<a name="l00476"></a>00476 local klass,parent,pos_class +<a name="l00477"></a>00477 -- ....v... +<a name="l00478"></a>00478 pos_class = <span class="keywordtype">string</span>.find(line,'=%s+class%(') +<a name="l00479"></a>00479 klass = <a class="code" href="lua2dox_8lua.html#0cbbd73f5feb3232120247f9f8707c3e" title="trims a string from both ends">TString_trim</a>(<span class="keywordtype">string</span>.sub(line,1,pos_class-1)) +<a name="l00480"></a>00480 parent = <a class="code" href="lua2dox_8lua.html#0cbbd73f5feb3232120247f9f8707c3e" title="trims a string from both ends">TString_trim</a>(<span class="keywordtype">string</span>.sub(line,pos_class+8)) +<a name="l00481"></a>00481 parent = <span class="keywordtype">string</span>.sub(parent,1,-2) +<a name="l00482"></a>00482 +<a name="l00483"></a>00483 line = 'class ' .. klass +<a name="l00484"></a>00484 if (<span class="preprocessor">#parent>0) then</span> +<a name="l00485"></a>00485 <span class="preprocessor"></span> line = line .. <span class="stringliteral">' :public '</span> .. parent +<a name="l00486"></a>00486 end +<a name="l00487"></a>00487 +<a name="l00488"></a>00488 -- need methods list +<a name="l00489"></a>00489 local methods = <a class="code" href="lua2dox_8lua.html#5b7b06ae331027a06a3fc06b57d85d17" title="get methods">TClassList_method_get</a>(klass) +<a name="l00490"></a>00490 local methods_str +<a name="l00491"></a>00491 if methods then +<a name="l00492"></a>00492 methods_str = 'public: ' +<a name="l00493"></a>00493 for k,v in pairs(methods) do +<a name="l00494"></a>00494 methods_str = methods_str .. v .. ';' +<a name="l00495"></a>00495 end +<a name="l00496"></a>00496 else +<a name="l00497"></a>00497 methods_str = '<span class="comment">/* no methods reported */</span>' +<a name="l00498"></a>00498 end +<a name="l00499"></a>00499 line = line .. '{<span class="stringliteral">' .. methods_str .. '</span>}<span class="stringliteral">'</span> +<a name="l00500"></a>00500 <span class="stringliteral"> </span> +<a name="l00501"></a>00501 <span class="stringliteral"> TIO_out2stream(line .. '</span>;<span class="stringliteral">',true)</span> +<a name="l00502"></a>00502 <span class="stringliteral"> else</span> +<a name="l00503"></a>00503 <span class="stringliteral"> -- we don'</span>t know what <span class="keyword">this</span> line means, so we can probably just comment it out +<a name="l00504"></a>00504 <a class="code" href="lua2dox_8lua.html#8f7d772cf375b991ed20c07eaa77c2bd" title="suppress line">TIO_out2stream_commented</a>(line) +<a name="l00505"></a>00505 end +<a name="l00506"></a>00506 +<a name="l00507"></a>00507 i = i + 1 +<a name="l00508"></a>00508 end +<a name="l00509"></a>00509 return err +<a name="l00510"></a>00510 end +<a name="l00511"></a>00511 +<a name="l00512"></a>00512 --! \brief run the filter +<a name="l00513"></a>00513 --! +<a name="l00514"></a>00514 --! \param AppTimestamp application + timestamp for this run +<a name="l00515"></a>00515 --! \param Filename the filename or if nil stdin +<a name="l00516"></a>00516 --! \param CommentaryFiles names of commentary files +<a name="l00517"></a>00517 --! \return err or nil +<a name="l00518"></a>00518 --! +<a name="l00519"></a><a class="code" href="lua2dox_8lua.html#df242b2b881a8435694df310f4c4d4c8">00519</a> local function <a class="code" href="lua2dox_8lua.html#df242b2b881a8435694df310f4c4d4c8" title="run the filter">TApp_run_filter</a>(AppTimestamp,Filename,CommentaryFiles) +<a name="l00520"></a>00520 local err +<a name="l00521"></a>00521 local filecontents +<a name="l00522"></a>00522 if Filename then +<a name="l00523"></a>00523 -- syphon lines to our table +<a name="l00524"></a>00524 filecontents={} +<a name="l00525"></a>00525 <span class="keywordflow">for</span> line in io.lines(Filename) <span class="keywordflow">do</span> +<a name="l00526"></a>00526 table.insert(filecontents,line) +<a name="l00527"></a>00527 end +<a name="l00528"></a>00528 <span class="keywordflow">else</span> +<a name="l00529"></a>00529 -- <span class="keyword">get</span> stuff from stdin as a <span class="keywordtype">long</span> string (with crlfs etc) +<a name="l00530"></a>00530 filecontents=io.read(<span class="stringliteral">'*a'</span>) +<a name="l00531"></a>00531 -- make it a table of lines +<a name="l00532"></a>00532 filecontents = <a class="code" href="lua2dox_8lua.html#30ee7784cec05b0340a0a2ab3ad25f0d" title="split a string">TString_split</a>(filecontents,<span class="stringliteral">'[\n]'</span>) -- note <span class="keyword">this</span> only works <span class="keywordflow">for</span> unix files. +<a name="l00533"></a>00533 Filename = <span class="stringliteral">'stdin'</span> +<a name="l00534"></a>00534 end +<a name="l00535"></a>00535 +<a name="l00536"></a>00536 <span class="keywordflow">if</span> filecontents then +<a name="l00537"></a>00537 <a class="code" href="lua2dox_8lua.html#0745f5bf0c673993c099aa4698f63b3e" title="read stuff from save file">TCommentary_readFileContents</a>(CommentaryFiles.infile) +<a name="l00538"></a>00538 <a class="code" href="lua2dox_8lua.html#d8f4828fcd44acdd083644d9a62a4634" title="open the commentary save file">TCommentary_open</a>(CommentaryFiles.outfile,Filename) +<a name="l00539"></a>00539 +<a name="l00540"></a>00540 err = <a class="code" href="lua2dox_8lua.html#74b88070bd5a95792a78d7689683bbc5" title="hack converter from lua to a pseudoC-ish language for doxygen">TApp_lua2dox</a>(filecontents) +<a name="l00541"></a>00541 +<a name="l00542"></a>00542 <a class="code" href="lua2dox_8lua.html#6ee37dbd5aa2492ec864bab74cef9353" title="close the methods save file">TCommentary_close</a>() +<a name="l00543"></a>00543 +<a name="l00544"></a>00544 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>('<span class="comment">// done (' .. AppTimestamp .. ')')</span> +<a name="l00545"></a>00545 else +<a name="l00546"></a>00546 err = <a class="code" href="lua2dox_8lua.html#383b6fb624afb857097cbbc1d5520ffa" title="show error to stdout">TIO_showError</a>(1,'couldn\'t find any file contents') +<a name="l00547"></a>00547 end +<a name="l00548"></a>00548 return err +<a name="l00549"></a>00549 end +<a name="l00550"></a>00550 +<a name="l00551"></a>00551 --! \brief run doxygen for one +<a name="l00552"></a>00552 --! +<a name="l00553"></a>00553 --! \param AppTimestamp application + timestamp for this run +<a name="l00554"></a>00554 --! \param Argv commandline for this run +<a name="l00555"></a>00555 --! \param CommentaryFiles names of commentary files +<a name="l00556"></a>00556 --! \return err or nil +<a name="l00557"></a>00557 --! +<a name="l00558"></a><a class="code" href="lua2dox_8lua.html#ee20d6bfef623e5b2c79724b9f678f34">00558</a> local function <a class="code" href="lua2dox_8lua.html#ee20d6bfef623e5b2c79724b9f678f34" title="run doxygen for one">TApp_run_doxygen</a>(AppTimestamp,Argv,CommentaryFiles) +<a name="l00559"></a>00559 local err +<a name="l00560"></a>00560 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>('running: ' .. AppTimestamp) +<a name="l00561"></a>00561 +<a name="l00562"></a>00562 local argv1 = Argv[1] +<a name="l00563"></a>00563 if argv1=='--help' then +<a name="l00564"></a>00564 local appname = <a class="code" href="lua2dox_8lua.html#a8d8cb1164baddf56a0f4ef092205c4e" title="get appname">TApp_get_appname</a>() +<a name="l00565"></a>00565 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>('Syntax:') +<a name="l00566"></a>00566 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>(' ' .. appname .. ' [[-g] [-s]] [<Doxyfile name>]|--help') +<a name="l00567"></a>00567 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>(' --help show this text') +<a name="l00568"></a>00568 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>(' -g: generate new Doxyfile') +<a name="l00569"></a>00569 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>(' -s: generate new Doxyfile without comments') +<a name="l00570"></a>00570 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>(' <Doxyfile name>: name of Doxyfile') +<a name="l00571"></a>00571 +<a name="l00572"></a>00572 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>() +<a name="l00573"></a>00573 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>(' For help on doxygen run its help system directly') +<a name="l00574"></a>00574 --! \todo more help here +<a name="l00575"></a>00575 else +<a name="l00576"></a>00576 local cl = 'doxygen' +<a name="l00577"></a>00577 for i,argv_i in ipairs(Argv) do +<a name="l00578"></a>00578 if i>=1 then -- don't want to use this app's name +<a name="l00579"></a>00579 cl = cl .. ' ' .. argv_i +<a name="l00580"></a>00580 end +<a name="l00581"></a>00581 end +<a name="l00582"></a>00582 +<a name="l00583"></a>00583 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>('about to run "' .. cl .. '"') +<a name="l00584"></a>00584 err = <a class="code" href="lua2dox_8lua.html#1bda95a5b1b0216dc2ec005846137653" title="run system command">TOS_system</a>(cl) +<a name="l00585"></a>00585 +<a name="l00586"></a>00586 if not err then +<a name="l00587"></a>00587 -- cycle commentary files +<a name="l00588"></a>00588 local newComments=CommentaryFiles.outfile +<a name="l00589"></a>00589 local nextRunsComments=CommentaryFiles.infile +<a name="l00590"></a>00590 if <a class="code" href="lua2dox_8lua.html#ffdf3f8e4c73a649c71763128e3cf129" title="does file exist?">TOS_fileExists</a>(newComments) then +<a name="l00591"></a>00591 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>('found outfile "' .. newComments .. '"') +<a name="l00592"></a>00592 os.remove(nextRunsComments) +<a name="l00593"></a>00593 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>('mv "' .. newComments .. '"-> ' .. nextRunsComments .. '"') +<a name="l00594"></a>00594 os.rename(newComments,nextRunsComments) +<a name="l00595"></a>00595 end +<a name="l00596"></a>00596 end +<a name="l00597"></a>00597 end +<a name="l00598"></a>00598 return err +<a name="l00599"></a>00599 end +<a name="l00600"></a>00600 +<a name="l00601"></a>00601 -- main +<a name="l00602"></a>00602 local timestamp = <a class="code" href="lua2dox_8lua.html#3fd5846eddbb7ec9f76d5ce2357c0e88" title="get a timestamp">TClock_getTimeStamp</a>() +<a name="l00603"></a>00603 local appname = <a class="code" href="lua2dox_8lua.html#a8d8cb1164baddf56a0f4ef092205c4e" title="get appname">TApp_get_appname</a>() +<a name="l00604"></a>00604 local version = '0.1 20120704' +<a name="l00605"></a>00605 local appTimestamp = appname .. '(v' .. version .. ') :' .. timestamp +<a name="l00606"></a>00606 local commentary_files = { +<a name="l00607"></a>00607 infile=<a class="code" href="lua2dox_8lua.html#e5e473269b2227008c0f13a56ed2e813" title="Gets a config val.">TConfig_get</a>(<span class="stringliteral">'LUA2DOX_COMMENTARY_FILE_IN'</span>) +<a name="l00608"></a>00608 ,outfile=<a class="code" href="lua2dox_8lua.html#e5e473269b2227008c0f13a56ed2e813" title="Gets a config val.">TConfig_get</a>(<span class="stringliteral">'LUA2DOX_COMMENTARY_FILE_OUT'</span>) +<a name="l00609"></a>00609 } +<a name="l00610"></a>00610 +<a name="l00611"></a>00611 <span class="keywordflow">if</span> appname == <span class="stringliteral">'lua2dox_filter'</span> then +<a name="l00612"></a>00612 err = <a class="code" href="lua2dox_8lua.html#df242b2b881a8435694df310f4c4d4c8" title="run the filter">TApp_run_filter</a>(appTimestamp,<a class="code" href="lua2dox_8lua.html#09cdc805182dbf41bbb112a070d7f8d3" title="setup the commandline now">TCommandline_getargv</a>()[1],commentary_files) +<a name="l00613"></a>00613 <a class="code" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5" title="write to stdout">TIO_writeln</a>('<span class="comment">// do filter')</span> +<a name="l00614"></a>00614 else +<a name="l00615"></a>00615 err = <a class="code" href="lua2dox_8lua.html#ee20d6bfef623e5b2c79724b9f678f34" title="run doxygen for one">TApp_run_doxygen</a>(appTimestamp,<a class="code" href="lua2dox_8lua.html#09cdc805182dbf41bbb112a070d7f8d3" title="setup the commandline now">TCommandline_getargv</a>(),commentary_files) +<a name="l00616"></a>00616 end +<a name="l00617"></a>00617 +<a name="l00618"></a>00618 --eof +</pre></div></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 4 18:43:04 2012 for Lua2dox.lua by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua.html new file mode 100644 index 00000000000..3d6ae4e376c --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua.html @@ -0,0 +1,891 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Lua2dox.lua: lua2dox.lua File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>lua2dox.lua File Reference</h1>a hack lua2dox converter <a href="#_details">More...</a> +<p> + +<p> +<a href="lua2dox_8lua-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#a8d8cb1164baddf56a0f4ef092205c4e">TApp_get_appname</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get appname <a href="#a8d8cb1164baddf56a0f4ef092205c4e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#74b88070bd5a95792a78d7689683bbc5">TApp_lua2dox</a> (FileContents)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">hack converter from lua to a pseudoC-ish language for doxygen <a href="#74b88070bd5a95792a78d7689683bbc5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#ee20d6bfef623e5b2c79724b9f678f34">TApp_run_doxygen</a> (AppTimestamp, Argv, CommentaryFiles)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">run doxygen for one <a href="#ee20d6bfef623e5b2c79724b9f678f34"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#df242b2b881a8435694df310f4c4d4c8">TApp_run_filter</a> (AppTimestamp, Filename, CommentaryFiles)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">run the filter <a href="#df242b2b881a8435694df310f4c4d4c8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#733cdf7057ec0d5b75d3fb75c53ca1a8">TClassList_method_add</a> (Klass, Method)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">add a method to list of known methods <a href="#733cdf7057ec0d5b75d3fb75c53ca1a8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#5b7b06ae331027a06a3fc06b57d85d17">TClassList_method_get</a> (Klass)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get methods <a href="#5b7b06ae331027a06a3fc06b57d85d17"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#19a8b481c5a12ffc3f25401650906ce9">TClock_GetTimeNow</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the current time <a href="#19a8b481c5a12ffc3f25401650906ce9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#3fd5846eddbb7ec9f76d5ce2357c0e88">TClock_getTimeStamp</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get a timestamp <a href="#3fd5846eddbb7ec9f76d5ce2357c0e88"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#09cdc805182dbf41bbb112a070d7f8d3">TCommandline_getargv</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">setup the commandline now <a href="#09cdc805182dbf41bbb112a070d7f8d3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#bee561867bc98123cb2b32cd4fcdd194">TCommandline_setup</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">setup/parse the commandline <a href="#bee561867bc98123cb2b32cd4fcdd194"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#190a7dd20e13556bfc965ecb0e1daead">TCommentary_addMethod</a> (Klass, Method)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">method to save file <a href="#190a7dd20e13556bfc965ecb0e1daead"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#6ee37dbd5aa2492ec864bab74cef9353">TCommentary_close</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">close the methods save file <a href="#6ee37dbd5aa2492ec864bab74cef9353"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#d8f4828fcd44acdd083644d9a62a4634">TCommentary_open</a> (Filename, InputLuaFilename)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">open the commentary save file <a href="#d8f4828fcd44acdd083644d9a62a4634"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#0745f5bf0c673993c099aa4698f63b3e">TCommentary_readFileContents</a> (Filename)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">read stuff from save file <a href="#0745f5bf0c673993c099aa4698f63b3e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#11e685141b538df2a4a7ca9383e59b51">TCommentary_writeln</a> (Str)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">write to output file <a href="#11e685141b538df2a4a7ca9383e59b51"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#e5e473269b2227008c0f13a56ed2e813">TConfig_get</a> (Key, Default)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a config val. <a href="#e5e473269b2227008c0f13a56ed2e813"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#6d8afe836be7511dd5149c14710b274b">TConfig_set</a> (Key, Val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">sets a config val <a href="#6d8afe836be7511dd5149c14710b274b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#a73dd4ef7ce5825633598152540e5c00">TIO_out2stream</a> (Line)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">output line to stream <a href="#a73dd4ef7ce5825633598152540e5c00"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#8f7d772cf375b991ed20c07eaa77c2bd">TIO_out2stream_commented</a> (Line, Prefix, Suffix)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">suppress line <a href="#8f7d772cf375b991ed20c07eaa77c2bd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#383b6fb624afb857097cbbc1d5520ffa">TIO_showError</a> (Err, Str)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">show error to stdout <a href="#383b6fb624afb857097cbbc1d5520ffa"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#d0e8552aa4af17b3d2b59bf0abd352a2">TIO_write</a> (Str)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">write to stdout <a href="#d0e8552aa4af17b3d2b59bf0abd352a2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5">TIO_writeln</a> (Str)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">write to stdout <a href="#29f2cc64b69b929d83a5e004340291c5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#ffdf3f8e4c73a649c71763128e3cf129">TOS_fileExists</a> (Filename)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">does file exist? <a href="#ffdf3f8e4c73a649c71763128e3cf129"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#1bda95a5b1b0216dc2ec005846137653">TOS_system</a> (Cmd)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">run system command <a href="#1bda95a5b1b0216dc2ec005846137653"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#7c90afc5e8c521ab4a5cc6515e101e53">TString_removeCommentFromLine</a> (Line)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">trim comment off end of string <a href="#7c90afc5e8c521ab4a5cc6515e101e53"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#30ee7784cec05b0340a0a2ab3ad25f0d">TString_split</a> (Str, Pattern)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">split a string <a href="#30ee7784cec05b0340a0a2ab3ad25f0d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">local function </td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#0cbbd73f5feb3232120247f9f8707c3e">TString_trim</a> (Str)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">trims a string from both ends <a href="#0cbbd73f5feb3232120247f9f8707c3e"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +a hack lua2dox converter +<p> + +<p>Definition in file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="a8d8cb1164baddf56a0f4ef092205c4e"></a><!-- doxytag: member="lua2dox.lua::TApp_get_appname" ref="a8d8cb1164baddf56a0f4ef092205c4e" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TApp_get_appname </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +get appname +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00378">378</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="74b88070bd5a95792a78d7689683bbc5"></a><!-- doxytag: member="lua2dox.lua::TApp_lua2dox" ref="74b88070bd5a95792a78d7689683bbc5" args="(FileContents)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TApp_lua2dox </td> + <td>(</td> + <td class="paramtype">FileContents </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +hack converter from lua to a pseudoC-ish language for doxygen +<p> +This is a hack to make lua readable to doxygen.<p> +It works well enough to document functions/methods and classes, but not assignments. Our pseudo-C gets confused if we allow assginments to be shown. Because these are less interesting than class/functions/methods I have decided to live with this limitation. +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00391">391</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ee20d6bfef623e5b2c79724b9f678f34"></a><!-- doxytag: member="lua2dox.lua::TApp_run_doxygen" ref="ee20d6bfef623e5b2c79724b9f678f34" args="(AppTimestamp, Argv, CommentaryFiles)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TApp_run_doxygen </td> + <td>(</td> + <td class="paramtype">AppTimestamp </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Argv </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">CommentaryFiles </td> + <td class="paramname"></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +run doxygen for one +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>AppTimestamp</em> </td><td>application + timestamp for this run </td></tr> + <tr><td valign="top"></td><td valign="top"><em>Argv</em> </td><td>commandline for this run </td></tr> + <tr><td valign="top"></td><td valign="top"><em>CommentaryFiles</em> </td><td>names of commentary files </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>err or nil </dd></dl> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00558">558</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="df242b2b881a8435694df310f4c4d4c8"></a><!-- doxytag: member="lua2dox.lua::TApp_run_filter" ref="df242b2b881a8435694df310f4c4d4c8" args="(AppTimestamp, Filename, CommentaryFiles)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TApp_run_filter </td> + <td>(</td> + <td class="paramtype">AppTimestamp </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Filename </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">CommentaryFiles </td> + <td class="paramname"></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +run the filter +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>AppTimestamp</em> </td><td>application + timestamp for this run </td></tr> + <tr><td valign="top"></td><td valign="top"><em>Filename</em> </td><td>the filename or if nil stdin </td></tr> + <tr><td valign="top"></td><td valign="top"><em>CommentaryFiles</em> </td><td>names of commentary files </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>err or nil </dd></dl> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00519">519</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="733cdf7057ec0d5b75d3fb75c53ca1a8"></a><!-- doxytag: member="lua2dox.lua::TClassList_method_add" ref="733cdf7057ec0d5b75d3fb75c53ca1a8" args="(Klass, Method)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TClassList_method_add </td> + <td>(</td> + <td class="paramtype">Klass </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Method </td> + <td class="paramname"></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +add a method to list of known methods +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00236">236</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5b7b06ae331027a06a3fc06b57d85d17"></a><!-- doxytag: member="lua2dox.lua::TClassList_method_get" ref="5b7b06ae331027a06a3fc06b57d85d17" args="(Klass)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TClassList_method_get </td> + <td>(</td> + <td class="paramtype">Klass </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +get methods +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00231">231</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="19a8b481c5a12ffc3f25401650906ce9"></a><!-- doxytag: member="lua2dox.lua::TClock_GetTimeNow" ref="19a8b481c5a12ffc3f25401650906ce9" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TClock_GetTimeNow </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +get the current time +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00167">167</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="3fd5846eddbb7ec9f76d5ce2357c0e88"></a><!-- doxytag: member="lua2dox.lua::TClock_getTimeStamp" ref="3fd5846eddbb7ec9f76d5ce2357c0e88" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TClock_getTimeStamp </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +get a timestamp +<p> +not strictly necessary here but lets us put a timestamp on the end of the output stream. Note that doxygen won't read this, and being off the end of the true file length (num lines), it will have no effect. However it lets us check the output file tail when debugging. +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00182">182</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="09cdc805182dbf41bbb112a070d7f8d3"></a><!-- doxytag: member="lua2dox.lua::TCommandline_getargv" ref="09cdc805182dbf41bbb112a070d7f8d3" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TCommandline_getargv </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +setup the commandline now +<p> +get commandline args +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00373">373</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="bee561867bc98123cb2b32cd4fcdd194"></a><!-- doxytag: member="lua2dox.lua::TCommandline_setup" ref="bee561867bc98123cb2b32cd4fcdd194" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TCommandline_setup </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +setup/parse the commandline +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00352">352</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="190a7dd20e13556bfc965ecb0e1daead"></a><!-- doxytag: member="lua2dox.lua::TCommentary_addMethod" ref="190a7dd20e13556bfc965ecb0e1daead" args="(Klass, Method)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TCommentary_addMethod </td> + <td>(</td> + <td class="paramtype">Klass </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Method </td> + <td class="paramname"></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +method to save file +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00316">316</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6ee37dbd5aa2492ec864bab74cef9353"></a><!-- doxytag: member="lua2dox.lua::TCommentary_close" ref="6ee37dbd5aa2492ec864bab74cef9353" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TCommentary_close </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +close the methods save file +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00266">266</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d8f4828fcd44acdd083644d9a62a4634"></a><!-- doxytag: member="lua2dox.lua::TCommentary_open" ref="d8f4828fcd44acdd083644d9a62a4634" args="(Filename, InputLuaFilename)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TCommentary_open </td> + <td>(</td> + <td class="paramtype">Filename </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">InputLuaFilename </td> + <td class="paramname"></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +open the commentary save file +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00257">257</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0745f5bf0c673993c099aa4698f63b3e"></a><!-- doxytag: member="lua2dox.lua::TCommentary_readFileContents" ref="0745f5bf0c673993c099aa4698f63b3e" args="(Filename)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TCommentary_readFileContents </td> + <td>(</td> + <td class="paramtype">Filename </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +read stuff from save file +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00275">275</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="11e685141b538df2a4a7ca9383e59b51"></a><!-- doxytag: member="lua2dox.lua::TCommentary_writeln" ref="11e685141b538df2a4a7ca9383e59b51" args="(Str)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TCommentary_writeln </td> + <td>(</td> + <td class="paramtype">Str </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +write to output file +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00249">249</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e5e473269b2227008c0f13a56ed2e813"></a><!-- doxytag: member="lua2dox.lua::TConfig_get" ref="e5e473269b2227008c0f13a56ed2e813" args="(Key, Default)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TConfig_get </td> + <td>(</td> + <td class="paramtype">Key </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Default </td> + <td class="paramname"></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Gets a config val. +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00099">99</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6d8afe836be7511dd5149c14710b274b"></a><!-- doxytag: member="lua2dox.lua::TConfig_set" ref="6d8afe836be7511dd5149c14710b274b" args="(Key, Val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TConfig_set </td> + <td>(</td> + <td class="paramtype">Key </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Val </td> + <td class="paramname"></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +sets a config val +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00108">108</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a73dd4ef7ce5825633598152540e5c00"></a><!-- doxytag: member="lua2dox.lua::TIO_out2stream" ref="a73dd4ef7ce5825633598152540e5c00" args="(Line)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TIO_out2stream </td> + <td>(</td> + <td class="paramtype">Line </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +output line to stream +<p> +Wraps IO_writeln() +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00331">331</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8f7d772cf375b991ed20c07eaa77c2bd"></a><!-- doxytag: member="lua2dox.lua::TIO_out2stream_commented" ref="8f7d772cf375b991ed20c07eaa77c2bd" args="(Line, Prefix, Suffix)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TIO_out2stream_commented </td> + <td>(</td> + <td class="paramtype">Line </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Prefix </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Suffix </td> + <td class="paramname"></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +suppress line +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00336">336</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="383b6fb624afb857097cbbc1d5520ffa"></a><!-- doxytag: member="lua2dox.lua::TIO_showError" ref="383b6fb624afb857097cbbc1d5520ffa" args="(Err, Str)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TIO_showError </td> + <td>(</td> + <td class="paramtype">Err </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Str </td> + <td class="paramname"></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +show error to stdout +<p> +writelns Str (if not nil) and then an eoln. +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00134">134</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d0e8552aa4af17b3d2b59bf0abd352a2"></a><!-- doxytag: member="lua2dox.lua::TIO_write" ref="d0e8552aa4af17b3d2b59bf0abd352a2" args="(Str)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TIO_write </td> + <td>(</td> + <td class="paramtype">Str </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +write to stdout +<p> +writes Str (if not nil) +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00115">115</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="29f2cc64b69b929d83a5e004340291c5"></a><!-- doxytag: member="lua2dox.lua::TIO_writeln" ref="29f2cc64b69b929d83a5e004340291c5" args="(Str)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TIO_writeln </td> + <td>(</td> + <td class="paramtype">Str </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +write to stdout +<p> +writelns Str (if not nil) and then an eoln. +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00124">124</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ffdf3f8e4c73a649c71763128e3cf129"></a><!-- doxytag: member="lua2dox.lua::TOS_fileExists" ref="ffdf3f8e4c73a649c71763128e3cf129" args="(Filename)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TOS_fileExists </td> + <td>(</td> + <td class="paramtype">Filename </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +does file exist? +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00157">157</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="1bda95a5b1b0216dc2ec005846137653"></a><!-- doxytag: member="lua2dox.lua::TOS_system" ref="1bda95a5b1b0216dc2ec005846137653" args="(Cmd)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TOS_system </td> + <td>(</td> + <td class="paramtype">Cmd </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +run system command +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00146">146</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="7c90afc5e8c521ab4a5cc6515e101e53"></a><!-- doxytag: member="lua2dox.lua::TString_removeCommentFromLine" ref="7c90afc5e8c521ab4a5cc6515e101e53" args="(Line)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TString_removeCommentFromLine </td> + <td>(</td> + <td class="paramtype">Line </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +trim comment off end of string +<p> +If the string has a comment on the end, this trims it off. +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00221">221</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="30ee7784cec05b0340a0a2ab3ad25f0d"></a><!-- doxytag: member="lua2dox.lua::TString_split" ref="30ee7784cec05b0340a0a2ab3ad25f0d" args="(Str, Pattern)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TString_split </td> + <td>(</td> + <td class="paramtype">Str </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Pattern </td> + <td class="paramname"></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +split a string +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>Str</em> </td><td></td></tr> + <tr><td valign="top"></td><td valign="top"><em>Pattern</em> </td><td></td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>table of string fragments </dd></dl> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00198">198</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0cbbd73f5feb3232120247f9f8707c3e"></a><!-- doxytag: member="lua2dox.lua::TString_trim" ref="0cbbd73f5feb3232120247f9f8707c3e" args="(Str)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">local function TString_trim </td> + <td>(</td> + <td class="paramtype">Str </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +trims a string from both ends +<p> + +<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00189">189</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 4 18:43:04 2012 for Lua2dox.lua by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_b.gif b/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_b.gif Binary files differnew file mode 100644 index 00000000000..0d623483ffd --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_b.gif diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_l.gif b/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_l.gif Binary files differnew file mode 100644 index 00000000000..9b1e6337c92 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_l.gif diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_r.gif b/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_r.gif Binary files differnew file mode 100644 index 00000000000..ce9dd9f533c --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_r.gif diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/tabs.css b/Master/texmf-dist/doc/support/lua2dox/docs/html/tabs.css new file mode 100644 index 00000000000..95f00a91da3 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/tabs.css @@ -0,0 +1,102 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +DIV.tabs +{ + float : left; + width : 100%; + background : url("tab_b.gif") repeat-x bottom; + margin-bottom : 4px; +} + +DIV.tabs UL +{ + margin : 0px; + padding-left : 10px; + list-style : none; +} + +DIV.tabs LI, DIV.tabs FORM +{ + display : inline; + margin : 0px; + padding : 0px; +} + +DIV.tabs FORM +{ + float : right; +} + +DIV.tabs A +{ + float : left; + background : url("tab_r.gif") no-repeat right top; + border-bottom : 1px solid #84B0C7; + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + +DIV.tabs A:hover +{ + background-position: 100% -150px; +} + +DIV.tabs A:link, DIV.tabs A:visited, +DIV.tabs A:active, DIV.tabs A:hover +{ + color: #1A419D; +} + +DIV.tabs SPAN +{ + float : left; + display : block; + background : url("tab_l.gif") no-repeat left top; + padding : 5px 9px; + white-space : nowrap; +} + +DIV.tabs INPUT +{ + float : right; + display : inline; + font-size : 1em; +} + +DIV.tabs TD +{ + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + + + +/* Commented Backslash Hack hides rule from IE5-Mac \*/ +DIV.tabs SPAN {float : none;} +/* End IE5-Mac hack */ + +DIV.tabs A:hover SPAN +{ + background-position: 0% -150px; +} + +DIV.tabs LI.current A +{ + background-position: 100% -150px; + border-width : 0px; +} + +DIV.tabs LI.current SPAN +{ + background-position: 0% -150px; + padding-bottom : 6px; +} + +DIV.navpath +{ + background : none; + border : none; + border-bottom : 1px solid #84B0C7; +} diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/Doxyfile b/Master/texmf-dist/doc/support/lua2dox/examples/lua/Doxyfile new file mode 100644 index 00000000000..07a22d3f4eb --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/Doxyfile @@ -0,0 +1,1421 @@ +# Doxyfile 1.5.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = "Sample Code" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = "0.1 20120518" + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = docs + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# and Ukrainian. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 2 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +#EXTRACT_ALL = NO +EXTRACT_ALL = yes + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +#SORT_BRIEF_DOCS = NO +SORT_BRIEF_DOCS = yes + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command <command> <input-file>, where <command> is the value of +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = *.lua + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command <filter> <input-file>, where <filter> +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = *.lua=lua2dox_filter + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +#SOURCE_BROWSER = NO +SOURCE_BROWSER = yes + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentstion. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to FRAME, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. Other possible values +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hiererachy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# respectively. + +GENERATE_TREEVIEW = NONE + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +#GENERATE_LATEX = YES +GENERATE_LATEX = no + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is enabled by default, which results in a transparent +# background. Warning: Depending on the platform used, enabling this option +# may lead to badly anti-aliased labels on the edges of a graph (i.e. they +# become hard to read). + +DOT_TRANSPARENT = YES + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/animals.lua b/Master/texmf-dist/doc/support/lua2dox/examples/lua/animals.lua new file mode 100644 index 00000000000..4816cd0d4b9 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/animals.lua @@ -0,0 +1,120 @@ +---- Copyright 2012 Simon Dales +-- +-- This work may be distributed and/or modified under the +-- conditions of the LaTeX Project Public License, either version 1.3 +-- of this license or (at your option) any later version. +-- The latest version of this license is in +-- http://www.latex-project.org/lppl.txt +-- +-- This work has the LPPL maintenance status `maintained'. +-- +-- The Current Maintainer of this work is Simon Dales. +-- + +--[[! + \file + \brief test some classes + + ]] + +require 'class' + +--! \brief write to stdout +function TIO_write(Str) + if Str then + io.write(Str) + end +end + +--! \brief writeln to stdout +function TIO_writeln(Str) + if Str then + io.write(Str) + end + io.write('\n') +end + +--! \class Animal +--! \brief a base class +Animal = class() + +--! \brief constructor +function Animal.init(this) + this:setKind('animal') +end + +--! \brief set kind of object +function Animal.setKind(this,Kind) + this.kind = Kind +end + +--! \brief say the call of this animal +function Animal.call(this) + local speigel = this.speigel + if speigel then + speigel = ' says "' .. speigel .. '"' + else + speigel = ' <undefined call>' + end + + TIO_writeln(this.kind .. speigel) +end + +--! \brief an abstract bird +Bird = class(Animal) + +--! \brief constructor +function Bird.init(this) + Animal.init(this) + this:setKind('bird') +end + +--! \brief a subclassed bird +Pigeon = class(Bird) + +--! \brief constructor +function Pigeon.init(this) + Bird.init(this) + this:setKind('pigeon') + this.speigel = 'oh my poor toe Betty' +end + +--! \brief another subclassed bird +RedKite = class(Bird) + +--! \brief constructor +function RedKite.init(this) + Bird.init(this) + this:setKind('red kite') + this.speigel = 'weee-ooo ee oo ee oo ee oo' +end + +--! \brief a base mammal +Mammal = class(Animal) + +--! \brief constructor +function Mammal.init(this) + Animal.init(this) +end + +--! \brief a subclassed mammal +Cat = class(Mammal) + +--! \brief constructor +function Cat.init(this) + Mammal.init(this) + this:setKind('cat') + this.speigel = 'meow' +end + +--! \brief another subclassed mammal +Dog = class(Mammal) + +--! \brief constructor +function Dog.init(this) + Mammal.init(this) + this:setKind('dog') + this.speigel = 'woof' +end + +--eof
\ No newline at end of file diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/class.lua b/Master/texmf-dist/doc/support/lua2dox/examples/lua/class.lua new file mode 100644 index 00000000000..7e155ceb050 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/class.lua @@ -0,0 +1,85 @@ +---- Copyright 2011 Simon Dales +-- +-- This work may be distributed and/or modified under the +-- conditions of the LaTeX Project Public License, either version 1.3 +-- of this license or (at your option) any later version. +-- The latest version of this license is in +-- http://www.latex-project.org/lppl.txt +-- +-- This work has the LPPL maintenance status `maintained'. +-- +-- The Current Maintainer of this work is Simon Dales. +-- + +--[[! + \file + \brief enables classes in lua + ]] + +--[[ class.lua +-- Compatible with Lua 5.1 (not 5.0). + + --------------------- + + ]]-- +--! \brief ``declare'' as class +--! +--! use as: +--! \code{lua} +--! TWibble = class() +--! function TWibble:init(instance) +--! self.instance = instance +--! -- more stuff here +--! end +--! \endcode +--! +function class(BaseClass, ClassInitialiser) + local newClass = {} -- a new class newClass + if not ClassInitialiser and type(BaseClass) == 'function' then + ClassInitialiser = BaseClass + BaseClass = nil + elseif type(BaseClass) == 'table' then + -- our new class is a shallow copy of the base class! + for i,v in pairs(BaseClass) do + newClass[i] = v + end + newClass._base = BaseClass + end + -- the class will be the metatable for all its newInstanceects, + -- and they will look up their methods in it. + newClass.__index = newClass + + -- expose a constructor which can be called by <classname>(<args>) + local classMetatable = {} + classMetatable.__call = + function(class_tbl, ...) + local newInstance = {} + setmetatable(newInstance,newClass) + --if init then + -- init(newInstance,...) + if class_tbl.init then + class_tbl.init(newInstance,...) + else + -- make sure that any stuff from the base class is initialized! + if BaseClass and BaseClass.init then + BaseClass.init(newInstance, ...) + end + end + return newInstance + end + newClass.init = ClassInitialiser + newClass.is_a = + function(this, klass) + local thisMetabable = getmetatable(this) + while thisMetabable do + if thisMetabable == klass then + return true + end + thisMetabable = thisMetabable._base + end + return false + end + setmetatable(newClass, classMetatable) + return newClass +end +--eof
\ No newline at end of file diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/animals_8lua-source.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/animals_8lua-source.html new file mode 100644 index 00000000000..ef52b3662e6 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/animals_8lua-source.html @@ -0,0 +1,141 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: animals.lua Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +<h1>animals.lua</h1><a href="animals_8lua.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 ---- Copyright 2012 Simon Dales +<a name="l00002"></a>00002 -- +<a name="l00003"></a>00003 -- This work may be distributed and/or modified under the +<a name="l00004"></a>00004 -- conditions of the LaTeX Project Public License, either version 1.3 +<a name="l00005"></a>00005 -- of <span class="keyword">this</span> license or (at your option) any later version. +<a name="l00006"></a>00006 -- The latest version of <span class="keyword">this</span> license is in +<a name="l00007"></a>00007 -- http:<span class="comment">//www.latex-project.org/lppl.txt</span> +<a name="l00008"></a>00008 -- +<a name="l00009"></a>00009 -- This work has the LPPL maintenance status `maintained<span class="stringliteral">'.</span> +<a name="l00010"></a>00010 <span class="stringliteral">-- </span> +<a name="l00011"></a>00011 <span class="stringliteral">-- The Current Maintainer of this work is Simon Dales.</span> +<a name="l00012"></a>00012 <span class="stringliteral">--</span> +<a name="l00013"></a>00013 <span class="stringliteral"></span> +<a name="l00014"></a>00014 <span class="stringliteral">--[[!</span> +<a name="l00015"></a>00015 <span class="stringliteral"> \file</span> +<a name="l00016"></a>00016 <span class="stringliteral"> \brief test some classes</span> +<a name="l00017"></a>00017 <span class="stringliteral"> </span> +<a name="l00018"></a>00018 <span class="stringliteral"> ]]</span> +<a name="l00019"></a>00019 <span class="stringliteral"> </span> +<a name="l00020"></a>00020 <span class="stringliteral">require '</span><span class="keyword">class</span><span class="stringliteral">'</span> +<a name="l00021"></a>00021 <span class="stringliteral"></span> +<a name="l00022"></a>00022 <span class="stringliteral">--! \brief write to stdout</span> +<a name="l00023"></a><a class="code" href="animals_8lua.html#a5e8a20129b8aedaf1d33da6e81bddaa">00023</a> <span class="stringliteral">function TIO_write(Str)</span> +<a name="l00024"></a>00024 <span class="stringliteral"> if Str then</span> +<a name="l00025"></a>00025 <span class="stringliteral"> io.write(Str)</span> +<a name="l00026"></a>00026 <span class="stringliteral"> end</span> +<a name="l00027"></a>00027 <span class="stringliteral">end</span> +<a name="l00028"></a>00028 <span class="stringliteral"></span> +<a name="l00029"></a>00029 <span class="stringliteral">--! \brief writeln to stdout</span> +<a name="l00030"></a><a class="code" href="animals_8lua.html#b1f4ebf1dfca0be8b647148e8c742f05">00030</a> <span class="stringliteral">function TIO_writeln(Str)</span> +<a name="l00031"></a>00031 <span class="stringliteral"> if Str then</span> +<a name="l00032"></a>00032 <span class="stringliteral"> io.write(Str)</span> +<a name="l00033"></a>00033 <span class="stringliteral"> end</span> +<a name="l00034"></a>00034 <span class="stringliteral"> io.write('</span>\n<span class="stringliteral">')</span> +<a name="l00035"></a>00035 <span class="stringliteral">end</span> +<a name="l00036"></a>00036 <span class="stringliteral"></span> +<a name="l00037"></a>00037 <span class="stringliteral">--! \class Animal</span> +<a name="l00038"></a>00038 <span class="stringliteral">--! \brief a base class</span> +<a name="l00039"></a><a class="code" href="classAnimal.html">00039</a> <span class="stringliteral">Animal = class()</span> +<a name="l00040"></a>00040 <span class="stringliteral"></span> +<a name="l00041"></a>00041 <span class="stringliteral">--! \brief constructor</span> +<a name="l00042"></a><a class="code" href="classAnimal.html#6c19026825a93bffdd37b3296edb7a39">00042</a> <span class="stringliteral">function Animal.init(this)</span> +<a name="l00043"></a>00043 <span class="stringliteral"> this:setKind('</span>animal<span class="stringliteral">')</span> +<a name="l00044"></a>00044 <span class="stringliteral">end</span> +<a name="l00045"></a>00045 <span class="stringliteral"></span> +<a name="l00046"></a>00046 <span class="stringliteral">--! \brief set kind of object</span> +<a name="l00047"></a><a class="code" href="classAnimal.html#3860d62f4fc74989a2292a5c731ed52b">00047</a> <span class="stringliteral">function Animal.setKind(this,Kind)</span> +<a name="l00048"></a>00048 <span class="stringliteral"> this.kind = Kind</span> +<a name="l00049"></a>00049 <span class="stringliteral">end</span> +<a name="l00050"></a>00050 <span class="stringliteral"></span> +<a name="l00051"></a>00051 <span class="stringliteral">--! \brief say the call of this animal</span> +<a name="l00052"></a><a class="code" href="classAnimal.html#4eba095ffc8269b41283d512364ca081">00052</a> <span class="stringliteral">function Animal.call(this)</span> +<a name="l00053"></a>00053 <span class="stringliteral"> local speigel = this.speigel</span> +<a name="l00054"></a>00054 <span class="stringliteral"> if speigel then</span> +<a name="l00055"></a>00055 <span class="stringliteral"> speigel = '</span> says <span class="stringliteral">"' .. speigel .. '"</span><span class="stringliteral">'</span> +<a name="l00056"></a>00056 <span class="stringliteral"> else</span> +<a name="l00057"></a>00057 <span class="stringliteral"> speigel = '</span> <undefined call><span class="stringliteral">'</span> +<a name="l00058"></a>00058 <span class="stringliteral"> end</span> +<a name="l00059"></a>00059 <span class="stringliteral"> </span> +<a name="l00060"></a>00060 <span class="stringliteral"> TIO_writeln(this.kind .. speigel)</span> +<a name="l00061"></a>00061 <span class="stringliteral">end</span> +<a name="l00062"></a>00062 <span class="stringliteral"></span> +<a name="l00063"></a>00063 <span class="stringliteral">--! \brief an abstract bird</span> +<a name="l00064"></a><a class="code" href="classBird.html">00064</a> <span class="stringliteral">Bird = class(Animal)</span> +<a name="l00065"></a>00065 <span class="stringliteral"></span> +<a name="l00066"></a>00066 <span class="stringliteral">--! \brief constructor</span> +<a name="l00067"></a><a class="code" href="classBird.html#967ccea204b5b63752a4a2ea184c7efb">00067</a> <span class="stringliteral">function Bird.init(this)</span> +<a name="l00068"></a>00068 <span class="stringliteral"> Animal.init(this)</span> +<a name="l00069"></a>00069 <span class="stringliteral"> this:setKind('</span>bird<span class="stringliteral">')</span> +<a name="l00070"></a>00070 <span class="stringliteral">end</span> +<a name="l00071"></a>00071 <span class="stringliteral"></span> +<a name="l00072"></a>00072 <span class="stringliteral">--! \brief a subclassed bird</span> +<a name="l00073"></a><a class="code" href="classPigeon.html">00073</a> <span class="stringliteral">Pigeon = class(Bird)</span> +<a name="l00074"></a>00074 <span class="stringliteral"></span> +<a name="l00075"></a>00075 <span class="stringliteral">--! \brief constructor</span> +<a name="l00076"></a><a class="code" href="classPigeon.html#b9841e55917b4cb60bacaa394c3ae70e">00076</a> <span class="stringliteral">function Pigeon.init(this)</span> +<a name="l00077"></a>00077 <span class="stringliteral"> Bird.init(this)</span> +<a name="l00078"></a>00078 <span class="stringliteral"> this:setKind('</span>pigeon<span class="stringliteral">')</span> +<a name="l00079"></a>00079 <span class="stringliteral"> this.speigel = '</span>oh my poor toe Betty<span class="stringliteral">'</span> +<a name="l00080"></a>00080 <span class="stringliteral">end</span> +<a name="l00081"></a>00081 <span class="stringliteral"></span> +<a name="l00082"></a>00082 <span class="stringliteral">--! \brief another subclassed bird</span> +<a name="l00083"></a><a class="code" href="classRedKite.html">00083</a> <span class="stringliteral">RedKite = class(Bird)</span> +<a name="l00084"></a>00084 <span class="stringliteral"></span> +<a name="l00085"></a>00085 <span class="stringliteral">--! \brief constructor</span> +<a name="l00086"></a><a class="code" href="classRedKite.html#c4e5f4b008acabde923bb8f0b3272e96">00086</a> <span class="stringliteral">function RedKite.init(this)</span> +<a name="l00087"></a>00087 <span class="stringliteral"> Bird.init(this)</span> +<a name="l00088"></a>00088 <span class="stringliteral"> this:setKind('</span>red kite<span class="stringliteral">')</span> +<a name="l00089"></a>00089 <span class="stringliteral"> this.speigel = '</span>weee-ooo ee oo ee oo ee oo<span class="stringliteral">'</span> +<a name="l00090"></a>00090 <span class="stringliteral">end</span> +<a name="l00091"></a>00091 <span class="stringliteral"></span> +<a name="l00092"></a>00092 <span class="stringliteral">--! \brief a base mammal</span> +<a name="l00093"></a><a class="code" href="classMammal.html">00093</a> <span class="stringliteral">Mammal = class(Animal)</span> +<a name="l00094"></a>00094 <span class="stringliteral"></span> +<a name="l00095"></a>00095 <span class="stringliteral">--! \brief constructor</span> +<a name="l00096"></a><a class="code" href="classMammal.html#dd9704b77a8575066764961254bc264d">00096</a> <span class="stringliteral">function Mammal.init(this)</span> +<a name="l00097"></a>00097 <span class="stringliteral"> Animal.init(this)</span> +<a name="l00098"></a>00098 <span class="stringliteral">end</span> +<a name="l00099"></a>00099 <span class="stringliteral"></span> +<a name="l00100"></a>00100 <span class="stringliteral">--! \brief a subclassed mammal</span> +<a name="l00101"></a><a class="code" href="classCat.html">00101</a> <span class="stringliteral">Cat = class(Mammal)</span> +<a name="l00102"></a>00102 <span class="stringliteral"></span> +<a name="l00103"></a>00103 <span class="stringliteral">--! \brief constructor</span> +<a name="l00104"></a><a class="code" href="classCat.html#e1007241936e9988d179b7412e16ed81">00104</a> <span class="stringliteral">function Cat.init(this)</span> +<a name="l00105"></a>00105 <span class="stringliteral"> Mammal.init(this)</span> +<a name="l00106"></a>00106 <span class="stringliteral"> this:setKind('</span>cat<span class="stringliteral">')</span> +<a name="l00107"></a>00107 <span class="stringliteral"> this.speigel = '</span>meow<span class="stringliteral">'</span> +<a name="l00108"></a>00108 <span class="stringliteral">end</span> +<a name="l00109"></a>00109 <span class="stringliteral"></span> +<a name="l00110"></a>00110 <span class="stringliteral">--! \brief another subclassed mammal</span> +<a name="l00111"></a><a class="code" href="classDog.html">00111</a> <span class="stringliteral">Dog = class(Mammal)</span> +<a name="l00112"></a>00112 <span class="stringliteral"></span> +<a name="l00113"></a>00113 <span class="stringliteral">--! \brief constructor</span> +<a name="l00114"></a><a class="code" href="classDog.html#ed7e9b0a72e4cd6c6ac3964e16c0baa8">00114</a> <span class="stringliteral">function Dog.init(this)</span> +<a name="l00115"></a>00115 <span class="stringliteral"> Mammal.init(this)</span> +<a name="l00116"></a>00116 <span class="stringliteral"> this:setKind('</span>dog<span class="stringliteral">')</span> +<a name="l00117"></a>00117 <span class="stringliteral"> this.speigel = '</span>woof<span class="stringliteral">'</span> +<a name="l00118"></a>00118 <span class="stringliteral">end</span> +<a name="l00119"></a>00119 <span class="stringliteral"></span> +<a name="l00120"></a>00120 <span class="stringliteral">--eof</span> +</pre></div></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/animals_8lua.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/animals_8lua.html new file mode 100644 index 00000000000..deefb5e17a5 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/animals_8lua.html @@ -0,0 +1,113 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: animals.lua File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>animals.lua File Reference</h1>test some classes <a href="#_details">More...</a> +<p> + +<p> +<a href="animals_8lua-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Classes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimal.html">Animal</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">a base class <a href="classAnimal.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classBird.html">Bird</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">an abstract bird <a href="classBird.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classCat.html">Cat</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">a subclassed mammal <a href="classCat.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classDog.html">Dog</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">another subclassed mammal <a href="classDog.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classMammal.html">Mammal</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">a base mammal <a href="classMammal.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPigeon.html">Pigeon</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">a subclassed bird <a href="classPigeon.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedKite.html">RedKite</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">another subclassed bird <a href="classRedKite.html#_details">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">function </td><td class="memItemRight" valign="bottom"><a class="el" href="animals_8lua.html#a5e8a20129b8aedaf1d33da6e81bddaa">TIO_write</a> (Str)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">write to stdout <a href="#a5e8a20129b8aedaf1d33da6e81bddaa"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">function </td><td class="memItemRight" valign="bottom"><a class="el" href="animals_8lua.html#b1f4ebf1dfca0be8b647148e8c742f05">TIO_writeln</a> (Str)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">writeln to stdout <a href="#b1f4ebf1dfca0be8b647148e8c742f05"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +test some classes +<p> + +<p>Definition in file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="a5e8a20129b8aedaf1d33da6e81bddaa"></a><!-- doxytag: member="animals.lua::TIO_write" ref="a5e8a20129b8aedaf1d33da6e81bddaa" args="(Str)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">function TIO_write </td> + <td>(</td> + <td class="paramtype">Str </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +write to stdout +<p> + +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00023">23</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b1f4ebf1dfca0be8b647148e8c742f05"></a><!-- doxytag: member="animals.lua::TIO_writeln" ref="b1f4ebf1dfca0be8b647148e8c742f05" args="(Str)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">function TIO_writeln </td> + <td>(</td> + <td class="paramtype">Str </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +writeln to stdout +<p> + +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00030">30</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/annotated.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/annotated.html new file mode 100644 index 00000000000..562b4c6971b --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/annotated.html @@ -0,0 +1,39 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Class List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table> + <tr><td class="indexkey"><a class="el" href="classAnimal.html">Animal</a></td><td class="indexvalue">Base class </td></tr> + <tr><td class="indexkey"><a class="el" href="classBird.html">Bird</a></td><td class="indexvalue">Abstract bird </td></tr> + <tr><td class="indexkey"><a class="el" href="classCat.html">Cat</a></td><td class="indexvalue">Subclassed mammal </td></tr> + <tr><td class="indexkey"><a class="el" href="classDog.html">Dog</a></td><td class="indexvalue">Another subclassed mammal </td></tr> + <tr><td class="indexkey"><a class="el" href="classMammal.html">Mammal</a></td><td class="indexvalue">Base mammal </td></tr> + <tr><td class="indexkey"><a class="el" href="classPigeon.html">Pigeon</a></td><td class="indexvalue">Subclassed bird </td></tr> + <tr><td class="indexkey"><a class="el" href="classRedKite.html">RedKite</a></td><td class="indexvalue">Another subclassed bird </td></tr> +</table> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classAnimal-members.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classAnimal-members.html new file mode 100644 index 00000000000..1eb543d4790 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classAnimal-members.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Animal Member List</h1>This is the complete list of members for <a class="el" href="classAnimal.html">Animal</a>, including all inherited members.<p><table> + <tr class="memlist"><td><a class="el" href="classAnimal.html#4eba095ffc8269b41283d512364ca081">call</a>(this)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#6c19026825a93bffdd37b3296edb7a39">init</a>(this)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#3860d62f4fc74989a2292a5c731ed52b">setKind</a>(this, Kind)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> +</table></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classAnimal.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classAnimal.html new file mode 100644 index 00000000000..fcf3276c14c --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classAnimal.html @@ -0,0 +1,151 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Animal Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Animal Class Reference</h1><!-- doxytag: class="Animal" -->a base class +<a href="#_details">More...</a> +<p> +<div class="dynheader"> +Inheritance diagram for Animal:</div> +<div class="dynsection"> + +<p><center><img src="classAnimal.png" usemap="#Animal_map" border="0" alt=""></center> +<map name="Animal_map"> +<area href="classBird.html" alt="Bird" shape="rect" coords="34,56,92,80"> +<area href="classMammal.html" alt="Mammal" shape="rect" coords="170,56,228,80"> +<area href="classPigeon.html" alt="Pigeon" shape="rect" coords="0,112,58,136"> +<area href="classRedKite.html" alt="RedKite" shape="rect" coords="68,112,126,136"> +<area href="classCat.html" alt="Cat" shape="rect" coords="136,112,194,136"> +<area href="classDog.html" alt="Dog" shape="rect" coords="204,112,262,136"> +</map> +</div> + +<p> +<a href="classAnimal-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimal.html#4eba095ffc8269b41283d512364ca081">call</a> (this)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">say the call of this animal <a href="#4eba095ffc8269b41283d512364ca081"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimal.html#6c19026825a93bffdd37b3296edb7a39">init</a> (this)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#6c19026825a93bffdd37b3296edb7a39"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimal.html#3860d62f4fc74989a2292a5c731ed52b">setKind</a> (this, Kind)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">set kind of object <a href="#3860d62f4fc74989a2292a5c731ed52b"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +a base class +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00039">39</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="4eba095ffc8269b41283d512364ca081"></a><!-- doxytag: member="Animal::call" ref="4eba095ffc8269b41283d512364ca081" args="(this)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Animal::call </td> + <td>(</td> + <td class="paramtype">this </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +say the call of this animal +<p> + +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00052">52</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6c19026825a93bffdd37b3296edb7a39"></a><!-- doxytag: member="Animal::init" ref="6c19026825a93bffdd37b3296edb7a39" args="(this)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Animal::init </td> + <td>(</td> + <td class="paramtype">this </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +constructor +<p> + +<p>Reimplemented in <a class="el" href="classBird.html#967ccea204b5b63752a4a2ea184c7efb">Bird</a>, <a class="el" href="classPigeon.html#b9841e55917b4cb60bacaa394c3ae70e">Pigeon</a>, <a class="el" href="classRedKite.html#c4e5f4b008acabde923bb8f0b3272e96">RedKite</a>, <a class="el" href="classMammal.html#dd9704b77a8575066764961254bc264d">Mammal</a>, <a class="el" href="classCat.html#e1007241936e9988d179b7412e16ed81">Cat</a>, and <a class="el" href="classDog.html#ed7e9b0a72e4cd6c6ac3964e16c0baa8">Dog</a>.</p> + +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00042">42</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> + +</div> +</div><p> +<a class="anchor" name="3860d62f4fc74989a2292a5c731ed52b"></a><!-- doxytag: member="Animal::setKind" ref="3860d62f4fc74989a2292a5c731ed52b" args="(this, Kind)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Animal::setKind </td> + <td>(</td> + <td class="paramtype">this </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Kind </td> + <td class="paramname"></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +set kind of object +<p> + +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00047">47</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="animals_8lua-source.html">animals.lua</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classAnimal.png b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classAnimal.png Binary files differnew file mode 100644 index 00000000000..796bc999ca1 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classAnimal.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classBird-members.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classBird-members.html new file mode 100644 index 00000000000..acb22e7c62f --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classBird-members.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Bird Member List</h1>This is the complete list of members for <a class="el" href="classBird.html">Bird</a>, including all inherited members.<p><table> + <tr class="memlist"><td><a class="el" href="classAnimal.html#4eba095ffc8269b41283d512364ca081">call</a>(this)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classBird.html#967ccea204b5b63752a4a2ea184c7efb">init</a>(this)</td><td><a class="el" href="classBird.html">Bird</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#3860d62f4fc74989a2292a5c731ed52b">setKind</a>(this, Kind)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> +</table></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classBird.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classBird.html new file mode 100644 index 00000000000..fef38de921b --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classBird.html @@ -0,0 +1,87 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Bird Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Bird Class Reference</h1><!-- doxytag: class="Bird" --><!-- doxytag: inherits="Animal" -->an abstract bird +<a href="#_details">More...</a> +<p> +<div class="dynheader"> +Inheritance diagram for Bird:</div> +<div class="dynsection"> + +<p><center><img src="classBird.png" usemap="#Bird_map" border="0" alt=""></center> +<map name="Bird_map"> +<area href="classAnimal.html" alt="Animal" shape="rect" coords="32,0,87,24"> +<area href="classPigeon.html" alt="Pigeon" shape="rect" coords="0,112,55,136"> +<area href="classRedKite.html" alt="RedKite" shape="rect" coords="65,112,120,136"> +</map> +</div> + +<p> +<a href="classBird-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBird.html#967ccea204b5b63752a4a2ea184c7efb">init</a> (this)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#967ccea204b5b63752a4a2ea184c7efb"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +an abstract bird +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00064">64</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="967ccea204b5b63752a4a2ea184c7efb"></a><!-- doxytag: member="Bird::init" ref="967ccea204b5b63752a4a2ea184c7efb" args="(this)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Bird::init </td> + <td>(</td> + <td class="paramtype">this </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +constructor +<p> + +<p>Reimplemented from <a class="el" href="classAnimal.html#6c19026825a93bffdd37b3296edb7a39">Animal</a>.</p> + +<p>Reimplemented in <a class="el" href="classPigeon.html#b9841e55917b4cb60bacaa394c3ae70e">Pigeon</a>, and <a class="el" href="classRedKite.html#c4e5f4b008acabde923bb8f0b3272e96">RedKite</a>.</p> + +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00067">67</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="animals_8lua-source.html">animals.lua</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classBird.png b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classBird.png Binary files differnew file mode 100644 index 00000000000..d63f59dba48 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classBird.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classCat-members.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classCat-members.html new file mode 100644 index 00000000000..8d9612fa3ce --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classCat-members.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Cat Member List</h1>This is the complete list of members for <a class="el" href="classCat.html">Cat</a>, including all inherited members.<p><table> + <tr class="memlist"><td><a class="el" href="classAnimal.html#4eba095ffc8269b41283d512364ca081">call</a>(this)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classCat.html#e1007241936e9988d179b7412e16ed81">init</a>(this)</td><td><a class="el" href="classCat.html">Cat</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#3860d62f4fc74989a2292a5c731ed52b">setKind</a>(this, Kind)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> +</table></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classCat.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classCat.html new file mode 100644 index 00000000000..8f8312de26d --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classCat.html @@ -0,0 +1,84 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Cat Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Cat Class Reference</h1><!-- doxytag: class="Cat" --><!-- doxytag: inherits="Mammal" -->a subclassed mammal +<a href="#_details">More...</a> +<p> +<div class="dynheader"> +Inheritance diagram for Cat:</div> +<div class="dynsection"> + +<p><center><img src="classCat.png" usemap="#Cat_map" border="0" alt=""></center> +<map name="Cat_map"> +<area href="classMammal.html" alt="Mammal" shape="rect" coords="0,56,58,80"> +<area href="classAnimal.html" alt="Animal" shape="rect" coords="0,0,58,24"> +</map> +</div> + +<p> +<a href="classCat-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCat.html#e1007241936e9988d179b7412e16ed81">init</a> (this)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#e1007241936e9988d179b7412e16ed81"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +a subclassed mammal +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00101">101</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="e1007241936e9988d179b7412e16ed81"></a><!-- doxytag: member="Cat::init" ref="e1007241936e9988d179b7412e16ed81" args="(this)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Cat::init </td> + <td>(</td> + <td class="paramtype">this </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +constructor +<p> + +<p>Reimplemented from <a class="el" href="classMammal.html#dd9704b77a8575066764961254bc264d">Mammal</a>.</p> + +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00104">104</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="animals_8lua-source.html">animals.lua</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classCat.png b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classCat.png Binary files differnew file mode 100644 index 00000000000..8500fb0b00a --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classCat.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classDog-members.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classDog-members.html new file mode 100644 index 00000000000..1bc803f974c --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classDog-members.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Dog Member List</h1>This is the complete list of members for <a class="el" href="classDog.html">Dog</a>, including all inherited members.<p><table> + <tr class="memlist"><td><a class="el" href="classAnimal.html#4eba095ffc8269b41283d512364ca081">call</a>(this)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classDog.html#ed7e9b0a72e4cd6c6ac3964e16c0baa8">init</a>(this)</td><td><a class="el" href="classDog.html">Dog</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#3860d62f4fc74989a2292a5c731ed52b">setKind</a>(this, Kind)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> +</table></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classDog.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classDog.html new file mode 100644 index 00000000000..a02084640f5 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classDog.html @@ -0,0 +1,84 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Dog Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Dog Class Reference</h1><!-- doxytag: class="Dog" --><!-- doxytag: inherits="Mammal" -->another subclassed mammal +<a href="#_details">More...</a> +<p> +<div class="dynheader"> +Inheritance diagram for Dog:</div> +<div class="dynsection"> + +<p><center><img src="classDog.png" usemap="#Dog_map" border="0" alt=""></center> +<map name="Dog_map"> +<area href="classMammal.html" alt="Mammal" shape="rect" coords="0,56,58,80"> +<area href="classAnimal.html" alt="Animal" shape="rect" coords="0,0,58,24"> +</map> +</div> + +<p> +<a href="classDog-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDog.html#ed7e9b0a72e4cd6c6ac3964e16c0baa8">init</a> (this)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#ed7e9b0a72e4cd6c6ac3964e16c0baa8"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +another subclassed mammal +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00111">111</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="ed7e9b0a72e4cd6c6ac3964e16c0baa8"></a><!-- doxytag: member="Dog::init" ref="ed7e9b0a72e4cd6c6ac3964e16c0baa8" args="(this)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Dog::init </td> + <td>(</td> + <td class="paramtype">this </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +constructor +<p> + +<p>Reimplemented from <a class="el" href="classMammal.html#dd9704b77a8575066764961254bc264d">Mammal</a>.</p> + +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00114">114</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="animals_8lua-source.html">animals.lua</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classDog.png b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classDog.png Binary files differnew file mode 100644 index 00000000000..6ba62396a49 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classDog.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classMammal-members.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classMammal-members.html new file mode 100644 index 00000000000..147340920d9 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classMammal-members.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Mammal Member List</h1>This is the complete list of members for <a class="el" href="classMammal.html">Mammal</a>, including all inherited members.<p><table> + <tr class="memlist"><td><a class="el" href="classAnimal.html#4eba095ffc8269b41283d512364ca081">call</a>(this)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classMammal.html#dd9704b77a8575066764961254bc264d">init</a>(this)</td><td><a class="el" href="classMammal.html">Mammal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#3860d62f4fc74989a2292a5c731ed52b">setKind</a>(this, Kind)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> +</table></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classMammal.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classMammal.html new file mode 100644 index 00000000000..cc558db3f2a --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classMammal.html @@ -0,0 +1,87 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Mammal Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Mammal Class Reference</h1><!-- doxytag: class="Mammal" --><!-- doxytag: inherits="Animal" -->a base mammal +<a href="#_details">More...</a> +<p> +<div class="dynheader"> +Inheritance diagram for Mammal:</div> +<div class="dynsection"> + +<p><center><img src="classMammal.png" usemap="#Mammal_map" border="0" alt=""></center> +<map name="Mammal_map"> +<area href="classAnimal.html" alt="Animal" shape="rect" coords="34,0,92,24"> +<area href="classCat.html" alt="Cat" shape="rect" coords="0,112,58,136"> +<area href="classDog.html" alt="Dog" shape="rect" coords="68,112,126,136"> +</map> +</div> + +<p> +<a href="classMammal-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMammal.html#dd9704b77a8575066764961254bc264d">init</a> (this)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#dd9704b77a8575066764961254bc264d"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +a base mammal +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00093">93</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="dd9704b77a8575066764961254bc264d"></a><!-- doxytag: member="Mammal::init" ref="dd9704b77a8575066764961254bc264d" args="(this)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Mammal::init </td> + <td>(</td> + <td class="paramtype">this </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +constructor +<p> + +<p>Reimplemented from <a class="el" href="classAnimal.html#6c19026825a93bffdd37b3296edb7a39">Animal</a>.</p> + +<p>Reimplemented in <a class="el" href="classCat.html#e1007241936e9988d179b7412e16ed81">Cat</a>, and <a class="el" href="classDog.html#ed7e9b0a72e4cd6c6ac3964e16c0baa8">Dog</a>.</p> + +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00096">96</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="animals_8lua-source.html">animals.lua</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classMammal.png b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classMammal.png Binary files differnew file mode 100644 index 00000000000..a736bde5a35 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classMammal.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classPigeon-members.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classPigeon-members.html new file mode 100644 index 00000000000..2588b5bf714 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classPigeon-members.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Pigeon Member List</h1>This is the complete list of members for <a class="el" href="classPigeon.html">Pigeon</a>, including all inherited members.<p><table> + <tr class="memlist"><td><a class="el" href="classAnimal.html#4eba095ffc8269b41283d512364ca081">call</a>(this)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classPigeon.html#b9841e55917b4cb60bacaa394c3ae70e">init</a>(this)</td><td><a class="el" href="classPigeon.html">Pigeon</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#3860d62f4fc74989a2292a5c731ed52b">setKind</a>(this, Kind)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> +</table></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classPigeon.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classPigeon.html new file mode 100644 index 00000000000..9e6802e73a9 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classPigeon.html @@ -0,0 +1,84 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Pigeon Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Pigeon Class Reference</h1><!-- doxytag: class="Pigeon" --><!-- doxytag: inherits="Bird" -->a subclassed bird +<a href="#_details">More...</a> +<p> +<div class="dynheader"> +Inheritance diagram for Pigeon:</div> +<div class="dynsection"> + +<p><center><img src="classPigeon.png" usemap="#Pigeon_map" border="0" alt=""></center> +<map name="Pigeon_map"> +<area href="classBird.html" alt="Bird" shape="rect" coords="0,56,51,80"> +<area href="classAnimal.html" alt="Animal" shape="rect" coords="0,0,51,24"> +</map> +</div> + +<p> +<a href="classPigeon-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPigeon.html#b9841e55917b4cb60bacaa394c3ae70e">init</a> (this)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#b9841e55917b4cb60bacaa394c3ae70e"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +a subclassed bird +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00073">73</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="b9841e55917b4cb60bacaa394c3ae70e"></a><!-- doxytag: member="Pigeon::init" ref="b9841e55917b4cb60bacaa394c3ae70e" args="(this)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Pigeon::init </td> + <td>(</td> + <td class="paramtype">this </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +constructor +<p> + +<p>Reimplemented from <a class="el" href="classBird.html#967ccea204b5b63752a4a2ea184c7efb">Bird</a>.</p> + +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00076">76</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="animals_8lua-source.html">animals.lua</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classPigeon.png b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classPigeon.png Binary files differnew file mode 100644 index 00000000000..dc73930253a --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classPigeon.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classRedKite-members.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classRedKite-members.html new file mode 100644 index 00000000000..67e73159194 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classRedKite-members.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>RedKite Member List</h1>This is the complete list of members for <a class="el" href="classRedKite.html">RedKite</a>, including all inherited members.<p><table> + <tr class="memlist"><td><a class="el" href="classAnimal.html#4eba095ffc8269b41283d512364ca081">call</a>(this)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRedKite.html#c4e5f4b008acabde923bb8f0b3272e96">init</a>(this)</td><td><a class="el" href="classRedKite.html">RedKite</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#3860d62f4fc74989a2292a5c731ed52b">setKind</a>(this, Kind)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> +</table></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classRedKite.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classRedKite.html new file mode 100644 index 00000000000..49157afcdeb --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classRedKite.html @@ -0,0 +1,84 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: RedKite Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>RedKite Class Reference</h1><!-- doxytag: class="RedKite" --><!-- doxytag: inherits="Bird" -->another subclassed bird +<a href="#_details">More...</a> +<p> +<div class="dynheader"> +Inheritance diagram for RedKite:</div> +<div class="dynsection"> + +<p><center><img src="classRedKite.png" usemap="#RedKite_map" border="0" alt=""></center> +<map name="RedKite_map"> +<area href="classBird.html" alt="Bird" shape="rect" coords="0,56,55,80"> +<area href="classAnimal.html" alt="Animal" shape="rect" coords="0,0,55,24"> +</map> +</div> + +<p> +<a href="classRedKite-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedKite.html#c4e5f4b008acabde923bb8f0b3272e96">init</a> (this)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#c4e5f4b008acabde923bb8f0b3272e96"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +another subclassed bird +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00083">83</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="c4e5f4b008acabde923bb8f0b3272e96"></a><!-- doxytag: member="RedKite::init" ref="c4e5f4b008acabde923bb8f0b3272e96" args="(this)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedKite::init </td> + <td>(</td> + <td class="paramtype">this </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +constructor +<p> + +<p>Reimplemented from <a class="el" href="classBird.html#967ccea204b5b63752a4a2ea184c7efb">Bird</a>.</p> + +<p>Definition at line <a class="el" href="animals_8lua-source.html#l00086">86</a> of file <a class="el" href="animals_8lua-source.html">animals.lua</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="animals_8lua-source.html">animals.lua</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classRedKite.png b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classRedKite.png Binary files differnew file mode 100644 index 00000000000..b286f8c415a --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classRedKite.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/class_8lua-source.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/class_8lua-source.html new file mode 100644 index 00000000000..514134fd520 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/class_8lua-source.html @@ -0,0 +1,106 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: class.lua Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +<h1>class.lua</h1><a href="class_8lua.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 ---- Copyright 2011 Simon Dales +<a name="l00002"></a>00002 -- +<a name="l00003"></a>00003 -- This work may be distributed and/or modified under the +<a name="l00004"></a>00004 -- conditions of the LaTeX Project Public License, either version 1.3 +<a name="l00005"></a>00005 -- of <span class="keyword">this</span> license or (at your option) any later version. +<a name="l00006"></a>00006 -- The latest version of <span class="keyword">this</span> license is in +<a name="l00007"></a>00007 -- http:<span class="comment">//www.latex-project.org/lppl.txt</span> +<a name="l00008"></a>00008 -- +<a name="l00009"></a>00009 -- This work has the LPPL maintenance status `maintained<span class="stringliteral">'.</span> +<a name="l00010"></a>00010 <span class="stringliteral">-- </span> +<a name="l00011"></a>00011 <span class="stringliteral">-- The Current Maintainer of this work is Simon Dales.</span> +<a name="l00012"></a>00012 <span class="stringliteral">--</span> +<a name="l00013"></a>00013 <span class="stringliteral"></span> +<a name="l00014"></a>00014 <span class="stringliteral">--[[!</span> +<a name="l00015"></a>00015 <span class="stringliteral"> \file </span> +<a name="l00016"></a>00016 <span class="stringliteral"> \brief enables classes in lua</span> +<a name="l00017"></a>00017 <span class="stringliteral"> ]]</span> +<a name="l00018"></a>00018 <span class="stringliteral"> </span> +<a name="l00019"></a>00019 <span class="stringliteral">--[[ class.lua</span> +<a name="l00020"></a>00020 <span class="stringliteral">-- Compatible with Lua 5.1 (not 5.0).</span> +<a name="l00021"></a>00021 <span class="stringliteral"></span> +<a name="l00022"></a>00022 <span class="stringliteral"> ---------------------</span> +<a name="l00023"></a>00023 <span class="stringliteral"> </span> +<a name="l00024"></a>00024 <span class="stringliteral"> ]]--</span> +<a name="l00025"></a>00025 <span class="stringliteral">--! \brief ``declare'</span><span class="stringliteral">' as class</span> +<a name="l00026"></a>00026 <span class="stringliteral">--! </span> +<a name="l00027"></a>00027 <span class="stringliteral">--! use as:</span> +<a name="l00028"></a>00028 <span class="stringliteral">--! \code{lua}</span> +<a name="l00029"></a>00029 <span class="stringliteral">--! TWibble = class()</span> +<a name="l00030"></a>00030 <span class="stringliteral">--! function TWibble:init(instance)</span> +<a name="l00031"></a>00031 <span class="stringliteral">--! self.instance = instance</span> +<a name="l00032"></a>00032 <span class="stringliteral">--! -- more stuff here</span> +<a name="l00033"></a>00033 <span class="stringliteral">--! end</span> +<a name="l00034"></a>00034 <span class="stringliteral">--! \endcode</span> +<a name="l00035"></a>00035 <span class="stringliteral">--! </span> +<a name="l00036"></a><a class="code" href="class_8lua.html#a054d3d223ac0f3f6f0ec350708f9361">00036</a> <span class="stringliteral">function class(BaseClass, ClassInitialiser)</span> +<a name="l00037"></a>00037 <span class="stringliteral"> local newClass = {} -- a new class newClass</span> +<a name="l00038"></a>00038 <span class="stringliteral"> if not ClassInitialiser and type(BaseClass) == '</span>function<span class="stringliteral">' then</span> +<a name="l00039"></a>00039 <span class="stringliteral"> ClassInitialiser = BaseClass</span> +<a name="l00040"></a>00040 <span class="stringliteral"> BaseClass = nil</span> +<a name="l00041"></a>00041 <span class="stringliteral"> elseif type(BaseClass) == '</span>table<span class="stringliteral">' then</span> +<a name="l00042"></a>00042 <span class="stringliteral"> -- our new class is a shallow copy of the base class!</span> +<a name="l00043"></a>00043 <span class="stringliteral"> for i,v in pairs(BaseClass) do</span> +<a name="l00044"></a>00044 <span class="stringliteral"> newClass[i] = v</span> +<a name="l00045"></a>00045 <span class="stringliteral"> end</span> +<a name="l00046"></a>00046 <span class="stringliteral"> newClass._base = BaseClass</span> +<a name="l00047"></a>00047 <span class="stringliteral"> end</span> +<a name="l00048"></a>00048 <span class="stringliteral"> -- the class will be the metatable for all its newInstanceects,</span> +<a name="l00049"></a>00049 <span class="stringliteral"> -- and they will look up their methods in it.</span> +<a name="l00050"></a>00050 <span class="stringliteral"> newClass.__index = newClass</span> +<a name="l00051"></a>00051 <span class="stringliteral"></span> +<a name="l00052"></a>00052 <span class="stringliteral"> -- expose a constructor which can be called by <classname>(<args>)</span> +<a name="l00053"></a>00053 <span class="stringliteral"> local classMetatable = {}</span> +<a name="l00054"></a>00054 <span class="stringliteral"> classMetatable.__call = </span> +<a name="l00055"></a>00055 <span class="stringliteral"> function(class_tbl, ...)</span> +<a name="l00056"></a>00056 <span class="stringliteral"> local newInstance = {}</span> +<a name="l00057"></a>00057 <span class="stringliteral"> setmetatable(newInstance,newClass)</span> +<a name="l00058"></a>00058 <span class="stringliteral"> --if init then</span> +<a name="l00059"></a>00059 <span class="stringliteral"> -- init(newInstance,...)</span> +<a name="l00060"></a>00060 <span class="stringliteral"> if class_tbl.init then</span> +<a name="l00061"></a>00061 <span class="stringliteral"> class_tbl.init(newInstance,...)</span> +<a name="l00062"></a>00062 <span class="stringliteral"> else </span> +<a name="l00063"></a>00063 <span class="stringliteral"> -- make sure that any stuff from the base class is initialized!</span> +<a name="l00064"></a>00064 <span class="stringliteral"> if BaseClass and BaseClass.init then</span> +<a name="l00065"></a>00065 <span class="stringliteral"> BaseClass.init(newInstance, ...)</span> +<a name="l00066"></a>00066 <span class="stringliteral"> end</span> +<a name="l00067"></a>00067 <span class="stringliteral"> end</span> +<a name="l00068"></a>00068 <span class="stringliteral"> return newInstance</span> +<a name="l00069"></a>00069 <span class="stringliteral"> end</span> +<a name="l00070"></a>00070 <span class="stringliteral"> newClass.init = ClassInitialiser</span> +<a name="l00071"></a>00071 <span class="stringliteral"> newClass.is_a = </span> +<a name="l00072"></a>00072 <span class="stringliteral"> function(this, klass)</span> +<a name="l00073"></a>00073 <span class="stringliteral"> local thisMetabable = getmetatable(this)</span> +<a name="l00074"></a>00074 <span class="stringliteral"> while thisMetabable do </span> +<a name="l00075"></a>00075 <span class="stringliteral"> if thisMetabable == klass then</span> +<a name="l00076"></a>00076 <span class="stringliteral"> return true</span> +<a name="l00077"></a>00077 <span class="stringliteral"> end</span> +<a name="l00078"></a>00078 <span class="stringliteral"> thisMetabable = thisMetabable._base</span> +<a name="l00079"></a>00079 <span class="stringliteral"> end</span> +<a name="l00080"></a>00080 <span class="stringliteral"> return false</span> +<a name="l00081"></a>00081 <span class="stringliteral"> end</span> +<a name="l00082"></a>00082 <span class="stringliteral"> setmetatable(newClass, classMetatable)</span> +<a name="l00083"></a>00083 <span class="stringliteral"> return newClass</span> +<a name="l00084"></a>00084 <span class="stringliteral">end</span> +<a name="l00085"></a>00085 <span class="stringliteral">--eof</span> +</pre></div></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/class_8lua.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/class_8lua.html new file mode 100644 index 00000000000..1920c3e0627 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/class_8lua.html @@ -0,0 +1,79 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: class.lua File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>class.lua File Reference</h1>enables classes in lua <a href="#_details">More...</a> +<p> + +<p> +<a href="class_8lua-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">function </td><td class="memItemRight" valign="bottom"><a class="el" href="class_8lua.html#a054d3d223ac0f3f6f0ec350708f9361">class</a> (BaseClass, ClassInitialiser)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">``declare'' as class <a href="#a054d3d223ac0f3f6f0ec350708f9361"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +enables classes in lua +<p> + +<p>Definition in file <a class="el" href="class_8lua-source.html">class.lua</a>.</p> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="a054d3d223ac0f3f6f0ec350708f9361"></a><!-- doxytag: member="class.lua::class" ref="a054d3d223ac0f3f6f0ec350708f9361" args="(BaseClass, ClassInitialiser)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">function class </td> + <td>(</td> + <td class="paramtype">BaseClass </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">ClassInitialiser </td> + <td class="paramname"></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +``declare'' as class +<p> +use as: <div class="fragment"><pre class="fragment"> {lua} + TWibble = <span class="keyword">class</span>() + function TWibble:init(instance) + <span class="keyword">self</span>.instance = instance + -- more stuff here + end +</pre></div> +<p>Definition at line <a class="el" href="class_8lua-source.html#l00036">36</a> of file <a class="el" href="class_8lua-source.html">class.lua</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/doxygen.css b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/doxygen.css new file mode 100644 index 00000000000..22c484301dd --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/doxygen.css @@ -0,0 +1,473 @@ +BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { + font-family: Geneva, Arial, Helvetica, sans-serif; +} +BODY,TD { + font-size: 90%; +} +H1 { + text-align: center; + font-size: 160%; +} +H2 { + font-size: 120%; +} +H3 { + font-size: 100%; +} +CAPTION { + font-weight: bold +} +DIV.qindex { + width: 100%; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.navpath { + width: 100%; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.navtab { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +TD.navtab { + font-size: 70%; +} +A.qindex { + text-decoration: none; + font-weight: bold; + color: #1A419D; +} +A.qindex:visited { + text-decoration: none; + font-weight: bold; + color: #1A419D +} +A.qindex:hover { + text-decoration: none; + background-color: #ddddff; +} +A.qindexHL { + text-decoration: none; + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} +A.qindexHL:hover { + text-decoration: none; + background-color: #6666cc; + color: #ffffff; +} +A.qindexHL:visited { + text-decoration: none; + background-color: #6666cc; + color: #ffffff +} +A.el { + text-decoration: none; + font-weight: bold +} +A.elRef { + font-weight: bold +} +A.code:link { + text-decoration: none; + font-weight: normal; + color: #0000FF +} +A.code:visited { + text-decoration: none; + font-weight: normal; + color: #0000FF +} +A.codeRef:link { + font-weight: normal; + color: #0000FF +} +A.codeRef:visited { + font-weight: normal; + color: #0000FF +} +A:hover { + text-decoration: none; + background-color: #f2f2ff +} +DL.el { + margin-left: -1cm +} +.fragment { + font-family: monospace, fixed; + font-size: 95%; +} +PRE.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + margin-top: 4px; + margin-bottom: 4px; + margin-left: 2px; + margin-right: 8px; + padding-left: 6px; + padding-right: 6px; + padding-top: 4px; + padding-bottom: 4px; +} +DIV.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px +} + +DIV.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} +DIV.groupText { + margin-left: 16px; + font-style: italic; + font-size: 90% +} +BODY { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} +TD.indexkey { + background-color: #e8eef2; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TD.indexvalue { + background-color: #e8eef2; + font-style: italic; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TR.memlist { + background-color: #f0f0f0; +} +P.formulaDsp { + text-align: center; +} +IMG.formulaDsp { +} +IMG.formulaInl { + vertical-align: middle; +} +SPAN.keyword { color: #008000 } +SPAN.keywordtype { color: #604020 } +SPAN.keywordflow { color: #e08000 } +SPAN.comment { color: #800000 } +SPAN.preprocessor { color: #806020 } +SPAN.stringliteral { color: #002080 } +SPAN.charliteral { color: #008080 } +SPAN.vhdldigit { color: #ff00ff } +SPAN.vhdlchar { color: #000000 } +SPAN.vhdlkeyword { color: #700070 } +SPAN.vhdllogic { color: #ff0000 } + +.mdescLeft { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.mdescRight { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.memItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplParams { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + color: #606060; + background-color: #FAFAFA; + font-size: 80%; +} +.search { + color: #003399; + font-weight: bold; +} +FORM.search { + margin-bottom: 0px; + margin-top: 0px; +} +INPUT.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +TD.tiny { + font-size: 75%; +} +a { + color: #1A41A8; +} +a:visited { + color: #2A3798; +} +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; +} +TH.dirtab { + background: #e8eef2; + font-weight: bold; +} +HR { + height: 1px; + border: none; + border-top: 1px solid black; +} + +/* Style for detailed member documentation */ +.memtemplate { + font-size: 80%; + color: #606060; + font-weight: normal; + margin-left: 3px; +} +.memnav { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +.memitem { + padding: 4px; + background-color: #eef3f5; + border-width: 1px; + border-style: solid; + border-color: #dedeee; + -moz-border-radius: 8px 8px 8px 8px; +} +.memname { + white-space: nowrap; + font-weight: bold; +} +.memdoc{ + padding-left: 10px; +} +.memproto { + background-color: #d5e1e8; + width: 100%; + border-width: 1px; + border-style: solid; + border-color: #84b0c7; + font-weight: bold; + -moz-border-radius: 8px 8px 8px 8px; +} +.paramkey { + text-align: right; +} +.paramtype { + white-space: nowrap; +} +.paramname { + color: #602020; + font-style: italic; + white-space: nowrap; +} +/* End Styling for detailed member documentation */ + +/* for the tree view */ +.ftvtree { + font-family: sans-serif; + margin:0.5em; +} +/* these are for tree view when used as main index */ +.directory { + font-size: 9pt; + font-weight: bold; +} +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* The following two styles can be used to replace the root node title */ +/* with an image of your choice. Simply uncomment the next two styles, */ +/* specify the name of your image and be sure to set 'height' to the */ +/* proper pixel height of your image. */ + +/* .directory h3.swap { */ +/* height: 61px; */ +/* background-repeat: no-repeat; */ +/* background-image: url("yourimage.gif"); */ +/* } */ +/* .directory h3.swap span { */ +/* display: none; */ +/* } */ + +.directory > h3 { + margin-top: 0; +} +.directory p { + margin: 0px; + white-space: nowrap; +} +.directory div { + display: none; + margin: 0px; +} +.directory img { + vertical-align: -30%; +} +/* these are for tree view when not used as main index */ +.directory-alt { + font-size: 100%; + font-weight: bold; +} +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} +.directory-alt > h3 { + margin-top: 0; +} +.directory-alt p { + margin: 0px; + white-space: nowrap; +} +.directory-alt div { + display: none; + margin: 0px; +} +.directory-alt img { + vertical-align: -30%; +} + diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/doxygen.png b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/doxygen.png Binary files differnew file mode 100644 index 00000000000..f0a274bbaff --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/doxygen.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/files.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/files.html new file mode 100644 index 00000000000..3f47f1dcf7b --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/files.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: File Index</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>File List</h1>Here is a list of all files with brief descriptions:<table> + <tr><td class="indexkey"><a class="el" href="animals_8lua.html">animals.lua</a> <a href="animals_8lua-source.html">[code]</a></td><td class="indexvalue">Test some classes </td></tr> + <tr><td class="indexkey"><a class="el" href="class_8lua.html">class.lua</a> <a href="class_8lua-source.html">[code]</a></td><td class="indexvalue">Enables classes in lua </td></tr> + <tr><td class="indexkey"><a class="el" href="main_8lua.html">main.lua</a> <a href="main_8lua-source.html">[code]</a></td><td class="indexvalue">Test code </td></tr> +</table> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/functions.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/functions.html new file mode 100644 index 00000000000..849f965d8e1 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/functions.html @@ -0,0 +1,52 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Class Members</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li class="current"><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="functions.html"><span>All</span></a></li> + <li><a href="functions_func.html"><span>Functions</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +Here is a list of all class members with links to the classes they belong to: +<p> +<ul> +<li>call() +: <a class="el" href="classAnimal.html#4eba095ffc8269b41283d512364ca081">Animal</a> +<li>init() +: <a class="el" href="classAnimal.html#6c19026825a93bffdd37b3296edb7a39">Animal</a> +, <a class="el" href="classDog.html#ed7e9b0a72e4cd6c6ac3964e16c0baa8">Dog</a> +, <a class="el" href="classCat.html#e1007241936e9988d179b7412e16ed81">Cat</a> +, <a class="el" href="classMammal.html#dd9704b77a8575066764961254bc264d">Mammal</a> +, <a class="el" href="classRedKite.html#c4e5f4b008acabde923bb8f0b3272e96">RedKite</a> +, <a class="el" href="classPigeon.html#b9841e55917b4cb60bacaa394c3ae70e">Pigeon</a> +, <a class="el" href="classBird.html#967ccea204b5b63752a4a2ea184c7efb">Bird</a> +<li>setKind() +: <a class="el" href="classAnimal.html#3860d62f4fc74989a2292a5c731ed52b">Animal</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/functions_func.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/functions_func.html new file mode 100644 index 00000000000..9e6da114996 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/functions_func.html @@ -0,0 +1,52 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Class Members - Functions</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li class="current"><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="functions.html"><span>All</span></a></li> + <li class="current"><a href="functions_func.html"><span>Functions</span></a></li> + </ul> + </div> +</div> +<div class="contents"> + +<p> +<ul> +<li>call() +: <a class="el" href="classAnimal.html#4eba095ffc8269b41283d512364ca081">Animal</a> +<li>init() +: <a class="el" href="classAnimal.html#6c19026825a93bffdd37b3296edb7a39">Animal</a> +, <a class="el" href="classDog.html#ed7e9b0a72e4cd6c6ac3964e16c0baa8">Dog</a> +, <a class="el" href="classCat.html#e1007241936e9988d179b7412e16ed81">Cat</a> +, <a class="el" href="classMammal.html#dd9704b77a8575066764961254bc264d">Mammal</a> +, <a class="el" href="classRedKite.html#c4e5f4b008acabde923bb8f0b3272e96">RedKite</a> +, <a class="el" href="classPigeon.html#b9841e55917b4cb60bacaa394c3ae70e">Pigeon</a> +, <a class="el" href="classBird.html#967ccea204b5b63752a4a2ea184c7efb">Bird</a> +<li>setKind() +: <a class="el" href="classAnimal.html#3860d62f4fc74989a2292a5c731ed52b">Animal</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/globals.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/globals.html new file mode 100644 index 00000000000..05674dcebc6 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/globals.html @@ -0,0 +1,45 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Class Members</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="globals.html"><span>All</span></a></li> + <li><a href="globals_func.html"><span>Functions</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +Here is a list of all file members with links to the files they belong to: +<p> +<ul> +<li>class() +: <a class="el" href="class_8lua.html#a054d3d223ac0f3f6f0ec350708f9361">class.lua</a> +<li>TIO_write() +: <a class="el" href="animals_8lua.html#a5e8a20129b8aedaf1d33da6e81bddaa">animals.lua</a> +<li>TIO_writeln() +: <a class="el" href="animals_8lua.html#b1f4ebf1dfca0be8b647148e8c742f05">animals.lua</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/globals_func.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/globals_func.html new file mode 100644 index 00000000000..56b7a593ebc --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/globals_func.html @@ -0,0 +1,45 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Class Members</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="globals.html"><span>All</span></a></li> + <li class="current"><a href="globals_func.html"><span>Functions</span></a></li> + </ul> + </div> +</div> +<div class="contents"> + +<p> +<ul> +<li>class() +: <a class="el" href="class_8lua.html#a054d3d223ac0f3f6f0ec350708f9361">class.lua</a> +<li>TIO_write() +: <a class="el" href="animals_8lua.html#a5e8a20129b8aedaf1d33da6e81bddaa">animals.lua</a> +<li>TIO_writeln() +: <a class="el" href="animals_8lua.html#b1f4ebf1dfca0be8b647148e8c742f05">animals.lua</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/hierarchy.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/hierarchy.html new file mode 100644 index 00000000000..9ad191402ab --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/hierarchy.html @@ -0,0 +1,45 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Hierarchical Index</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li class="current"><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Class Hierarchy</h1>This inheritance list is sorted roughly, but not completely, alphabetically:<ul> +<li><a class="el" href="classAnimal.html">Animal</a> +<ul> +<li><a class="el" href="classBird.html">Bird</a> +<ul> +<li><a class="el" href="classPigeon.html">Pigeon</a> +<li><a class="el" href="classRedKite.html">RedKite</a> +</ul> +<li><a class="el" href="classMammal.html">Mammal</a> +<ul> +<li><a class="el" href="classCat.html">Cat</a> +<li><a class="el" href="classDog.html">Dog</a> +</ul> +</ul> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/index.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/index.html new file mode 100644 index 00000000000..b309f15c5e9 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/index.html @@ -0,0 +1,25 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: Main Page</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li class="current"><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Sample Code Documentation</h1> +<p> +<h3 align="center">0.1 20120518 </h3>Some test code. This shows a hierachy of classes. For this example we do animals. </div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/main_8lua-source.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/main_8lua-source.html new file mode 100644 index 00000000000..a13a1dcc537 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/main_8lua-source.html @@ -0,0 +1,63 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: main.lua Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +<h1>main.lua</h1><a href="main_8lua.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 ---- Copyright 2012 Simon Dales +<a name="l00002"></a>00002 -- +<a name="l00003"></a>00003 -- This work may be distributed and/or modified under the +<a name="l00004"></a>00004 -- conditions of the LaTeX Project Public License, either version 1.3 +<a name="l00005"></a>00005 -- of <span class="keyword">this</span> license or (at your option) any later version. +<a name="l00006"></a>00006 -- The latest version of <span class="keyword">this</span> license is in +<a name="l00007"></a>00007 -- http:<span class="comment">//www.latex-project.org/lppl.txt</span> +<a name="l00008"></a>00008 -- +<a name="l00009"></a>00009 -- This work has the LPPL maintenance status `maintained<span class="stringliteral">'.</span> +<a name="l00010"></a>00010 <span class="stringliteral">-- </span> +<a name="l00011"></a>00011 <span class="stringliteral">-- The Current Maintainer of this work is Simon Dales.</span> +<a name="l00012"></a>00012 <span class="stringliteral">--</span> +<a name="l00013"></a>00013 <span class="stringliteral"></span> +<a name="l00014"></a>00014 <span class="stringliteral">--[[!</span> +<a name="l00015"></a>00015 <span class="stringliteral"> \file</span> +<a name="l00016"></a>00016 <span class="stringliteral"> \brief test code</span> +<a name="l00017"></a>00017 <span class="stringliteral"> </span> +<a name="l00018"></a>00018 <span class="stringliteral"> ]]</span> +<a name="l00019"></a>00019 <span class="stringliteral"> </span> +<a name="l00020"></a>00020 <span class="stringliteral">--[[!</span> +<a name="l00021"></a>00021 <span class="stringliteral"> \mainpage</span> +<a name="l00022"></a>00022 <span class="stringliteral"> </span> +<a name="l00023"></a>00023 <span class="stringliteral"> Some test code.</span> +<a name="l00024"></a>00024 <span class="stringliteral"> This shows a hierachy of classes.</span> +<a name="l00025"></a>00025 <span class="stringliteral"> For this example we do animals.</span> +<a name="l00026"></a>00026 <span class="stringliteral"> </span> +<a name="l00027"></a>00027 <span class="stringliteral"> ]]</span> +<a name="l00028"></a>00028 <span class="stringliteral"> </span> +<a name="l00029"></a>00029 <span class="stringliteral">require '</span>animals<span class="stringliteral">'</span> +<a name="l00030"></a>00030 <span class="stringliteral"></span> +<a name="l00031"></a>00031 <span class="stringliteral">-- main</span> +<a name="l00032"></a>00032 <span class="stringliteral">local animals = {</span> +<a name="l00033"></a>00033 <span class="stringliteral"> Cat()</span> +<a name="l00034"></a>00034 <span class="stringliteral"> ,Dog()</span> +<a name="l00035"></a>00035 <span class="stringliteral"> ,Bird()</span> +<a name="l00036"></a>00036 <span class="stringliteral"> ,RedKite()</span> +<a name="l00037"></a>00037 <span class="stringliteral"> ,Pigeon()</span> +<a name="l00038"></a>00038 <span class="stringliteral"> }</span> +<a name="l00039"></a>00039 <span class="stringliteral"> </span> +<a name="l00040"></a>00040 <span class="stringliteral">for k,v in pairs(animals) do</span> +<a name="l00041"></a>00041 <span class="stringliteral"> v:call()</span> +<a name="l00042"></a>00042 <span class="stringliteral">end</span> +</pre></div></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/main_8lua.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/main_8lua.html new file mode 100644 index 00000000000..ae6b738aa25 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/main_8lua.html @@ -0,0 +1,35 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code: main.lua File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>main.lua File Reference</h1>test code <a href="#_details">More...</a> +<p> + +<p> +<a href="main_8lua-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +test code +<p> + +<p>Definition in file <a class="el" href="main_8lua-source.html">main.lua</a>.</p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_b.gif b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_b.gif Binary files differnew file mode 100644 index 00000000000..0d623483ffd --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_b.gif diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_l.gif b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_l.gif Binary files differnew file mode 100644 index 00000000000..9b1e6337c92 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_l.gif diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_r.gif b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_r.gif Binary files differnew file mode 100644 index 00000000000..ce9dd9f533c --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_r.gif diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tabs.css b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tabs.css new file mode 100644 index 00000000000..95f00a91da3 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tabs.css @@ -0,0 +1,102 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +DIV.tabs +{ + float : left; + width : 100%; + background : url("tab_b.gif") repeat-x bottom; + margin-bottom : 4px; +} + +DIV.tabs UL +{ + margin : 0px; + padding-left : 10px; + list-style : none; +} + +DIV.tabs LI, DIV.tabs FORM +{ + display : inline; + margin : 0px; + padding : 0px; +} + +DIV.tabs FORM +{ + float : right; +} + +DIV.tabs A +{ + float : left; + background : url("tab_r.gif") no-repeat right top; + border-bottom : 1px solid #84B0C7; + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + +DIV.tabs A:hover +{ + background-position: 100% -150px; +} + +DIV.tabs A:link, DIV.tabs A:visited, +DIV.tabs A:active, DIV.tabs A:hover +{ + color: #1A419D; +} + +DIV.tabs SPAN +{ + float : left; + display : block; + background : url("tab_l.gif") no-repeat left top; + padding : 5px 9px; + white-space : nowrap; +} + +DIV.tabs INPUT +{ + float : right; + display : inline; + font-size : 1em; +} + +DIV.tabs TD +{ + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + + + +/* Commented Backslash Hack hides rule from IE5-Mac \*/ +DIV.tabs SPAN {float : none;} +/* End IE5-Mac hack */ + +DIV.tabs A:hover SPAN +{ + background-position: 0% -150px; +} + +DIV.tabs LI.current A +{ + background-position: 100% -150px; + border-width : 0px; +} + +DIV.tabs LI.current SPAN +{ + background-position: 0% -150px; + padding-bottom : 6px; +} + +DIV.navpath +{ + background : none; + border : none; + border-bottom : 1px solid #84B0C7; +} diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/main.lua b/Master/texmf-dist/doc/support/lua2dox/examples/lua/main.lua new file mode 100644 index 00000000000..6f5245e98bd --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/main.lua @@ -0,0 +1,42 @@ +---- Copyright 2012 Simon Dales +-- +-- This work may be distributed and/or modified under the +-- conditions of the LaTeX Project Public License, either version 1.3 +-- of this license or (at your option) any later version. +-- The latest version of this license is in +-- http://www.latex-project.org/lppl.txt +-- +-- This work has the LPPL maintenance status `maintained'. +-- +-- The Current Maintainer of this work is Simon Dales. +-- + +--[[! + \file + \brief test code + + ]] + +--[[! + \mainpage + + Some test code. + This shows a hierachy of classes. + For this example we do animals. + + ]] + +require 'animals' + +-- main +local animals = { + Cat() + ,Dog() + ,Bird() + ,RedKite() + ,Pigeon() + } + +for k,v in pairs(animals) do + v:call() +end diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/Doxyfile b/Master/texmf-dist/doc/support/lua2dox/examples/php/Doxyfile new file mode 100644 index 00000000000..54b39f7bcc5 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/Doxyfile @@ -0,0 +1,1421 @@ +# Doxyfile 1.5.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = "Sample Code (PHP)" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = "0.1 20120518" + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = docs + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# and Ukrainian. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 2 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +#EXTRACT_ALL = NO +EXTRACT_ALL = yes + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +#SORT_BRIEF_DOCS = NO +SORT_BRIEF_DOCS = yes + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command <command> <input-file>, where <command> is the value of +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command <filter> <input-file>, where <filter> +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +#SOURCE_BROWSER = NO +SOURCE_BROWSER = yes + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentstion. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to FRAME, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. Other possible values +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hiererachy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# respectively. + +GENERATE_TREEVIEW = NONE + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +#GENERATE_LATEX = YES +GENERATE_LATEX = no + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is enabled by default, which results in a transparent +# background. Warning: Depending on the platform used, enabling this option +# may lead to badly anti-aliased labels on the edges of a graph (i.e. they +# become hard to read). + +DOT_TRANSPARENT = YES + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/animals.php b/Master/texmf-dist/doc/support/lua2dox/examples/php/animals.php new file mode 100644 index 00000000000..d7e092e68e4 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/animals.php @@ -0,0 +1,100 @@ +<?php +/***** Copyright 2012 Simon Dales +** +** This work may be distributed and/or modified under the +** conditions of the LaTeX Project Public License, either version 1.3 +** of this license or (at your option) any later version. +** The latest version of this license is in +** http://www.latex-project.org/lppl.txt +** +** This work has the LPPL maintenance status `maintained'. +** +** The Current Maintainer of this work is Simon Dales. +*/ + +/*! + \file + \brief test some classes + + Here we make some animals + + */ + + +//! \brief write to stdout +function TIO_write($Str) +{ + printf('%s',$Str); +} + +//! \brief writeln to stdout +function TIO_writeln($Str) +{ + printf("%s\n",$Str); +} + +//! \brief a base class +class Animal{ + function Animal(){ //! \brief constructor + $this->setKind('animal'); + } + function setKind($Kind){ //! \brief set kind of object + $this->kind = $Kind; + } + function call(){ //! \brief say the call of this animal + $speigel = $this->speigel; + if (isset($speigel)) + $speigel = ' says "' . $speigel . '"'; + else + $speigel = ' <undefined call>'; + + TIO_writeln($this->kind . $speigel); + } + +}; + +//! \brief an abstract bird +class Bird extends Animal{ + function Bird(){ //! \brief constructor + $this->setKind('bird'); + } +}; + +//! \brief a subclassed bird +class Pigeon extends Bird{ + function Pigeon(){ //! \brief constructor + $this->setKind('pigeon'); + $this->speigel = 'oh my poor toe Betty'; + } +}; + +//! \brief another subclassed bird +class RedKite extends Bird{ + function RedKite(){ //! \brief constructor + $this->setKind('red kite'); + $this->speigel = 'weee-ooo ee oo ee oo ee oo'; + } +}; + +//! \brief a base mammal +class Mammal extends Animal{ +}; + +//! \brief a subclassed mammal +class Cat extends Mammal{ + function Cat(){ //! \brief constructor + $this->setKind('cat'); + $this->speigel = 'meow'; + } +}; + +//! \brief another subclassed mammal +class Dog extends Mammal{ + function Dog(){ //! \brief constructor + $this->setKind('dog'); + $this->speigel = 'woof'; + } +}; + +//eof +?>
\ No newline at end of file diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/animals_8php-source.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/animals_8php-source.html new file mode 100644 index 00000000000..0b09c6c0f9b --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/animals_8php-source.html @@ -0,0 +1,104 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): animals.php Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +<h1>animals.php</h1><a href="animals_8php.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <?php +<a name="l00002"></a>00002 <span class="comment">/***** Copyright 2012 Simon Dales</span> +<a name="l00003"></a>00003 <span class="comment">**</span> +<a name="l00004"></a>00004 <span class="comment">** This work may be distributed and/or modified under the</span> +<a name="l00005"></a>00005 <span class="comment">** conditions of the LaTeX Project Public License, either version 1.3</span> +<a name="l00006"></a>00006 <span class="comment">** of this license or (at your option) any later version.</span> +<a name="l00007"></a>00007 <span class="comment">** The latest version of this license is in</span> +<a name="l00008"></a>00008 <span class="comment">** http://www.latex-project.org/lppl.txt</span> +<a name="l00009"></a>00009 <span class="comment">**</span> +<a name="l00010"></a>00010 <span class="comment">** This work has the LPPL maintenance status `maintained'.</span> +<a name="l00011"></a>00011 <span class="comment">** </span> +<a name="l00012"></a>00012 <span class="comment">** The Current Maintainer of this work is Simon Dales.</span> +<a name="l00013"></a>00013 <span class="comment">*/</span> +<a name="l00014"></a>00014 +<a name="l00024"></a>00024 +<a name="l00025"></a><a class="code" href="animals_8php.html#8aed71372222cae35da78ac0f6c34c32">00025</a> function <a class="code" href="animals_8php.html#8aed71372222cae35da78ac0f6c34c32" title="write to stdout">TIO_write</a>($Str) +<a name="l00026"></a>00026 { +<a name="l00027"></a>00027 printf(<span class="stringliteral">'%s'</span>,$Str); +<a name="l00028"></a>00028 } +<a name="l00029"></a>00029 +<a name="l00031"></a><a class="code" href="animals_8php.html#1b5f1c2eef1479c9e7f6c1605c694bf9">00031</a> function <a class="code" href="animals_8php.html#1b5f1c2eef1479c9e7f6c1605c694bf9" title="writeln to stdout">TIO_writeln</a>($Str) +<a name="l00032"></a>00032 { +<a name="l00033"></a>00033 printf(<span class="stringliteral">"%s\n"</span>,$Str); +<a name="l00034"></a>00034 } +<a name="l00035"></a>00035 +<a name="l00037"></a><a class="code" href="classAnimal.html">00037</a> <span class="keyword">class </span><a class="code" href="classAnimal.html" title="a base class">Animal</a>{ +<a name="l00038"></a><a class="code" href="classAnimal.html#1e726a49ec952443190ac62dad22353c">00038</a> function <a class="code" href="classAnimal.html#1e726a49ec952443190ac62dad22353c">Animal</a>(){ +<a name="l00039"></a>00039 $this-><a class="code" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a>(<span class="stringliteral">'animal'</span>); +<a name="l00040"></a>00040 } +<a name="l00041"></a><a class="code" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">00041</a> function <a class="code" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a>($Kind){ +<a name="l00042"></a>00042 $this->kind = $Kind; +<a name="l00043"></a>00043 } +<a name="l00044"></a><a class="code" href="classAnimal.html#4ec6768ff56f527202ab9c143a5ad4be">00044</a> function <a class="code" href="classAnimal.html#4ec6768ff56f527202ab9c143a5ad4be">call</a>(){ +<a name="l00045"></a>00045 $speigel = $this->speigel; +<a name="l00046"></a>00046 <span class="keywordflow">if</span> (isset($speigel)) +<a name="l00047"></a>00047 $speigel = <span class="stringliteral">' says "'</span> . $speigel . <span class="charliteral">'"'</span>; +<a name="l00048"></a>00048 <span class="keywordflow">else</span> +<a name="l00049"></a>00049 $speigel = <span class="stringliteral">' <undefined call>'</span>; +<a name="l00050"></a>00050 +<a name="l00051"></a>00051 <a class="code" href="animals_8php.html#1b5f1c2eef1479c9e7f6c1605c694bf9" title="writeln to stdout">TIO_writeln</a>($this->kind . $speigel); +<a name="l00052"></a>00052 } +<a name="l00053"></a>00053 +<a name="l00054"></a>00054 }; +<a name="l00055"></a>00055 +<a name="l00057"></a><a class="code" href="classBird.html">00057</a> <span class="keyword">class </span><a class="code" href="classBird.html" title="an abstract bird">Bird</a> <span class="keyword">extends</span> <a class="code" href="classAnimal.html" title="a base class">Animal</a>{ +<a name="l00058"></a><a class="code" href="classBird.html#7c1b36856fe3a89d6098ec2b8a10ae8d">00058</a> function <a class="code" href="classBird.html#7c1b36856fe3a89d6098ec2b8a10ae8d">Bird</a>(){ +<a name="l00059"></a>00059 $this-><a class="code" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a>(<span class="stringliteral">'bird'</span>); +<a name="l00060"></a>00060 } +<a name="l00061"></a>00061 }; +<a name="l00062"></a>00062 +<a name="l00064"></a><a class="code" href="classPigeon.html">00064</a> <span class="keyword">class </span><a class="code" href="classPigeon.html" title="a subclassed bird">Pigeon</a> <span class="keyword">extends</span> <a class="code" href="classBird.html" title="an abstract bird">Bird</a>{ +<a name="l00065"></a><a class="code" href="classPigeon.html#cccbf4642d6d786d5edd21adb73dec36">00065</a> function <a class="code" href="classPigeon.html#cccbf4642d6d786d5edd21adb73dec36">Pigeon</a>(){ +<a name="l00066"></a>00066 $this-><a class="code" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a>(<span class="stringliteral">'pigeon'</span>); +<a name="l00067"></a>00067 $this->speigel = <span class="stringliteral">'oh my poor toe Betty'</span>; +<a name="l00068"></a>00068 } +<a name="l00069"></a>00069 }; +<a name="l00070"></a>00070 +<a name="l00072"></a><a class="code" href="classRedKite.html">00072</a> <span class="keyword">class </span><a class="code" href="classRedKite.html" title="another subclassed bird">RedKite</a> <span class="keyword">extends</span> <a class="code" href="classBird.html" title="an abstract bird">Bird</a>{ +<a name="l00073"></a><a class="code" href="classRedKite.html#acb11b00f12795cf8b2c21af75c1d0c1">00073</a> function <a class="code" href="classRedKite.html#acb11b00f12795cf8b2c21af75c1d0c1">RedKite</a>(){ +<a name="l00074"></a>00074 $this-><a class="code" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a>(<span class="stringliteral">'red kite'</span>); +<a name="l00075"></a>00075 $this->speigel = <span class="stringliteral">'weee-ooo ee oo ee oo ee oo'</span>; +<a name="l00076"></a>00076 } +<a name="l00077"></a>00077 }; +<a name="l00078"></a>00078 +<a name="l00080"></a><a class="code" href="classMammal.html">00080</a> <span class="keyword">class </span><a class="code" href="classMammal.html" title="a base mammal">Mammal</a> <span class="keyword">extends</span> <a class="code" href="classAnimal.html" title="a base class">Animal</a>{ +<a name="l00081"></a>00081 }; +<a name="l00082"></a>00082 +<a name="l00084"></a><a class="code" href="classCat.html">00084</a> <span class="keyword">class </span><a class="code" href="classCat.html" title="a subclassed mammal">Cat</a> <span class="keyword">extends</span> <a class="code" href="classMammal.html" title="a base mammal">Mammal</a>{ +<a name="l00085"></a><a class="code" href="classCat.html#dff0d67c4d14c4eeeb35b8daa33ee442">00085</a> function <a class="code" href="classCat.html#dff0d67c4d14c4eeeb35b8daa33ee442">Cat</a>(){ +<a name="l00086"></a>00086 $this-><a class="code" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a>(<span class="stringliteral">'cat'</span>); +<a name="l00087"></a>00087 $this->speigel = <span class="stringliteral">'meow'</span>; +<a name="l00088"></a>00088 } +<a name="l00089"></a>00089 }; +<a name="l00090"></a>00090 +<a name="l00092"></a><a class="code" href="classDog.html">00092</a> <span class="keyword">class </span><a class="code" href="classDog.html" title="another subclassed mammal">Dog</a> <span class="keyword">extends</span> <a class="code" href="classMammal.html" title="a base mammal">Mammal</a>{ +<a name="l00093"></a><a class="code" href="classDog.html#16e01978bb90b2989ee3da3e87071b1b">00093</a> function <a class="code" href="classDog.html#16e01978bb90b2989ee3da3e87071b1b">Dog</a>(){ +<a name="l00094"></a>00094 $this-><a class="code" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a>(<span class="stringliteral">'dog'</span>); +<a name="l00095"></a>00095 $this->speigel = <span class="stringliteral">'woof'</span>; +<a name="l00096"></a>00096 } +<a name="l00097"></a>00097 }; +<a name="l00098"></a>00098 +<a name="l00099"></a>00099 <span class="comment">//eof</span> +<a name="l00100"></a>00100 ?> +</pre></div></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/animals_8php.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/animals_8php.html new file mode 100644 index 00000000000..e67ed03f772 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/animals_8php.html @@ -0,0 +1,113 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): animals.php File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>animals.php File Reference</h1>test some classes <a href="#_details">More...</a> +<p> + +<p> +<a href="animals_8php-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Classes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimal.html">Animal</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">a base class <a href="classAnimal.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classBird.html">Bird</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">an abstract bird <a href="classBird.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classCat.html">Cat</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">a subclassed mammal <a href="classCat.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classDog.html">Dog</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">another subclassed mammal <a href="classDog.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classMammal.html">Mammal</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">a base mammal <a href="classMammal.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPigeon.html">Pigeon</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">a subclassed bird <a href="classPigeon.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedKite.html">RedKite</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">another subclassed bird <a href="classRedKite.html#_details">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="animals_8php.html#8aed71372222cae35da78ac0f6c34c32">TIO_write</a> ($Str)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">write to stdout <a href="#8aed71372222cae35da78ac0f6c34c32"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="animals_8php.html#1b5f1c2eef1479c9e7f6c1605c694bf9">TIO_writeln</a> ($Str)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">writeln to stdout <a href="#1b5f1c2eef1479c9e7f6c1605c694bf9"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +test some classes +<p> +Here we make some animals +<p>Definition in file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="8aed71372222cae35da78ac0f6c34c32"></a><!-- doxytag: member="animals.php::TIO_write" ref="8aed71372222cae35da78ac0f6c34c32" args="($Str)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">TIO_write </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>Str</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +write to stdout +<p> + +<p>Definition at line <a class="el" href="animals_8php-source.html#l00025">25</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> + +</div> +</div><p> +<a class="anchor" name="1b5f1c2eef1479c9e7f6c1605c694bf9"></a><!-- doxytag: member="animals.php::TIO_writeln" ref="1b5f1c2eef1479c9e7f6c1605c694bf9" args="($Str)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">TIO_writeln </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>Str</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +writeln to stdout +<p> + +<p>Definition at line <a class="el" href="animals_8php-source.html#l00031">31</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/annotated.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/annotated.html new file mode 100644 index 00000000000..d4d8e985916 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/annotated.html @@ -0,0 +1,39 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Class List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table> + <tr><td class="indexkey"><a class="el" href="classAnimal.html">Animal</a></td><td class="indexvalue">Base class </td></tr> + <tr><td class="indexkey"><a class="el" href="classBird.html">Bird</a></td><td class="indexvalue">Abstract bird </td></tr> + <tr><td class="indexkey"><a class="el" href="classCat.html">Cat</a></td><td class="indexvalue">Subclassed mammal </td></tr> + <tr><td class="indexkey"><a class="el" href="classDog.html">Dog</a></td><td class="indexvalue">Another subclassed mammal </td></tr> + <tr><td class="indexkey"><a class="el" href="classMammal.html">Mammal</a></td><td class="indexvalue">Base mammal </td></tr> + <tr><td class="indexkey"><a class="el" href="classPigeon.html">Pigeon</a></td><td class="indexvalue">Subclassed bird </td></tr> + <tr><td class="indexkey"><a class="el" href="classRedKite.html">RedKite</a></td><td class="indexvalue">Another subclassed bird </td></tr> +</table> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classAnimal-members.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classAnimal-members.html new file mode 100644 index 00000000000..f18c16bfd9a --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classAnimal-members.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Animal Member List</h1>This is the complete list of members for <a class="el" href="classAnimal.html">Animal</a>, including all inherited members.<p><table> + <tr class="memlist"><td><a class="el" href="classAnimal.html#1e726a49ec952443190ac62dad22353c">Animal</a>()</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#4ec6768ff56f527202ab9c143a5ad4be">call</a>()</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a>($Kind)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> +</table></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classAnimal.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classAnimal.html new file mode 100644 index 00000000000..8240b7617d8 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classAnimal.html @@ -0,0 +1,135 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Animal Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Animal Class Reference</h1><!-- doxytag: class="Animal" -->a base class +<a href="#_details">More...</a> +<p> +<div class="dynheader"> +Inheritance diagram for Animal:</div> +<div class="dynsection"> + +<p><center><img src="classAnimal.png" usemap="#Animal_map" border="0" alt=""></center> +<map name="Animal_map"> +<area href="classBird.html" alt="Bird" shape="rect" coords="34,56,92,80"> +<area href="classMammal.html" alt="Mammal" shape="rect" coords="170,56,228,80"> +<area href="classPigeon.html" alt="Pigeon" shape="rect" coords="0,112,58,136"> +<area href="classRedKite.html" alt="RedKite" shape="rect" coords="68,112,126,136"> +<area href="classCat.html" alt="Cat" shape="rect" coords="136,112,194,136"> +<area href="classDog.html" alt="Dog" shape="rect" coords="204,112,262,136"> +</map> +</div> + +<p> +<a href="classAnimal-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimal.html#1e726a49ec952443190ac62dad22353c">Animal</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimal.html#4ec6768ff56f527202ab9c143a5ad4be">call</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a> ($Kind)</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +a base class +<p>Definition at line <a class="el" href="animals_8php-source.html#l00037">37</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="1e726a49ec952443190ac62dad22353c"></a><!-- doxytag: member="Animal::Animal" ref="1e726a49ec952443190ac62dad22353c" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Animal::Animal </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p> +constructor +<p>Definition at line <a class="el" href="animals_8php-source.html#l00038">38</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> + +</div> +</div><p> +<a class="anchor" name="4ec6768ff56f527202ab9c143a5ad4be"></a><!-- doxytag: member="Animal::call" ref="4ec6768ff56f527202ab9c143a5ad4be" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Animal::call </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p> +say the call of this animal +<p>Definition at line <a class="el" href="animals_8php-source.html#l00044">44</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8e9da8131c7a28ddd3d2b3d59ba3275e"></a><!-- doxytag: member="Animal::setKind" ref="8e9da8131c7a28ddd3d2b3d59ba3275e" args="($Kind)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Animal::setKind </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>Kind</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p> +set kind of object +<p>Definition at line <a class="el" href="animals_8php-source.html#l00041">41</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="animals_8php-source.html">animals.php</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classAnimal.png b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classAnimal.png Binary files differnew file mode 100644 index 00000000000..796bc999ca1 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classAnimal.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classBird-members.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classBird-members.html new file mode 100644 index 00000000000..494846b0c14 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classBird-members.html @@ -0,0 +1,35 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Bird Member List</h1>This is the complete list of members for <a class="el" href="classBird.html">Bird</a>, including all inherited members.<p><table> + <tr class="memlist"><td><a class="el" href="classAnimal.html#1e726a49ec952443190ac62dad22353c">Animal</a>()</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classBird.html#7c1b36856fe3a89d6098ec2b8a10ae8d">Bird</a>()</td><td><a class="el" href="classBird.html">Bird</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#4ec6768ff56f527202ab9c143a5ad4be">call</a>()</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a>($Kind)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> +</table></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classBird.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classBird.html new file mode 100644 index 00000000000..d07da26aad3 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classBird.html @@ -0,0 +1,81 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Bird Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Bird Class Reference</h1><!-- doxytag: class="Bird" --><!-- doxytag: inherits="Animal" -->an abstract bird +<a href="#_details">More...</a> +<p> +<div class="dynheader"> +Inheritance diagram for Bird:</div> +<div class="dynsection"> + +<p><center><img src="classBird.png" usemap="#Bird_map" border="0" alt=""></center> +<map name="Bird_map"> +<area href="classAnimal.html" alt="Animal" shape="rect" coords="32,0,87,24"> +<area href="classPigeon.html" alt="Pigeon" shape="rect" coords="0,112,55,136"> +<area href="classRedKite.html" alt="RedKite" shape="rect" coords="65,112,120,136"> +</map> +</div> + +<p> +<a href="classBird-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBird.html#7c1b36856fe3a89d6098ec2b8a10ae8d">Bird</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +an abstract bird +<p>Definition at line <a class="el" href="animals_8php-source.html#l00057">57</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="7c1b36856fe3a89d6098ec2b8a10ae8d"></a><!-- doxytag: member="Bird::Bird" ref="7c1b36856fe3a89d6098ec2b8a10ae8d" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Bird::Bird </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p> +constructor +<p>Definition at line <a class="el" href="animals_8php-source.html#l00058">58</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="animals_8php-source.html">animals.php</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classBird.png b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classBird.png Binary files differnew file mode 100644 index 00000000000..d63f59dba48 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classBird.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classCat-members.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classCat-members.html new file mode 100644 index 00000000000..d1db7e4ae8b --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classCat-members.html @@ -0,0 +1,35 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Cat Member List</h1>This is the complete list of members for <a class="el" href="classCat.html">Cat</a>, including all inherited members.<p><table> + <tr class="memlist"><td><a class="el" href="classAnimal.html#1e726a49ec952443190ac62dad22353c">Animal</a>()</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#4ec6768ff56f527202ab9c143a5ad4be">call</a>()</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classCat.html#dff0d67c4d14c4eeeb35b8daa33ee442">Cat</a>()</td><td><a class="el" href="classCat.html">Cat</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a>($Kind)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> +</table></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classCat.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classCat.html new file mode 100644 index 00000000000..b5be89fa275 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classCat.html @@ -0,0 +1,80 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Cat Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Cat Class Reference</h1><!-- doxytag: class="Cat" --><!-- doxytag: inherits="Mammal" -->a subclassed mammal +<a href="#_details">More...</a> +<p> +<div class="dynheader"> +Inheritance diagram for Cat:</div> +<div class="dynsection"> + +<p><center><img src="classCat.png" usemap="#Cat_map" border="0" alt=""></center> +<map name="Cat_map"> +<area href="classMammal.html" alt="Mammal" shape="rect" coords="0,56,58,80"> +<area href="classAnimal.html" alt="Animal" shape="rect" coords="0,0,58,24"> +</map> +</div> + +<p> +<a href="classCat-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCat.html#dff0d67c4d14c4eeeb35b8daa33ee442">Cat</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +a subclassed mammal +<p>Definition at line <a class="el" href="animals_8php-source.html#l00084">84</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="dff0d67c4d14c4eeeb35b8daa33ee442"></a><!-- doxytag: member="Cat::Cat" ref="dff0d67c4d14c4eeeb35b8daa33ee442" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Cat::Cat </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p> +constructor +<p>Definition at line <a class="el" href="animals_8php-source.html#l00085">85</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="animals_8php-source.html">animals.php</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classCat.png b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classCat.png Binary files differnew file mode 100644 index 00000000000..8500fb0b00a --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classCat.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classDog-members.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classDog-members.html new file mode 100644 index 00000000000..19c1dd7aa51 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classDog-members.html @@ -0,0 +1,35 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Dog Member List</h1>This is the complete list of members for <a class="el" href="classDog.html">Dog</a>, including all inherited members.<p><table> + <tr class="memlist"><td><a class="el" href="classAnimal.html#1e726a49ec952443190ac62dad22353c">Animal</a>()</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#4ec6768ff56f527202ab9c143a5ad4be">call</a>()</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classDog.html#16e01978bb90b2989ee3da3e87071b1b">Dog</a>()</td><td><a class="el" href="classDog.html">Dog</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a>($Kind)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> +</table></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classDog.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classDog.html new file mode 100644 index 00000000000..76846557a37 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classDog.html @@ -0,0 +1,80 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Dog Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Dog Class Reference</h1><!-- doxytag: class="Dog" --><!-- doxytag: inherits="Mammal" -->another subclassed mammal +<a href="#_details">More...</a> +<p> +<div class="dynheader"> +Inheritance diagram for Dog:</div> +<div class="dynsection"> + +<p><center><img src="classDog.png" usemap="#Dog_map" border="0" alt=""></center> +<map name="Dog_map"> +<area href="classMammal.html" alt="Mammal" shape="rect" coords="0,56,58,80"> +<area href="classAnimal.html" alt="Animal" shape="rect" coords="0,0,58,24"> +</map> +</div> + +<p> +<a href="classDog-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDog.html#16e01978bb90b2989ee3da3e87071b1b">Dog</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +another subclassed mammal +<p>Definition at line <a class="el" href="animals_8php-source.html#l00092">92</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="16e01978bb90b2989ee3da3e87071b1b"></a><!-- doxytag: member="Dog::Dog" ref="16e01978bb90b2989ee3da3e87071b1b" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Dog::Dog </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p> +constructor +<p>Definition at line <a class="el" href="animals_8php-source.html#l00093">93</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="animals_8php-source.html">animals.php</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classDog.png b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classDog.png Binary files differnew file mode 100644 index 00000000000..6ba62396a49 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classDog.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classMammal-members.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classMammal-members.html new file mode 100644 index 00000000000..23d9d6e96ba --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classMammal-members.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Mammal Member List</h1>This is the complete list of members for <a class="el" href="classMammal.html">Mammal</a>, including all inherited members.<p><table> + <tr class="memlist"><td><a class="el" href="classAnimal.html#1e726a49ec952443190ac62dad22353c">Animal</a>()</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#4ec6768ff56f527202ab9c143a5ad4be">call</a>()</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a>($Kind)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> +</table></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classMammal.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classMammal.html new file mode 100644 index 00000000000..9157b98a02d --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classMammal.html @@ -0,0 +1,54 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Mammal Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Mammal Class Reference</h1><!-- doxytag: class="Mammal" --><!-- doxytag: inherits="Animal" -->a base mammal +<a href="#_details">More...</a> +<p> +<div class="dynheader"> +Inheritance diagram for Mammal:</div> +<div class="dynsection"> + +<p><center><img src="classMammal.png" usemap="#Mammal_map" border="0" alt=""></center> +<map name="Mammal_map"> +<area href="classAnimal.html" alt="Animal" shape="rect" coords="34,0,92,24"> +<area href="classCat.html" alt="Cat" shape="rect" coords="0,112,58,136"> +<area href="classDog.html" alt="Dog" shape="rect" coords="68,112,126,136"> +</map> +</div> + +<p> +<a href="classMammal-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +a base mammal +<p>Definition at line <a class="el" href="animals_8php-source.html#l00080">80</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="animals_8php-source.html">animals.php</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classMammal.png b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classMammal.png Binary files differnew file mode 100644 index 00000000000..a736bde5a35 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classMammal.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classPigeon-members.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classPigeon-members.html new file mode 100644 index 00000000000..38490e8d13f --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classPigeon-members.html @@ -0,0 +1,36 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Pigeon Member List</h1>This is the complete list of members for <a class="el" href="classPigeon.html">Pigeon</a>, including all inherited members.<p><table> + <tr class="memlist"><td><a class="el" href="classAnimal.html#1e726a49ec952443190ac62dad22353c">Animal</a>()</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classBird.html#7c1b36856fe3a89d6098ec2b8a10ae8d">Bird</a>()</td><td><a class="el" href="classBird.html">Bird</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#4ec6768ff56f527202ab9c143a5ad4be">call</a>()</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classPigeon.html#cccbf4642d6d786d5edd21adb73dec36">Pigeon</a>()</td><td><a class="el" href="classPigeon.html">Pigeon</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a>($Kind)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> +</table></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classPigeon.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classPigeon.html new file mode 100644 index 00000000000..3c5736ca013 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classPigeon.html @@ -0,0 +1,80 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Pigeon Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Pigeon Class Reference</h1><!-- doxytag: class="Pigeon" --><!-- doxytag: inherits="Bird" -->a subclassed bird +<a href="#_details">More...</a> +<p> +<div class="dynheader"> +Inheritance diagram for Pigeon:</div> +<div class="dynsection"> + +<p><center><img src="classPigeon.png" usemap="#Pigeon_map" border="0" alt=""></center> +<map name="Pigeon_map"> +<area href="classBird.html" alt="Bird" shape="rect" coords="0,56,51,80"> +<area href="classAnimal.html" alt="Animal" shape="rect" coords="0,0,51,24"> +</map> +</div> + +<p> +<a href="classPigeon-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPigeon.html#cccbf4642d6d786d5edd21adb73dec36">Pigeon</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +a subclassed bird +<p>Definition at line <a class="el" href="animals_8php-source.html#l00064">64</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="cccbf4642d6d786d5edd21adb73dec36"></a><!-- doxytag: member="Pigeon::Pigeon" ref="cccbf4642d6d786d5edd21adb73dec36" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Pigeon::Pigeon </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p> +constructor +<p>Definition at line <a class="el" href="animals_8php-source.html#l00065">65</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="animals_8php-source.html">animals.php</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classPigeon.png b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classPigeon.png Binary files differnew file mode 100644 index 00000000000..dc73930253a --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classPigeon.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classRedKite-members.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classRedKite-members.html new file mode 100644 index 00000000000..ecde52536ac --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classRedKite-members.html @@ -0,0 +1,36 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>RedKite Member List</h1>This is the complete list of members for <a class="el" href="classRedKite.html">RedKite</a>, including all inherited members.<p><table> + <tr class="memlist"><td><a class="el" href="classAnimal.html#1e726a49ec952443190ac62dad22353c">Animal</a>()</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classBird.html#7c1b36856fe3a89d6098ec2b8a10ae8d">Bird</a>()</td><td><a class="el" href="classBird.html">Bird</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#4ec6768ff56f527202ab9c143a5ad4be">call</a>()</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRedKite.html#acb11b00f12795cf8b2c21af75c1d0c1">RedKite</a>()</td><td><a class="el" href="classRedKite.html">RedKite</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">setKind</a>($Kind)</td><td><a class="el" href="classAnimal.html">Animal</a></td><td></td></tr> +</table></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classRedKite.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classRedKite.html new file mode 100644 index 00000000000..b02adb50d2a --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classRedKite.html @@ -0,0 +1,80 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): RedKite Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>RedKite Class Reference</h1><!-- doxytag: class="RedKite" --><!-- doxytag: inherits="Bird" -->another subclassed bird +<a href="#_details">More...</a> +<p> +<div class="dynheader"> +Inheritance diagram for RedKite:</div> +<div class="dynsection"> + +<p><center><img src="classRedKite.png" usemap="#RedKite_map" border="0" alt=""></center> +<map name="RedKite_map"> +<area href="classBird.html" alt="Bird" shape="rect" coords="0,56,55,80"> +<area href="classAnimal.html" alt="Animal" shape="rect" coords="0,0,55,24"> +</map> +</div> + +<p> +<a href="classRedKite-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRedKite.html#acb11b00f12795cf8b2c21af75c1d0c1">RedKite</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +another subclassed bird +<p>Definition at line <a class="el" href="animals_8php-source.html#l00072">72</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="acb11b00f12795cf8b2c21af75c1d0c1"></a><!-- doxytag: member="RedKite::RedKite" ref="acb11b00f12795cf8b2c21af75c1d0c1" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">RedKite::RedKite </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p> +constructor +<p>Definition at line <a class="el" href="animals_8php-source.html#l00073">73</a> of file <a class="el" href="animals_8php-source.html">animals.php</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="animals_8php-source.html">animals.php</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classRedKite.png b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classRedKite.png Binary files differnew file mode 100644 index 00000000000..b286f8c415a --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classRedKite.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/doxygen.css b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/doxygen.css new file mode 100644 index 00000000000..22c484301dd --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/doxygen.css @@ -0,0 +1,473 @@ +BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { + font-family: Geneva, Arial, Helvetica, sans-serif; +} +BODY,TD { + font-size: 90%; +} +H1 { + text-align: center; + font-size: 160%; +} +H2 { + font-size: 120%; +} +H3 { + font-size: 100%; +} +CAPTION { + font-weight: bold +} +DIV.qindex { + width: 100%; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.navpath { + width: 100%; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.navtab { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +TD.navtab { + font-size: 70%; +} +A.qindex { + text-decoration: none; + font-weight: bold; + color: #1A419D; +} +A.qindex:visited { + text-decoration: none; + font-weight: bold; + color: #1A419D +} +A.qindex:hover { + text-decoration: none; + background-color: #ddddff; +} +A.qindexHL { + text-decoration: none; + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} +A.qindexHL:hover { + text-decoration: none; + background-color: #6666cc; + color: #ffffff; +} +A.qindexHL:visited { + text-decoration: none; + background-color: #6666cc; + color: #ffffff +} +A.el { + text-decoration: none; + font-weight: bold +} +A.elRef { + font-weight: bold +} +A.code:link { + text-decoration: none; + font-weight: normal; + color: #0000FF +} +A.code:visited { + text-decoration: none; + font-weight: normal; + color: #0000FF +} +A.codeRef:link { + font-weight: normal; + color: #0000FF +} +A.codeRef:visited { + font-weight: normal; + color: #0000FF +} +A:hover { + text-decoration: none; + background-color: #f2f2ff +} +DL.el { + margin-left: -1cm +} +.fragment { + font-family: monospace, fixed; + font-size: 95%; +} +PRE.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + margin-top: 4px; + margin-bottom: 4px; + margin-left: 2px; + margin-right: 8px; + padding-left: 6px; + padding-right: 6px; + padding-top: 4px; + padding-bottom: 4px; +} +DIV.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px +} + +DIV.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} +DIV.groupText { + margin-left: 16px; + font-style: italic; + font-size: 90% +} +BODY { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} +TD.indexkey { + background-color: #e8eef2; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TD.indexvalue { + background-color: #e8eef2; + font-style: italic; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TR.memlist { + background-color: #f0f0f0; +} +P.formulaDsp { + text-align: center; +} +IMG.formulaDsp { +} +IMG.formulaInl { + vertical-align: middle; +} +SPAN.keyword { color: #008000 } +SPAN.keywordtype { color: #604020 } +SPAN.keywordflow { color: #e08000 } +SPAN.comment { color: #800000 } +SPAN.preprocessor { color: #806020 } +SPAN.stringliteral { color: #002080 } +SPAN.charliteral { color: #008080 } +SPAN.vhdldigit { color: #ff00ff } +SPAN.vhdlchar { color: #000000 } +SPAN.vhdlkeyword { color: #700070 } +SPAN.vhdllogic { color: #ff0000 } + +.mdescLeft { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.mdescRight { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.memItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplParams { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + color: #606060; + background-color: #FAFAFA; + font-size: 80%; +} +.search { + color: #003399; + font-weight: bold; +} +FORM.search { + margin-bottom: 0px; + margin-top: 0px; +} +INPUT.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +TD.tiny { + font-size: 75%; +} +a { + color: #1A41A8; +} +a:visited { + color: #2A3798; +} +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; +} +TH.dirtab { + background: #e8eef2; + font-weight: bold; +} +HR { + height: 1px; + border: none; + border-top: 1px solid black; +} + +/* Style for detailed member documentation */ +.memtemplate { + font-size: 80%; + color: #606060; + font-weight: normal; + margin-left: 3px; +} +.memnav { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +.memitem { + padding: 4px; + background-color: #eef3f5; + border-width: 1px; + border-style: solid; + border-color: #dedeee; + -moz-border-radius: 8px 8px 8px 8px; +} +.memname { + white-space: nowrap; + font-weight: bold; +} +.memdoc{ + padding-left: 10px; +} +.memproto { + background-color: #d5e1e8; + width: 100%; + border-width: 1px; + border-style: solid; + border-color: #84b0c7; + font-weight: bold; + -moz-border-radius: 8px 8px 8px 8px; +} +.paramkey { + text-align: right; +} +.paramtype { + white-space: nowrap; +} +.paramname { + color: #602020; + font-style: italic; + white-space: nowrap; +} +/* End Styling for detailed member documentation */ + +/* for the tree view */ +.ftvtree { + font-family: sans-serif; + margin:0.5em; +} +/* these are for tree view when used as main index */ +.directory { + font-size: 9pt; + font-weight: bold; +} +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* The following two styles can be used to replace the root node title */ +/* with an image of your choice. Simply uncomment the next two styles, */ +/* specify the name of your image and be sure to set 'height' to the */ +/* proper pixel height of your image. */ + +/* .directory h3.swap { */ +/* height: 61px; */ +/* background-repeat: no-repeat; */ +/* background-image: url("yourimage.gif"); */ +/* } */ +/* .directory h3.swap span { */ +/* display: none; */ +/* } */ + +.directory > h3 { + margin-top: 0; +} +.directory p { + margin: 0px; + white-space: nowrap; +} +.directory div { + display: none; + margin: 0px; +} +.directory img { + vertical-align: -30%; +} +/* these are for tree view when not used as main index */ +.directory-alt { + font-size: 100%; + font-weight: bold; +} +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} +.directory-alt > h3 { + margin-top: 0; +} +.directory-alt p { + margin: 0px; + white-space: nowrap; +} +.directory-alt div { + display: none; + margin: 0px; +} +.directory-alt img { + vertical-align: -30%; +} + diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/doxygen.png b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/doxygen.png Binary files differnew file mode 100644 index 00000000000..f0a274bbaff --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/doxygen.png diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/files.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/files.html new file mode 100644 index 00000000000..18f4a3a2eeb --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/files.html @@ -0,0 +1,33 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): File Index</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>File List</h1>Here is a list of all files with brief descriptions:<table> + <tr><td class="indexkey"><a class="el" href="animals_8php.html">animals.php</a> <a href="animals_8php-source.html">[code]</a></td><td class="indexvalue">Test some classes </td></tr> + <tr><td class="indexkey"><a class="el" href="main_8php.html">main.php</a> <a href="main_8php-source.html">[code]</a></td><td class="indexvalue">Test code </td></tr> +</table> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/functions.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/functions.html new file mode 100644 index 00000000000..7b4b6c2c833 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/functions.html @@ -0,0 +1,56 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Class Members</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li class="current"><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="functions.html"><span>All</span></a></li> + <li><a href="functions_func.html"><span>Functions</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +Here is a list of all class members with links to the classes they belong to: +<p> +<ul> +<li>Animal() +: <a class="el" href="classAnimal.html#1e726a49ec952443190ac62dad22353c">Animal</a> +<li>Bird() +: <a class="el" href="classBird.html#7c1b36856fe3a89d6098ec2b8a10ae8d">Bird</a> +<li>call() +: <a class="el" href="classAnimal.html#4ec6768ff56f527202ab9c143a5ad4be">Animal</a> +<li>Cat() +: <a class="el" href="classCat.html#dff0d67c4d14c4eeeb35b8daa33ee442">Cat</a> +<li>Dog() +: <a class="el" href="classDog.html#16e01978bb90b2989ee3da3e87071b1b">Dog</a> +<li>Pigeon() +: <a class="el" href="classPigeon.html#cccbf4642d6d786d5edd21adb73dec36">Pigeon</a> +<li>RedKite() +: <a class="el" href="classRedKite.html#acb11b00f12795cf8b2c21af75c1d0c1">RedKite</a> +<li>setKind() +: <a class="el" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">Animal</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/functions_func.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/functions_func.html new file mode 100644 index 00000000000..6537f326f75 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/functions_func.html @@ -0,0 +1,56 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Class Members - Functions</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li class="current"><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="functions.html"><span>All</span></a></li> + <li class="current"><a href="functions_func.html"><span>Functions</span></a></li> + </ul> + </div> +</div> +<div class="contents"> + +<p> +<ul> +<li>Animal() +: <a class="el" href="classAnimal.html#1e726a49ec952443190ac62dad22353c">Animal</a> +<li>Bird() +: <a class="el" href="classBird.html#7c1b36856fe3a89d6098ec2b8a10ae8d">Bird</a> +<li>call() +: <a class="el" href="classAnimal.html#4ec6768ff56f527202ab9c143a5ad4be">Animal</a> +<li>Cat() +: <a class="el" href="classCat.html#dff0d67c4d14c4eeeb35b8daa33ee442">Cat</a> +<li>Dog() +: <a class="el" href="classDog.html#16e01978bb90b2989ee3da3e87071b1b">Dog</a> +<li>Pigeon() +: <a class="el" href="classPigeon.html#cccbf4642d6d786d5edd21adb73dec36">Pigeon</a> +<li>RedKite() +: <a class="el" href="classRedKite.html#acb11b00f12795cf8b2c21af75c1d0c1">RedKite</a> +<li>setKind() +: <a class="el" href="classAnimal.html#8e9da8131c7a28ddd3d2b3d59ba3275e">Animal</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/globals.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/globals.html new file mode 100644 index 00000000000..87db63ef6f8 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/globals.html @@ -0,0 +1,46 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Class Members</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="globals.html"><span>All</span></a></li> + <li><a href="globals_func.html"><span>Functions</span></a></li> + <li><a href="globals_vars.html"><span>Variables</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +Here is a list of all file members with links to the files they belong to: +<p> +<ul> +<li>$animals +: <a class="el" href="main_8php.html#341e9e641ceab16445632bd3c630cf48">main.php</a> +<li>TIO_write() +: <a class="el" href="animals_8php.html#8aed71372222cae35da78ac0f6c34c32">animals.php</a> +<li>TIO_writeln() +: <a class="el" href="animals_8php.html#1b5f1c2eef1479c9e7f6c1605c694bf9">animals.php</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/globals_func.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/globals_func.html new file mode 100644 index 00000000000..81d0332ca5e --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/globals_func.html @@ -0,0 +1,44 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Class Members</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="globals.html"><span>All</span></a></li> + <li class="current"><a href="globals_func.html"><span>Functions</span></a></li> + <li><a href="globals_vars.html"><span>Variables</span></a></li> + </ul> + </div> +</div> +<div class="contents"> + +<p> +<ul> +<li>TIO_write() +: <a class="el" href="animals_8php.html#8aed71372222cae35da78ac0f6c34c32">animals.php</a> +<li>TIO_writeln() +: <a class="el" href="animals_8php.html#1b5f1c2eef1479c9e7f6c1605c694bf9">animals.php</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/globals_vars.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/globals_vars.html new file mode 100644 index 00000000000..0324b884be4 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/globals_vars.html @@ -0,0 +1,42 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Class Members</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="globals.html"><span>All</span></a></li> + <li><a href="globals_func.html"><span>Functions</span></a></li> + <li class="current"><a href="globals_vars.html"><span>Variables</span></a></li> + </ul> + </div> +</div> +<div class="contents"> + +<p> +<ul> +<li>$animals +: <a class="el" href="main_8php.html#341e9e641ceab16445632bd3c630cf48">main.php</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/hierarchy.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/hierarchy.html new file mode 100644 index 00000000000..4ef8cc5e7ec --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/hierarchy.html @@ -0,0 +1,45 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Hierarchical Index</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li class="current"><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Class Hierarchy</h1>This inheritance list is sorted roughly, but not completely, alphabetically:<ul> +<li><a class="el" href="classAnimal.html">Animal</a> +<ul> +<li><a class="el" href="classBird.html">Bird</a> +<ul> +<li><a class="el" href="classPigeon.html">Pigeon</a> +<li><a class="el" href="classRedKite.html">RedKite</a> +</ul> +<li><a class="el" href="classMammal.html">Mammal</a> +<ul> +<li><a class="el" href="classCat.html">Cat</a> +<li><a class="el" href="classDog.html">Dog</a> +</ul> +</ul> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/index.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/index.html new file mode 100644 index 00000000000..3d19a414b0a --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/index.html @@ -0,0 +1,25 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): Main Page</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li class="current"><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Sample Code (PHP) Documentation</h1> +<p> +<h3 align="center">0.1 20120518 </h3>Some test code. This shows a hierachy of classes. For this example we do animals. </div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/main_8php-source.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/main_8php-source.html new file mode 100644 index 00000000000..b3a4c2057a1 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/main_8php-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): main.php Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +<h1>main.php</h1><a href="main_8php.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <?php +<a name="l00002"></a>00002 <span class="comment">/***** Copyright 2012 Simon Dales</span> +<a name="l00003"></a>00003 <span class="comment">**</span> +<a name="l00004"></a>00004 <span class="comment">** This work may be distributed and/or modified under the</span> +<a name="l00005"></a>00005 <span class="comment">** conditions of the LaTeX Project Public License, either version 1.3</span> +<a name="l00006"></a>00006 <span class="comment">** of this license or (at your option) any later version.</span> +<a name="l00007"></a>00007 <span class="comment">** The latest version of this license is in</span> +<a name="l00008"></a>00008 <span class="comment">** http://www.latex-project.org/lppl.txt</span> +<a name="l00009"></a>00009 <span class="comment">**</span> +<a name="l00010"></a>00010 <span class="comment">** This work has the LPPL maintenance status `maintained'.</span> +<a name="l00011"></a>00011 <span class="comment">** </span> +<a name="l00012"></a>00012 <span class="comment">** The Current Maintainer of this work is Simon Dales.</span> +<a name="l00013"></a>00013 <span class="comment">*/</span> +<a name="l00014"></a>00014 +<a name="l00029"></a>00029 require_once(<span class="stringliteral">'animals.php'</span>); +<a name="l00030"></a>00030 +<a name="l00031"></a>00031 <span class="comment">// main</span> +<a name="l00032"></a><a class="code" href="main_8php.html#341e9e641ceab16445632bd3c630cf48">00032</a> <a class="code" href="main_8php.html#341e9e641ceab16445632bd3c630cf48">$animals</a> = array( +<a name="l00033"></a>00033 <span class="keyword">new</span> <a class="code" href="classCat.html" title="a subclassed mammal">Cat</a> +<a name="l00034"></a>00034 ,<span class="keyword">new</span> <a class="code" href="classDog.html" title="another subclassed mammal">Dog</a> +<a name="l00035"></a>00035 ,<span class="keyword">new</span> <a class="code" href="classBird.html" title="an abstract bird">Bird</a> +<a name="l00036"></a>00036 ,<span class="keyword">new</span> <a class="code" href="classRedKite.html" title="another subclassed bird">RedKite</a> +<a name="l00037"></a>00037 ,<span class="keyword">new</span> <a class="code" href="classPigeon.html" title="a subclassed bird">Pigeon</a> +<a name="l00038"></a>00038 ); +<a name="l00039"></a>00039 +<a name="l00040"></a>00040 <span class="keywordflow">foreach</span> ( <a class="code" href="main_8php.html#341e9e641ceab16445632bd3c630cf48">$animals</a> as $v) +<a name="l00041"></a>00041 $v->call(); +<a name="l00042"></a>00042 +<a name="l00043"></a>00043 <span class="comment">//eof</span> +<a name="l00044"></a>00044 ?> +</pre></div></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/main_8php.html b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/main_8php.html new file mode 100644 index 00000000000..ac67cb9550b --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/main_8php.html @@ -0,0 +1,63 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Sample Code (PHP): main.php File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.6 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>main.php File Reference</h1>test code <a href="#_details">More...</a> +<p> + +<p> +<a href="main_8php-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Variables</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="main_8php.html#341e9e641ceab16445632bd3c630cf48">$animals</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +test code +<p> + +<p>Definition in file <a class="el" href="main_8php-source.html">main.php</a>.</p> +<hr><h2>Variable Documentation</h2> +<a class="anchor" name="341e9e641ceab16445632bd3c630cf48"></a><!-- doxytag: member="main.php::$animals" ref="341e9e641ceab16445632bd3c630cf48" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">$animals </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<b>Initial value:</b><div class="fragment"><pre class="fragment"> array( + <span class="keyword">new</span> <a class="code" href="classCat.html" title="a subclassed mammal">Cat</a> + ,<span class="keyword">new</span> <a class="code" href="classDog.html" title="another subclassed mammal">Dog</a> + ,<span class="keyword">new</span> <a class="code" href="classBird.html" title="an abstract bird">Bird</a> + ,<span class="keyword">new</span> <a class="code" href="classRedKite.html" title="another subclassed bird">RedKite</a> + ,<span class="keyword">new</span> <a class="code" href="classPigeon.html" title="a subclassed bird">Pigeon</a> + ) +</pre></div> +<p>Definition at line <a class="el" href="main_8php-source.html#l00032">32</a> of file <a class="el" href="main_8php-source.html">main.php</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:12:42 2012 for Sample Code (PHP) by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +</body> +</html> diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_b.gif b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_b.gif Binary files differnew file mode 100644 index 00000000000..0d623483ffd --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_b.gif diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_l.gif b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_l.gif Binary files differnew file mode 100644 index 00000000000..9b1e6337c92 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_l.gif diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_r.gif b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_r.gif Binary files differnew file mode 100644 index 00000000000..ce9dd9f533c --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_r.gif diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tabs.css b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tabs.css new file mode 100644 index 00000000000..95f00a91da3 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tabs.css @@ -0,0 +1,102 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +DIV.tabs +{ + float : left; + width : 100%; + background : url("tab_b.gif") repeat-x bottom; + margin-bottom : 4px; +} + +DIV.tabs UL +{ + margin : 0px; + padding-left : 10px; + list-style : none; +} + +DIV.tabs LI, DIV.tabs FORM +{ + display : inline; + margin : 0px; + padding : 0px; +} + +DIV.tabs FORM +{ + float : right; +} + +DIV.tabs A +{ + float : left; + background : url("tab_r.gif") no-repeat right top; + border-bottom : 1px solid #84B0C7; + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + +DIV.tabs A:hover +{ + background-position: 100% -150px; +} + +DIV.tabs A:link, DIV.tabs A:visited, +DIV.tabs A:active, DIV.tabs A:hover +{ + color: #1A419D; +} + +DIV.tabs SPAN +{ + float : left; + display : block; + background : url("tab_l.gif") no-repeat left top; + padding : 5px 9px; + white-space : nowrap; +} + +DIV.tabs INPUT +{ + float : right; + display : inline; + font-size : 1em; +} + +DIV.tabs TD +{ + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + + + +/* Commented Backslash Hack hides rule from IE5-Mac \*/ +DIV.tabs SPAN {float : none;} +/* End IE5-Mac hack */ + +DIV.tabs A:hover SPAN +{ + background-position: 0% -150px; +} + +DIV.tabs LI.current A +{ + background-position: 100% -150px; + border-width : 0px; +} + +DIV.tabs LI.current SPAN +{ + background-position: 0% -150px; + padding-bottom : 6px; +} + +DIV.navpath +{ + background : none; + border : none; + border-bottom : 1px solid #84B0C7; +} diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/php/main.php b/Master/texmf-dist/doc/support/lua2dox/examples/php/main.php new file mode 100644 index 00000000000..dc806d7e088 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/php/main.php @@ -0,0 +1,44 @@ +<?php +/***** Copyright 2012 Simon Dales +** +** This work may be distributed and/or modified under the +** conditions of the LaTeX Project Public License, either version 1.3 +** of this license or (at your option) any later version. +** The latest version of this license is in +** http://www.latex-project.org/lppl.txt +** +** This work has the LPPL maintenance status `maintained'. +** +** The Current Maintainer of this work is Simon Dales. +*/ + +/*! + \file + \brief test code + */ + +/*! + \mainpage + + Some test code. + This shows a hierachy of classes. + For this example we do animals. + + */ + +require_once('animals.php'); + +// main +$animals = array( + new Cat + ,new Dog + ,new Bird + ,new RedKite + ,new Pigeon + ); + +foreach ( $animals as $v) + $v->call(); + +//eof +?>
\ No newline at end of file diff --git a/Master/texmf-dist/doc/support/lua2dox/install.sh b/Master/texmf-dist/doc/support/lua2dox/install.sh new file mode 100755 index 00000000000..7d6cda7be15 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/install.sh @@ -0,0 +1,73 @@ +#!/bin/sh + +########################################################################### +# Copyright (C) 2012 by Simon Dales # +# simon@purrsoft.co.uk # +# # +# This program is free software; you can redistribute it and/or modify # +# it under the terms of the GNU General Public License as published by # +# the Free Software Foundation; either version 2 of the License, or # +# (at your option) any later version. # +# # +# This program is distributed in the hope that it will be useful, # +# but WITHOUT ANY WARRANTY; without even the implied warranty of # +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # +# GNU General Public License for more details. # +# # +# You should have received a copy of the GNU General Public License # +# along with this program; if not, write to the # +# Free Software Foundation, Inc., # +# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # +########################################################################### + +INSTALLDIR="$1" +#################### +HOME="/home/${USER}" +DEFAULT_INSTALLDIR="${HOME}/bin" + +if test -z "${INSTALLDIR}" +then + INSTALLDIR="${DEFAULT_INSTALLDIR}" +fi + +APP_NAME="lua2dox_lua" +############################ +go_splat(){ + echo "ERROR!: $1" + exit 1 + } + +mk_link(){ + echo "mk \"$1\" -> \"$2\"" + ln -s "$1" "$2" || go_splat "creating link: \"$1\" -> \"$2\"" + } + +do_install(){ + echo "install to \"${INSTALLDIR}\"" + + CURRENT_DIR=`pwd` + APP_PATH="${CURRENT_DIR}/${APP_NAME}" + echo "app path=\"${APP_PATH}\"" + cd "${INSTALLDIR}" + + mk_link "${APP_PATH}" "lua2dox_lua" + mk_link "${APP_PATH}" "lua2dox_filter" + + echo "install done." + } + +## main +case "${INSTALLDIR}" in +--help) + echo "Syntax:" + echo "$0 <dir>|<help>" + echo "" + echo "--help show this help" + echo "<dir> install directory for links" + echo "default <dir>=\"~/bin\"" + ;; +*) +do_install + ;; +esac +##eof
\ No newline at end of file diff --git a/Master/texmf-dist/doc/support/lua2dox/lua2dox-refm.pdf b/Master/texmf-dist/doc/support/lua2dox/lua2dox-refm.pdf Binary files differnew file mode 100644 index 00000000000..2b0b81e2cea --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/lua2dox-refm.pdf diff --git a/Master/texmf-dist/doc/support/lua2dox/lua2dox-refm.tex b/Master/texmf-dist/doc/support/lua2dox/lua2dox-refm.tex new file mode 100644 index 00000000000..dfa42dc5bac --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/lua2dox-refm.tex @@ -0,0 +1,416 @@ +\documentclass[a4paper]{article} +%\nofiles + +\usepackage[T1]{fontenc} +\usepackage{hyperref} +\usepackage{listings} +\input{lua.def} % not installed properly so just include here + +%% +% h +\parindent=0bp +\textwidth=450bp +\oddsidemargin=0bp + +% v +\parskip=.5em +\voffset=-70bp +\textheight=750bp + + +%%%%%%%%%%%%%%%%% +\def\sectionSprout(#1,#2){\vspace{#1}\penalty#2\vspace{-#1}} +\def\Sect{\sectionSprout(125bp,-150)\section} +\def\SSect{\sectionSprout(100bp,-100)\subsection} +\def\SSSect{\sectionSprout(80bp,-50)\subsubsection} + +\def\BT{\begin{tabular}} +\def\ET{\end{tabular}} + +\def\BE{\begin{enumerate}} +\def\EE{\end{enumerate}} +\def\IE{\item } + +\def\BI{\begin{itemize}} +\def\EI{\end{itemize}} +\def\II{\item } + +\long\def\Nerd#1{{\tt #1}} +\def\URL#1{{\tt #1}} +\def\LuaToDoX{Lua2D\raise-.3em\hbox{O}X$_{lua}$} +\def\luatodox{\Nerd{lua2dox\_lua}} +\def\Doxygen{\Nerd{Doxygen}} +\def\doxygen{\Nerd{doxygen}} +\def\To{$\rightarrow$} + +\def\Foot#1{\footnote{#1}} + +\lstset{language=C++ + ,frame=single + ,numbers=left + ,numberstyle=\tiny + ,tabsize=2 + } + +\hypersetup{ + pdfinfo={ + Title={Lua2DoX lua ref manual} + ,Subject={Autodoc tool for Lua} + } + ,colorlinks=true + ,linkcolor=blue + } + +\begin{document} +\pagestyle{empty} +\begin{center} + \huge \LuaToDoX + + \large + v0.1 + + Copyright (c) 2012 Simon Dales + + 4th July 2012 + +{\fboxsep=.5em\fboxrule=.1bp\fbox{% +\begin{minipage}{300bp} +\hyphenpenalty=10000% +\small +%\begin{abstract} +This is a hack to enable \doxygen{} to document lua. + +It uses the well-known \doxygen{} filter mechanism to fool \doxygen{} into reading foreign languages. + +If this works for you then enjoy. + +%\end{abstract} +\end{minipage} +}} +\end{center} + +\tableofcontents + +\newpage +\pagestyle{headings} + +\Sect{Introduction} + +Documenting sourcecode is a hassle. +There are two basic methods of providing documented sourcecode: ``literate programming'' and ``autodoc''. +Without these tools a human has to keep the documentation and code aligned, which rarely happens. + +\SSect{Literate Programming} + +If one is sufficiently organised, and it fits in with your existing work practices, then there is +a lot going for literate programming. +Here you write a combined document that contains both code and documentation fragments. +When you want code or documentation you run it through a program which assembles the appropriate files. + +This is theoretically the neatest way of making code. +The best known example of literate programming is the source of \TeX. + +\SSect{Autodoc} + +In the real world we get source from many sources, usually where literate programming wasn't used or isn't available. + +One solution is to use an automatic documentation tool: +feed it sourcecode and it will extract what documentation it can. + +If you feed it raw source then all it can do is tell you where it found features such as function and class declarations. + +If your source has been suitably prepared, then more detailed documentation can be produced. +This preparation takes the form of ``magic comments''. +These are source comments that contain ``magic'' features that let the autodoc tool know to make use of them. + +\SSSect{Doxygen} + +\Doxygen{} is one of the many autodoc tools use to document C-like languages. +It is widely used and supported in the linux world and has MacOS and Windows ports. + +\begin{lstlisting}[firstnumber=83] +void helloWorldOnce(){ + printf("hello world\n"); + } +/*! + \brief writes hello world *n + + This is a demo of how to loop round + and print something + + \param N number of times round +*/ +void helloWorldN(int N){ + for (int i=0;i<N;i++) + printf("hello world %d\n",i); + } +\end{lstlisting} + +\hspace{-.35em}{\fboxsep=.5em\fboxrule=.1bp\fbox{% +\begin{minipage}{\textwidth} +{\sf void {\bfseries helloWorldN}(int N)} + +{\itshape writes hello world *n} + +This is a demo of how to loop round +and print something + +{\bfseries Parameters:} + +\hspace*{1em}{\itshape N} number of times round + +Definition at line {\bfseries 94} of file {\bfseries hello.cpp}. + +\vskip1em +{\sf void {\bfseries helloWorldOnce}()} + +Definition at line {\bfseries 83} of file {\bfseries hello.cpp}. + +\end{minipage}\hspace{-.35em}% +}% +}\hspace*{-10em}\rule{0bp}{0bp}% + +\SSSect{\LuaToDoX} + +In the case of \doxygen{}, which is intended for C-like languages, it expects `\Nerd{///}' or `\Nerd{//!}' for C++ comments and `\Nerd{/**}\ldots\Nerd{*/}'/`\Nerd{/*!}\ldots\Nerd{*/}' for C-style comments. +For \LuaToDoX{} we recycle this convention and use `\Nerd{-{}-!}' and `\Nerd{-{}-[[!}\ldots\Nerd{]]}'. + +The internal format of the magic comments is identical to \doxygen. +This is not suprising in that \Nerd{lua2dox\_filter} is a \doxygen{} filter. +What it does is to read lua code and output something not entirely unlike C++. + +This lets us make Doxygen output some documentation to let +us develop this code. + +\begin{lstlisting}[firstnumber=83,language=lua] +function helloWorldOnce() + io.write("hello world\n") +end +--[[! + \brief writes hello world *n + + This is a demo of how to loop round + and print something + + \param N number of times round + ]] +function helloWorldN(N) + for i=0,N do + io.write("hello world" .. i .. "\n") + end +end +\end{lstlisting} + +\hspace{-.35em}{\fboxsep=.5em\fboxrule=.1bp\fbox{% +\begin{minipage}{\textwidth} +{\sf function {\bfseries helloWorldN}(N)} + +{\itshape writes hello world *n} + +This is a demo of how to loop round +and print something + +{\bfseries Parameters:} + +\hspace*{1em}{\itshape N} number of times round + +Definition at line {\bfseries 94} of file {\bfseries hello.cpp}. + +\vskip1em +{\sf function {\bfseries helloWorldOnce}()} + +Definition at line {\bfseries 83} of file {\bfseries hello.cpp}. + +\end{minipage}\hspace{-.35em}% +}% +}\hspace*{-10em}\rule{0bp}{0bp}% + +\SSect{Origins} + +\LuaToDoX{} inspired by the functionality of \Nerd{lua2dox}% +\Foot{\URL{http://search.cpan.org/\~{}alec/Doxygen-Lua-0.02/lib/Doxygen/Lua.pm}}. +Found on CPAN when looking for something else; kinda handy. + +Improved from \Nerd{lua2dox} to make the \doxygen{} output more friendly. +Runs faster in lua than in Perl. + +Because this Perl based system is called ``\Nerd{lua2dox}'', I have decided to add ``\Nerd{\_lua}'' to the name to keep the two separate, so it is called ``\luatodox''. + +\newpage +\Sect{Installation} +\SSect{System requirements} + +Should run on any reasonably modern computer (PC or MacOS X). + +Requires a reasonably recent: \doxygen{} and \Nerd{luatex} or \Nerd{lua}. + +\SSSect{Luatex/lua} + + +Whilst \Nerd{luatex} isn't strictly required to make it run; \TeX{} users +are more likely to have a recent version (via \Nerd{texlive}) of \Nerd{texlua} +rather than relying on your, possibly aging, distro's lua. + +It should work with either \Nerd{texlua} or \Nerd{lua}. +The calling bash script determines which one is available (\Nerd{texlua} then \Nerd{lua}) and selects that one. + +\SSSect{\doxygen} + +Install this using whatever mechanism you usually use. + +It is also helpful if you know how to use \doxygen. + +\SSect{Linux/other Unices} + +Only tested for linux, but should work for any Unix-like OS. + +For other OS you need to figure it out yourself. +If you do, then please email me with the code/suggestions. + +\BE +\IE manually check if lua2dox.lua runs on your system. + +From the commandline run ``\Nerd{./lua2dox\_lua -{}-help}''. +If it runs and produces a sensible result then it probably works. + +\IE Manually pick an appropriate directory for this system. + +Make this new directory and copy/mv all these files into there. +If you are installing it as a personal app then put it somewhere in your +userspace. For system-wide: ask sysadmin. + +\IE Run ``\Nerd{install.sh}''. +This makes the links to the active code. + +Default is to put in `\Nerd{\~{}/bin}''. For system-wide: ask sysadmin. +\EE + +\SSect{Windows} +Not yet +\SSect{Mac OSX} +Not yet + +\newpage +\Sect{Useage} + +Because this is a \doxygen{} filter then it is assumed that the endusers are familiar with +the use of this app. +When familiar then one can move on to documenting lua code. + +\SSect{Learn to use \Doxygen} + +Ensure \doxygen{} is installed on your system and that you are familiar with its use. +Best is to try to make and document some simple C/C++/PHP to see what it produces. + +Included with this distribution are some examples of php and lua code. +They are two simple programs that create some classes and then show their use. +The documentation should be nearly the same as each other. + +\SSect{running \LuaToDoX} +\SSSect{make Doxyfile} +Run ``\Nerd{lua2dox\_lua -g}'' to create a default \Nerd{Doxyfile}. +This is the configuration file that \doxygen{} needs for making the documentation. + + Then alter it to let it recognise lua. Add the two following lines: + +\begin{lstlisting}{language=bash} +PROJECT_NAME = <name of project> +PROJECT_NUMBER = <version number> +OUTPUT_DIRECTORY = docs +FILE_PATTERNS = *.lua +FILTER_PATTERNS = *.lua=lua2dox_filter +SOURCE_BROWSER = yes +GENERATE_LATEX = no +\end{lstlisting} + +Either add them to the end or find the appropriate entry in \Nerd{Doxyfile}. + +\SSSect{run \LuaToDoX} + +Once \Nerd{Doxyfile} has been edited run as ``\Nerd{lua2dox\_lua}''. + +When reading source with classes multiple passes are needed. +Each pass generates a list of member functions (as a file) that were found on this pass. +This list is read in on the next pass. +If the class+methods haven't changed this time then you only need to run it once, else run twice, +much like running \LaTeX{} \Nerd{$\backslash$tableofcontents}. + +\SSect{In use} + +As with \doxygen{} the HTML output is the most useful for development. +When the project is finished then PDF output (via \LaTeX) may be useful. + +Typically you will have some source files open in your editor/IDE. +Also keep a web-browser window open pointing at the documentation. + +After a bit of editing the documentation will become stale. +At this point run \LuaToDoX{} once/twice and refresh the HTML pages. +Then your documentation will be updated. + +\newpage +\Sect{Design} + +\LuaToDoX{} is a \doxygen{} filter. +It has a basic parser that will read each line of lua and output an equivalent in pseudo-C++. +It loops round until it has found the end of the file. +It only has to be good enough for \doxygen{} to see it as legal. +Therefore our lua interpreter is fairly limited, but ``good enough''. + +The parser is relatively crude and assumes that the programmer writes lua in a fairly +clean way. +Some bits of lua will confuse it. + +In order for the source browser to work in the \doxygen{} output it must preserve the number of lines. +The output of each line is either written as-is or a converted line. +When \doxygen{} re-reads the source to make the source-HTML/\LaTeX{}/\ldots it uses the line number +to set the position. + + +It only supports comments that preceded the function/class declaration. +Any in the middle will act as cruft in the resulting documentation. +This will be slightly out of place but at least should refer to somewhere near to +where it was intended. +In particular ``\Nerd{@todo}''. This will appear in the ToDo list, but not associated with the right function. + +\SSect{Classes} +Class declarations are assumed to be using a ``well-known'' userdefined function ``\Nerd{class()}''. +It processes\goodbreak``\Nerd{AA = class(A)}'' \To{} ``\Nerd{class AA: public A\{\}};''. + +However it will probably have some member functions. +These get converted from \goodbreak''\Nerd{A.foo(a,b)}'' \To{} ``\Nerd{A::foo(a,b)}''. +This is stored in a temporary file. +When \LuaToDoX{} is run a subsequent time this is used to generate a list of methods. +So \goodbreak``\Nerd{AA = class(A)}'' \To{} ``\Nerd{class AA: public A\{foo(a,b);bar(x);\}};'' + + +\SSect{Multiline function declarations} + +Because \LuaToDoX{} can only process one line at a time it cannot correctly process function declarations +with multiline parameter list. +This is because the parser isn't sophisticated enough to guarantee finding the close paren on some random later line. + +So I have put in a hack that will insert the ``missing'' close paren. +It looks at the function declaration that you have got and checks for a close paren. +It if is not there then it will add a spoof parameter and the close. + +The effect is that you will get the function documented, but not with the parameter list you might expect. + +\begin{lstlisting}[firstnumber=94] +function foo(A + ,B + ,C) +\end{lstlisting} + +Becomes +\begin{lstlisting}[firstnumber=94] +function foo(A,___MissingCloseParenHere___) +\end{lstlisting} + +\SSect{Multiple magic comments} + +The hacking of lua to C++ by \LuaToDoX{} has the limitation that some magic comments will not get associated with the correct function/class. This is a ``feature'' that might get correct in a later version. + + +\end{document} + +%%eof
\ No newline at end of file diff --git a/Master/texmf-dist/scripts/lua2dox/lua.def b/Master/texmf-dist/scripts/lua2dox/lua.def new file mode 100755 index 00000000000..83af433e61e --- /dev/null +++ b/Master/texmf-dist/scripts/lua2dox/lua.def @@ -0,0 +1,39 @@ +% -*- latex -*- +% Definition of the Lua language for the listings package +% Time-stamp: <2008-11-30 15:27:16 rsmith> +% Written by Roland Smith <rsmith@xs4all.nl> and hereby placed in the public +% domain. + +\lstdefinelanguage{lua} + {morekeywords={and,break,do,else,elseif,end,false,for,function,if,in,local, + nil,not,or,repeat,return,then,true,until,while}, + morekeywords={[2]arg,assert,collectgarbage,dofile,error,_G,getfenv, + getmetatable,ipairs,load,loadfile,loadstring,next,pairs,pcall,print, + rawequal,rawget,rawset,select,setfenv,setmetatable,tonumber,tostring, + type,unpack,_VERSION,xpcall}, + morekeywords={[2]coroutine.create,coroutine.resume,coroutine.running, + coroutine.status,coroutine.wrap,coroutine.yield}, + morekeywords={[2]module,require,package.cpath,package.load,package.loaded, + package.loaders,package.loadlib,package.path,package.preload, + package.seeall}, + morekeywords={[2]string.byte,string.char,string.dump,string.find, + string.format,string.gmatch,string.gsub,string.len,string.lower, + string.match,string.rep,string.reverse,string.sub,string.upper}, + morekeywords={[2]table.concat,table.insert,table.maxn,table.remove, + table.sort}, + morekeywords={[2]math.abs,math.acos,math.asin,math.atan,math.atan2, + math.ceil,math.cos,math.cosh,math.deg,math.exp,math.floor,math.fmod, + math.frexp,math.huge,math.ldexp,math.log,math.log10,math.max,math.min, + math.modf,math.pi,math.pow,math.rad,math.random,math.randomseed,math.sin, + math.sinh,math.sqrt,math.tan,math.tanh}, + morekeywords={[2]io.close,io.flush,io.input,io.lines,io.open,io.output, + io.popen,io.read,io.tmpfile,io.type,io.write,file:close,file:flush, + file:lines,file:read,file:seek,file:setvbuf,file:write}, + morekeywords={[2]os.clock,os.date,os.difftime,os.execute,os.exit,os.getenv, + os.remove,os.rename,os.setlocale,os.time,os.tmpname}, + sensitive=true, + morecomment=[l]{--}, + morecomment=[s]{--[[}{]]}, + morestring=[b]", + morestring=[d]' + } diff --git a/Master/texmf-dist/scripts/lua2dox/lua2dox.lua b/Master/texmf-dist/scripts/lua2dox/lua2dox.lua new file mode 100755 index 00000000000..9249baac9cd --- /dev/null +++ b/Master/texmf-dist/scripts/lua2dox/lua2dox.lua @@ -0,0 +1,618 @@ +--[[-------------------------------------------------------------------------- + -- Copyright (C) 2012 by Simon Dales -- + -- simon@purrsoft.co.uk -- + -- -- + -- This program is free software; you can redistribute it and/or modify -- + -- it under the terms of the GNU General Public License as published by -- + -- the Free Software Foundation; either version 2 of the License, or -- + -- (at your option) any later version. -- + -- -- + -- This program is distributed in the hope that it will be useful, -- + -- but WITHOUT ANY WARRANTY; without even the implied warranty of -- + -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -- + -- GNU General Public License for more details. -- + -- -- + -- You should have received a copy of the GNU General Public License -- + -- along with this program; if not, write to the -- + -- Free Software Foundation, Inc., -- + -- 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -- +----------------------------------------------------------------------------]] + +--[[! + \file + \brief a hack lua2dox converter + ]] + +--[[! + \mainpage + + + A hack lua2dox converter + Version 0.1 + + This lets us make Doxygen output some documentation to let + us develop this code. + + It is partially cribbed from the functionality of lua2dox + (http://search.cpan.org/~alec/Doxygen-Lua-0.02/lib/Doxygen/Lua.pm). + Found on CPAN when looking for something else; kinda handy. + + Improved from lua2dox to make the doxygen output more friendly. + Also it runs faster in lua rather than Perl. + + Because this Perl based system is called "lua2dox"., I have decided to add ".lua" to the name + to keep the two separate. + + 0. Ensure doxygen is installed on your system and that you are familiar with its use. + Best is to try to make and document some simple C/C++/PHP to see what it produces. + + 1. Run "lua2dox_lua -g" to create a default Doxyfile. + + Then alter it to let it recognise lua. Add the two following lines: + + FILE_PATTERNS = *.lua + + FILTER_PATTERNS = *.lua=lua2dox_filter + + Either add them to the end or find the appropriate entry in Doxyfile. + + 2. When Doxyfile is edited run as "lua2dox_lua" + + When reading source with classes multiple passes are needed. + Each pass generates a list of member functions (as a file) that were found on this pass. + This list is read in on the next pass. + If the class+methods haven't changed this time then you only need to run it once, else run twice. + + The core function reads the input file (filename or stdin) and outputs some pseudo C-ish language. + It only has to be good enough for doxygen to see it as legal. + Therefore our lua interpreter is fairly limited, but "good enough". + + One limitation is that each line is treated separately (except for long comments). + The implication is that class and function declarations must be on the same line. + Some functions can have their parameter lists extended over multiple lines to make it look neat. + Managing this where there are also some comments is a bit more coding than I want to do at this stage, + so it will probably not document accurately if we do do this. + + However I have put in a hack that will insert the "missing" close paren. + The effect is that you will get the function documented, but not with the parameter list you might expect. + + Installation: + + Here for linux or unix-like, for any other OS you need to refer to other documentation. + + This file is "lua2dox.lua". It gets called by "lua2dox_lua". + Somewhere in your path (e.g. "~/bin" or "/usr/local/bin") put two links to "lua2dox_lua". + Names to use are "lua2dox_lua" and "lua2dox_filter". + + Call it as "lua2dox_lua" and the filter that gets called by doxygen is "lua2dox_filter". + + ]] + +-- we won't use our library code, so this becomes more portable + +local TConfig_config={ + ['LUA2DOX_COMMENTARY_FILE_IN']='./killme_lua2dox.methods' + ,['LUA2DOX_COMMENTARY_FILE_OUT']='./killme_lua2dox.methods.out' + } + +--! \brief Gets a config val +local function TConfig_get(Key,Default) + local val = TConfig_config[Key] + if not val then + val = Default + end + return val +end + +--! \brief sets a config val +local function TConfig_set(Key,Val) + TConfig_config[Key] = Val +end + +--! \brief write to stdout +--! +--! writes Str (if not nil) +local function TIO_write(Str) + if (Str) then + io.write(Str) + end +end + +--! \brief write to stdout +--! +--! writelns Str (if not nil) and then an eoln. +local function TIO_writeln(Str) + if (Str) then + io.write(Str) + end + io.write("\n") +end + +--! \brief show error to stdout +--! +--! writelns Str (if not nil) and then an eoln. +local function TIO_showError(Err,Str) + local err = Err + if not err then + err = 1 + end + + TIO_write('Error (' .. err .. '):') + TIO_writeln(Str) + return err +end + +--! \brief run system command +local function TOS_system(Cmd) + local errno,str + local rtn = os.execute(Cmd) + if not (rtn==0) then + errno = rtn + str = 'an error occured' + end + return errno,str +end + +--! \brief does file exist? +local function TOS_fileExists(Filename) + local fh = io.open(Filename,'r') + if fh~=nil then + fh:close() + return true + end + return false +end + +--! \brief get the current time +local function TClock_GetTimeNow() + if os.gettimeofday then + return os.gettimeofday() + else + return os.time() + end +end + +--! \brief get a timestamp +--! +--! not strictly necessary here but lets us put a timestamp on the end of the output stream. +--! Note that doxygen won't read this, and being off the end of the true file length (num lines), +--! it will have no effect. +--! However it lets us check the output file tail when debugging. +--! +local function TClock_getTimeStamp() + local now = TClock_GetTimeNow() + local fraction_secs = now - math.floor(now) + return os.date('%c %Z',now) .. ':' .. fraction_secs +end + +--! \brief trims a string from both ends +local function TString_trim(Str) + return Str:match("^%s*(.-)%s*$") +end + +--! \brief split a string +--! +--! \param Str +--! \param Pattern +--! \returns table of string fragments +local function TString_split(Str, Pattern) + local splitStr = {} + local fpat = "(.-)" .. Pattern + local last_end = 1 + local str, e, cap = string.find(Str,fpat, 1) + while str do + if str ~= 1 or cap ~= "" then + table.insert(splitStr,cap) + end + last_end = e+1 + str, e, cap = string.find(Str,fpat, last_end) + end + if last_end <= #Str then + cap = string.sub(Str,last_end) + table.insert(splitStr, cap) + end + return splitStr +end + +--! \brief trim comment off end of string +--! +--! If the string has a comment on the end, this trims it off. +--! +local function TString_removeCommentFromLine(Line) + local pos_comment = string.find(Line,'%-%-') + if pos_comment then + Line = string.sub(Line,1,pos_comment-1) + end + return Line +end + +local TClassList_methods = {} +--! \brief get methods +local function TClassList_method_get(Klass) + return TClassList_methods[Klass] +end + +--! \brief add a method to list of known methods +local function TClassList_method_add(Klass,Method) + local classRec = TClassList_methods[Klass] + if not classRec then + TClassList_methods[Klass] = {} + classRec = TClassList_methods[Klass] + end + table.insert(classRec,Method) +end + + +local TCommentary_fh + +--! \brief write to output file +local function TCommentary_writeln(Str) + if TCommentary_fh then + TCommentary_fh:write(Str .. '\n') + end +end + +local TCommentary_fileID +--! \brief open the commentary save file +local function TCommentary_open(Filename,InputLuaFilename) + TCommentary_fileID = '"' .. InputLuaFilename .. '" : ' .. TClock_getTimeStamp() + TCommentary_fh = io.open(Filename,'a+') + if TCommentary_fh then + TCommentary_writeln('// opened:' .. TCommentary_fileID) + end +end + +--! \brief close the methods save file +local function TCommentary_close() + if TCommentary_fh then + TCommentary_writeln('// closed: ' .. TCommentary_fileID) + TCommentary_fh:close() + TCommentary_fh = nil + end +end + +--! \brief read stuff from save file +local function TCommentary_readFileContents(Filename) + if TOS_fileExists(Filename) then + local klass,method,dot + local cmd,colon + local k,v,equals + for line in io.lines(Filename) do + if string.sub(line,1,2)=='//' then + -- it's a comment + else + colon = string.find(line,':') + if colon then + cmd = string.sub(line,1,colon) + line = string.sub(line,colon+1) + else + cmd = nil + end + if (cmd == 'method:') then + dot = string.find(line,'%.') + klass = string.sub(line,1,dot-1) + method = string.sub(line,dot+1) + TClassList_method_add(klass,method) + elseif(cmd == 'set:') then + equals = string.find(line,'=') + if equals then + k = string.sub(line,1,equals-1) + v = string.sub(line,equals+1) + TConfig_set(k,v) + else + TConfig_set(line,true) + end + else -- ignore + TIO_write('/* bad command:"' .. line .. '" */') + end + end + end + else + TIO_write('/* file "' .. Filename .. '" don\'t exist */') + end +end + +--! \brief method to save file +local function TCommentary_addMethod(Klass,Method) + if TCommentary_fh then + if Klass and Method then + if string.find(Klass,'%.') or string.find(Method,'%.') then + -- iffy, so we discard it + else + TCommentary_writeln('method:' .. Klass .. '.' .. Method) + end + end + end +end + +--! \brief output line to stream +--! +--! Wraps IO_writeln() +local function TIO_out2stream(Line) + TIO_writeln(Line) +end + +--! \brief suppress line +local function TIO_out2stream_commented(Line,Prefix,Suffix) + local line = Line + if (not Prefix) then + Prefix='' + end + line = Prefix .. ':' .. line + + if (Suffix) then + line = line .. Suffix + end + TIO_out2stream('// D' .. line) +end + + +TCommandline_argv = {} +--! \brief setup/parse the commandline +local function TCommandline_setup() + local argv1 =arg[1] + if not argv1 then + argv1 = 'base' + end + TCommandline_argv_appname = argv1 + + local i=2 + local argvi=1 + while (argvi) do + argvi = arg[i] + if argvi then + TCommandline_argv[i-1] = argvi + i = i + 1 + end + end +end +--! setup the commandline now +TCommandline_setup() + +--! \brief get commandline args +local function TCommandline_getargv() + return TCommandline_argv +end + +--! \brief get appname +local function TApp_get_appname() + return TCommandline_argv_appname +end + +--! \brief hack converter from lua to a pseudoC-ish language for doxygen +--! +--! This is a hack to make lua readable to doxygen. +--! +--! It works well enough to document functions/methods and classes, but not assignments. +--! Our pseudo-C gets confused if we allow assginments to be shown. +--! Because these are less interesting than class/functions/methods I have decided to +--! live with this limitation. +--! +local function TApp_lua2dox(FileContents) + local err + local lines = FileContents + local maxi=#lines + + local i = 1 + local line,head + while not err and (i<=maxi) do + line = TString_trim(lines[i]) + if #line==0 then + TIO_out2stream() + elseif string.sub(line,1,2)=='--' then + -- it's a comment of some kind + if string.sub(line,1,3)=='--!' then + -- it's a magic comment + TIO_out2stream('//!' .. string.sub(line,4)) + elseif string.sub(line,1,4)=='--[[' then + -- it's a multiline comment + -- read lines to end of comment + local hitend + local comment = '' + line = string.sub(line,5) --.. sep + while not err and (i<maxi) and not hitend do + comment = comment .. line .. '\n' + line = lines[i+1] + --if (string.sub(TString_trim(line),1,2)==']]') then + if (string.find(line,'\]\]')) then + local pos_close = string.find(line,'\]\]') + comment = comment .. string.sub(line,1,pos_close-1) + hitend=true + end + i = i + 1 + end + -- got long comment + if string.sub(comment,1,1)=='!' then + TIO_out2stream('/*' .. comment .. '*/') + else + TIO_out2stream('/* (longcomment):' .. comment .. '*/') + end + else + -- it's a boring comment + TIO_out2stream_commented(line,'--') + end + elseif string.find(line,'^function%s') or string.find(line,'^local%s+function%s')then + -- "function wibble..." + -- it's a function declaration + -- ....v... + local pos_fn = string.find(line,'function') + if (pos_fn) then + local pos_local = string.find(line,'^local%s+function%s') + local fn = TString_removeCommentFromLine(TString_trim(string.sub(line,pos_fn+8))) + + if (string.sub(fn,1,1)=='(') then + -- anonymous function + TIO_out2stream_commented(line,'anon fn') + else + --[[ + we might have extracted a fn def with parameters on multilines + The hack is to insert a new close paren with a note to that effect. + ]] + + if not string.find(fn,'%)') then + fn = fn .. ' ___MissingCloseParenHere___)' + end + + local plain_fn_str = 'function ' .. fn .. '{}' + if pos_local then + plain_fn_str = 'local ' .. plain_fn_str + end + + local dot = string.find(fn,'%.') + if dot then -- it's a method + local klass = string.sub(fn,1,dot-1) + local method = string.sub(fn,dot+1) + local method_str = klass .. '::' .. method .. '{}' + TCommentary_addMethod(klass,method) + TIO_out2stream(method_str) + else + TIO_out2stream(plain_fn_str) + end + end + end + elseif string.find(line,'=%s+class%(') then + -- it's a class definition + line = TString_removeCommentFromLine(line) + local klass,parent,pos_class + -- ....v... + pos_class = string.find(line,'=%s+class%(') + klass = TString_trim(string.sub(line,1,pos_class-1)) + parent = TString_trim(string.sub(line,pos_class+8)) + parent = string.sub(parent,1,-2) + + line = 'class ' .. klass + if (#parent>0) then + line = line .. ' :public ' .. parent + end + + -- need methods list + local methods = TClassList_method_get(klass) + local methods_str + if methods then + methods_str = 'public: ' + for k,v in pairs(methods) do + methods_str = methods_str .. v .. ';' + end + else + methods_str = '/* no methods reported */' + end + line = line .. '{' .. methods_str .. '}' + + TIO_out2stream(line .. ';',true) + else + -- we don't know what this line means, so we can probably just comment it out + TIO_out2stream_commented(line) + end + + i = i + 1 + end + return err +end + +--! \brief run the filter +--! +--! \param AppTimestamp application + timestamp for this run +--! \param Filename the filename or if nil stdin +--! \param CommentaryFiles names of commentary files +--! \return err or nil +--! +local function TApp_run_filter(AppTimestamp,Filename,CommentaryFiles) + local err + local filecontents + if Filename then + -- syphon lines to our table + filecontents={} + for line in io.lines(Filename) do + table.insert(filecontents,line) + end + else + -- get stuff from stdin as a long string (with crlfs etc) + filecontents=io.read('*a') + -- make it a table of lines + filecontents = TString_split(filecontents,'[\n]') -- note this only works for unix files. + Filename = 'stdin' + end + + if filecontents then + TCommentary_readFileContents(CommentaryFiles.infile) + TCommentary_open(CommentaryFiles.outfile,Filename) + + err = TApp_lua2dox(filecontents) + + TCommentary_close() + + TIO_writeln('// done (' .. AppTimestamp .. ')') + else + err = TIO_showError(1,'couldn\'t find any file contents') + end + return err +end + +--! \brief run doxygen for one +--! +--! \param AppTimestamp application + timestamp for this run +--! \param Argv commandline for this run +--! \param CommentaryFiles names of commentary files +--! \return err or nil +--! +local function TApp_run_doxygen(AppTimestamp,Argv,CommentaryFiles) + local err + TIO_writeln('running: ' .. AppTimestamp) + + local argv1 = Argv[1] + if argv1=='--help' then + local appname = TApp_get_appname() + TIO_writeln('Syntax:') + TIO_writeln(' ' .. appname .. ' [[-g] [-s]] [<Doxyfile name>]|--help') + TIO_writeln(' --help show this text') + TIO_writeln(' -g: generate new Doxyfile') + TIO_writeln(' -s: generate new Doxyfile without comments') + TIO_writeln(' <Doxyfile name>: name of Doxyfile') + + TIO_writeln() + TIO_writeln(' For help on doxygen run its help system directly') + --! \todo more help here + else + local cl = 'doxygen' + for i,argv_i in ipairs(Argv) do + if i>=1 then -- don't want to use this app's name + cl = cl .. ' ' .. argv_i + end + end + + TIO_writeln('about to run "' .. cl .. '"') + err = TOS_system(cl) + + if not err then + -- cycle commentary files + local newComments=CommentaryFiles.outfile + local nextRunsComments=CommentaryFiles.infile + if TOS_fileExists(newComments) then + TIO_writeln('found outfile "' .. newComments .. '"') + os.remove(nextRunsComments) + TIO_writeln('mv "' .. newComments .. '"-> ' .. nextRunsComments .. '"') + os.rename(newComments,nextRunsComments) + end + end + end + return err +end + +-- main +local timestamp = TClock_getTimeStamp() +local appname = TApp_get_appname() +local version = '0.1 20120704' +local appTimestamp = appname .. '(v' .. version .. ') :' .. timestamp +local commentary_files = { + infile=TConfig_get('LUA2DOX_COMMENTARY_FILE_IN') + ,outfile=TConfig_get('LUA2DOX_COMMENTARY_FILE_OUT') + } + +if appname == 'lua2dox_filter' then + err = TApp_run_filter(appTimestamp,TCommandline_getargv()[1],commentary_files) + TIO_writeln('// do filter') +else + err = TApp_run_doxygen(appTimestamp,TCommandline_getargv(),commentary_files) +end + +--eof
\ No newline at end of file diff --git a/Master/texmf-dist/scripts/lua2dox/lua2dox_lua b/Master/texmf-dist/scripts/lua2dox/lua2dox_lua new file mode 100755 index 00000000000..822fed7bea1 --- /dev/null +++ b/Master/texmf-dist/scripts/lua2dox/lua2dox_lua @@ -0,0 +1,86 @@ +#!/bin/bash + +########################################################################### +# Copyright (C) 2012 by Simon Dales # +# simon@purrsoft.co.uk # +# # +# This program is free software; you can redistribute it and/or modify # +# it under the terms of the GNU General Public License as published by # +# the Free Software Foundation; either version 2 of the License, or # +# (at your option) any later version. # +# # +# This program is distributed in the hope that it will be useful, # +# but WITHOUT ANY WARRANTY; without even the implied warranty of # +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # +# GNU General Public License for more details. # +# # +# You should have received a copy of the GNU General Public License # +# along with this program; if not, write to the # +# Free Software Foundation, Inc., # +# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # +########################################################################### + +##! \brief test executable to see if it exists +test_executable(){ + P_EXE="$1" + ######### + WHICH=`which ${P_EXE}` + if test -z "${WHICH}" + then + echo "not found \"${P_EXE}\"" + else + EXE="${P_EXE}" + fi + } + +##! \brief sets the lua interpreter +set_lua(){ + test_executable 'texlua' + if test -z "${EXE}" + then + test_executable 'lua' + fi + #echo "final EXE=\"${EXE}\"" + } + +##! \brief makes canonical name of file +##! +##! Note that "readlink -f" doesn't work in MacOSX +##! +do_readlink(){ + pushd . > /dev/null + TARGET_FILE=$1 + + cd `dirname $TARGET_FILE` + TARGET_FILE=`basename $TARGET_FILE` + + # Iterate down a (possible) chain of symlinks + while [ -L "$TARGET_FILE" ] + do + TARGET_FILE=`readlink $TARGET_FILE` + cd `dirname $TARGET_FILE` + TARGET_FILE=`basename $TARGET_FILE` + done + + PHYS_DIR=`pwd -P` + RESULT=$PHYS_DIR + popd > /dev/null + } + +##main +set_lua +if test -z "${EXE}" +then + echo "no lua interpreter available" +else + BASENAME=`basename "$0"` + do_readlink "$0" + DIRNAME="${RESULT}" + + LUASCRIPT="${DIRNAME}/lua2dox.lua ${BASENAME}" + #echo "lua[${LUASCRIPT}]" + + ${EXE} ${LUASCRIPT} $@ +fi +# +##eof
\ No newline at end of file diff --git a/Master/tlpkg/bin/tlpkg-ctan-check b/Master/tlpkg/bin/tlpkg-ctan-check index 5f5d0877ac4..3db13c59fbf 100755 --- a/Master/tlpkg/bin/tlpkg-ctan-check +++ b/Master/tlpkg/bin/tlpkg-ctan-check @@ -248,7 +248,8 @@ my @TLP_working = qw( lshort-slovenian lshort-spanish lshort-thai lshort-turkish lshort-ukr lshort-vietnamese lstaddons ltabptch ltxdockit ltxindex ltxkeys ltxmisc ltxnew ltxtools - lua-alt-getopt lua-check-hyphen lua-visual-debug luabibentry luacode + lua-alt-getopt lua-check-hyphen lua-visual-debug + lua2dox luabibentry luacode luaindex luainputenc lualatex-doc lualatex-math lualibs luamplib luaotfload luapersian luasseq luatexbase luatexja luatextra lxfonts ly1 diff --git a/Master/tlpkg/libexec/ctan2tds b/Master/tlpkg/libexec/ctan2tds index 0c20d0d8c34..d49e7e7174d 100755 --- a/Master/tlpkg/libexec/ctan2tds +++ b/Master/tlpkg/libexec/ctan2tds @@ -1293,6 +1293,7 @@ $standardtex='\.(.bx|cfg|sty|clo|ldf|cls|def|fd|cmap|4ht)$'; 'logic', 'milstd\.tex|' . $standardtex, 'ltxkeys', '\.sty|\.clo|\.ldf|\.cls|\.def|\.fd$', # not cfg 'lua-visual-debug', '\.lua|' . $standardtex, + 'lua2dox', 'NULL', # .def is lua code 'lualatex-math', '\.sty', # not phst-doc.cls 'magyar', 'NULL', # do not install in runtime, conflicts with babel 'manjutex', '\.sty|\.clo|\.ldf|\.cls|\.def|\.fd$|manju.tex', @@ -1564,6 +1565,7 @@ $standardtex='\.(.bx|cfg|sty|clo|ldf|cls|def|fd|cmap|4ht)$'; 'lh', 'fonts', 'latex-notes-zh-cn', 'generic', 'lua-alt-getopt', 'support', + 'lua2dox', 'support', 'luatexja', 'luatex', 'marvosym', 'fonts', 'mathabx', 'fonts', @@ -2161,6 +2163,7 @@ $standardxmt='\.xmt'; %specialscripts_nobin = ( 'epspdf' => '(epspdf(|\.help|boot|tk)|\.rb|makegray\.pro)$', 'lua-alt-getopt' => '\.lua$', + 'lua2dox' => '\.(lua|def)$', 'luaindex' => '\.lua$', 'lualatex-math' => '\.lua$', 'luasseq' => '\.lua$', @@ -2196,6 +2199,7 @@ $standardxmt='\.xmt'; 'latexpand' => 'latexpand$', 'listbib' => 'listbib$', 'listings-ext' => '\.sh$', + 'lua2dox' => 'lua2dox_lua$', # doscripts() does _filter 'match_parens' => '^match_parens$', 'mathspic' => '^mathspic\.pl$', 'mf2pt1' => '\.pl$', @@ -2836,42 +2840,44 @@ sub dotype1{ # scripts. Make them executable even if it isn't always necessary. # Build/source/tex/texlive/linked_scripts/Makefile.am installs symlinks # in the bin directories where needed. That Makefile is independently -# maintained, needs to be updated by hand when new user-visible scripts +# maintained, and needs to be updated by hand when new user-visible scripts # are added. We add/update the script itself under linked_scripts. # We also make the symlinks/w32-wrapper-copy in Master/bin. # sub doscripts { my $pwd = getcwd(); - # first do the ones that don't go in the bindirs. - my $scriptpatt = $specialscripts_nobin{$package}; + my $build_tldir = "texk/texlive"; + my $build_scriptsdir = "$build_tldir/linked_scripts"; + my $builddir = "$BUILDDEST/$build_scriptsdir/$package"; + + # first do the user-visible bindir entries. + $scriptpatt = $specialscripts_bin{$package}; if ($scriptpatt) { if ($pwd ne "$DEST/scripts/$package") { # in the .tds.zip case, we will already be in the scripts dir. &install ("$DEST/scripts/$package", $scriptpatt); &SYSTEM ("chmod a+x $DEST/scripts/$package/*"); } - } - # now the user-visible bindir entries. Duplicating above, sorry. - $scriptpatt = $specialscripts_bin{$package}; - return unless $scriptpatt; + # update the copy in Build (the reason we do the bindir ones first). + &xmkdir ($builddir); + &SYSTEM ("$CP $DEST/scripts/$package/* $builddir/"); + } - if ($pwd ne "$DEST/scripts/$package") { - # in the .tds.zip case, we will already be in the scripts dir. - &install ("$DEST/scripts/$package", $scriptpatt); - &SYSTEM ("chmod a+x $DEST/scripts/$package/*"); + # then do the ones that go only under scripts/ and not in the bindirs. + my $nobin_scriptpatt = $specialscripts_nobin{$package}; + if ($nobin_scriptpatt) { + if ($pwd ne "$DEST/scripts/$package") { + # in the .tds.zip case, we will already be in the scripts dir. + &install ("$DEST/scripts/$package", $nobin_scriptpatt); + &SYSTEM ("chmod a+x $DEST/scripts/$package/*"); + } } - # update the copy in Build, too. - my $build_tldir = "texk/texlive"; - my $build_scriptsdir = "$build_tldir/linked_scripts"; - my $builddir = "$BUILDDEST/$build_scriptsdir/$package"; - &xmkdir ($builddir); - &SYSTEM ("$CP $DEST/scripts/$package/* $builddir/"); - - # List of scripts we're installing. + # List of scripts we just copied in for installing in the bindirs. chomp (my @scripts = `cd $builddir && ls`); + return unless @scripts; # For each, give a warning if missing from the Makefile.am in the sources. # Also, if not already present, create the platform-specific bindir entries. @@ -2892,13 +2898,18 @@ sub doscripts { if ($p ne "win32") { my $linktarget = "../../$DEST_TREE/scripts/$package/$s"; &SYSTEM ("ln -s $linktarget $platdir/$linkname"); + # + # Scripts with special cases. &SYSTEM ("ln -s $linkname $platdir/r$linkname") if $linkname =~ /pdfcrop|epstopdf/; # rpdfcrop -> pdfcrop + &SYSTEM ("ln -s $linkname $platdir/lua2dox_filter") + if $linkname =~ /lua2dox_lua/; } else { # Windows. If a shell script, skip. Else copy the wrapper. - next if $s =~ /\.sh$/; + next if $s =~ /\.sh$|lua2dox/; my $w32_wrapper = "$Build/$build_tldir/w32_wrapper/runscript.exe"; &SYSTEM ("$CP $w32_wrapper $platdir/$linkname.exe"); + # &SYSTEM ("$CP $w32_wrapper $platdir/r$linkname.exe") if $linkname =~ /pdfcrop|epstopdf/; # rpdfcrop.exe } diff --git a/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc b/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc index 8c565a37a4f..ddaf405f81d 100644 --- a/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc +++ b/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc @@ -9,6 +9,7 @@ depend checkcites depend chickenize depend interpreter depend lua-visual-debug +depend lua2dox depend luabibentry depend luacode depend luaindex diff --git a/Master/tlpkg/tlpsrc/lua2dox.tlpsrc b/Master/tlpkg/tlpsrc/lua2dox.tlpsrc new file mode 100644 index 00000000000..9a845a9d030 --- /dev/null +++ b/Master/tlpkg/tlpsrc/lua2dox.tlpsrc @@ -0,0 +1,2 @@ +binpattern f bin/${ARCH}/lua2dox_lua +binpattern f bin/${ARCH}/lua2dox_filter |
