From 532e95c1171566e596e733b2f12b60263d3773db Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 8 Feb 2013 00:38:37 +0000 Subject: lua2dox 0.2 (7feb13) git-svn-id: svn://tug.org/texlive/trunk@29053 c570f23f-e606-0410-a88d-b1316a301751 --- Master/bin/alpha-linux/lua2dox_filter | 2 +- Master/bin/alpha-linux/lua2dox_lua | 1 - Master/bin/amd64-freebsd/lua2dox_filter | 2 +- Master/bin/amd64-freebsd/lua2dox_lua | 1 - Master/bin/amd64-kfreebsd/lua2dox_filter | 2 +- Master/bin/amd64-kfreebsd/lua2dox_lua | 1 - Master/bin/armel-linux/lua2dox_filter | 2 +- Master/bin/armel-linux/lua2dox_lua | 1 - Master/bin/i386-cygwin/lua2dox_filter | 2 +- Master/bin/i386-cygwin/lua2dox_lua | 1 - Master/bin/i386-freebsd/lua2dox_filter | 2 +- Master/bin/i386-freebsd/lua2dox_lua | 1 - Master/bin/i386-kfreebsd/lua2dox_filter | 2 +- Master/bin/i386-kfreebsd/lua2dox_lua | 1 - Master/bin/i386-linux/lua2dox_filter | 2 +- Master/bin/i386-linux/lua2dox_lua | 1 - Master/bin/i386-solaris/lua2dox_filter | 2 +- Master/bin/i386-solaris/lua2dox_lua | 1 - Master/bin/mipsel-linux/lua2dox_filter | 2 +- Master/bin/mipsel-linux/lua2dox_lua | 1 - Master/bin/powerpc-aix/lua2dox_filter | 2 +- Master/bin/powerpc-aix/lua2dox_lua | 1 - Master/bin/powerpc-linux/lua2dox_filter | 2 +- Master/bin/powerpc-linux/lua2dox_lua | 1 - Master/bin/sparc-solaris/lua2dox_filter | 2 +- Master/bin/sparc-solaris/lua2dox_lua | 1 - Master/bin/universal-darwin/lua2dox_filter | 2 +- Master/bin/universal-darwin/lua2dox_lua | 1 - Master/bin/win32/lua2dox_filter.bat | 69 + Master/bin/x86_64-darwin/lua2dox_filter | 2 +- Master/bin/x86_64-darwin/lua2dox_lua | 1 - Master/bin/x86_64-linux/lua2dox_filter | 2 +- Master/bin/x86_64-linux/lua2dox_lua | 1 - Master/bin/x86_64-solaris/lua2dox_filter | 2 +- Master/bin/x86_64-solaris/lua2dox_lua | 1 - Master/texmf-dist/doc/support/lua2dox/ChangeLog | 17 + Master/texmf-dist/doc/support/lua2dox/Doxyfile | 1723 ++++++++++++-------- Master/texmf-dist/doc/support/lua2dox/INSTALL | 42 - .../doc/support/lua2dox/docs/html/annotated.html | 67 + .../doc/support/lua2dox/docs/html/bc_s.png | Bin 0 -> 676 bytes .../doc/support/lua2dox/docs/html/bdwn.png | Bin 0 -> 147 bytes .../lua2dox/docs/html/classTApp-members.html | 63 + .../doc/support/lua2dox/docs/html/classTApp.html | 157 ++ .../docs/html/classTCore__Clock-members.html | 62 + .../lua2dox/docs/html/classTCore__Clock.html | 162 ++ .../docs/html/classTCore__Commandline-members.html | 61 + .../lua2dox/docs/html/classTCore__Commandline.html | 136 ++ .../support/lua2dox/docs/html/classTCore__IO.html | 67 + .../docs/html/classTLua2DoX__filter-members.html | 61 + .../lua2dox/docs/html/classTLua2DoX__filter.html | 158 ++ .../docs/html/classTStream__Read-members.html | 64 + .../lua2dox/docs/html/classTStream__Read.html | 216 +++ .../docs/html/classTStream__Write-members.html | 65 + .../lua2dox/docs/html/classTStream__Write.html | 252 +++ .../doc/support/lua2dox/docs/html/classes.html | 65 + .../doc/support/lua2dox/docs/html/closed.png | Bin 0 -> 132 bytes .../doc/support/lua2dox/docs/html/doxygen.css | 1425 +++++++++++----- .../doc/support/lua2dox/docs/html/doxygen.png | Bin 1281 -> 3779 bytes .../doc/support/lua2dox/docs/html/dynsections.js | 78 + .../doc/support/lua2dox/docs/html/files.html | 74 +- .../doc/support/lua2dox/docs/html/ftv2blank.png | Bin 0 -> 86 bytes .../doc/support/lua2dox/docs/html/ftv2cl.png | Bin 0 -> 453 bytes .../doc/support/lua2dox/docs/html/ftv2doc.png | Bin 0 -> 746 bytes .../support/lua2dox/docs/html/ftv2folderclosed.png | Bin 0 -> 616 bytes .../support/lua2dox/docs/html/ftv2folderopen.png | Bin 0 -> 597 bytes .../doc/support/lua2dox/docs/html/ftv2lastnode.png | Bin 0 -> 86 bytes .../doc/support/lua2dox/docs/html/ftv2link.png | Bin 0 -> 746 bytes .../support/lua2dox/docs/html/ftv2mlastnode.png | Bin 0 -> 246 bytes .../doc/support/lua2dox/docs/html/ftv2mnode.png | Bin 0 -> 246 bytes .../doc/support/lua2dox/docs/html/ftv2mo.png | Bin 0 -> 403 bytes .../doc/support/lua2dox/docs/html/ftv2node.png | Bin 0 -> 86 bytes .../doc/support/lua2dox/docs/html/ftv2ns.png | Bin 0 -> 388 bytes .../support/lua2dox/docs/html/ftv2plastnode.png | Bin 0 -> 229 bytes .../doc/support/lua2dox/docs/html/ftv2pnode.png | Bin 0 -> 229 bytes .../doc/support/lua2dox/docs/html/ftv2splitbar.png | Bin 0 -> 314 bytes .../doc/support/lua2dox/docs/html/ftv2vertline.png | Bin 0 -> 86 bytes .../doc/support/lua2dox/docs/html/functions.html | 120 ++ .../support/lua2dox/docs/html/functions_func.html | 120 ++ .../doc/support/lua2dox/docs/html/globals.html | 148 +- .../support/lua2dox/docs/html/globals_func.html | 148 +- .../doc/support/lua2dox/docs/html/index.html | 115 +- .../doc/support/lua2dox/docs/html/jquery.js | 8 + .../lua2dox/docs/html/lua2dox_8lua-source.html | 638 -------- .../support/lua2dox/docs/html/lua2dox_8lua.html | 970 +++-------- .../lua2dox/docs/html/lua2dox_8lua_source.html | 719 ++++++++ .../doc/support/lua2dox/docs/html/nav_f.png | Bin 0 -> 153 bytes .../doc/support/lua2dox/docs/html/nav_g.png | Bin 0 -> 95 bytes .../doc/support/lua2dox/docs/html/nav_h.png | Bin 0 -> 98 bytes .../doc/support/lua2dox/docs/html/open.png | Bin 0 -> 123 bytes .../doc/support/lua2dox/docs/html/sync_off.png | Bin 0 -> 853 bytes .../doc/support/lua2dox/docs/html/sync_on.png | Bin 0 -> 845 bytes .../doc/support/lua2dox/docs/html/tab_a.png | Bin 0 -> 142 bytes .../doc/support/lua2dox/docs/html/tab_b.gif | Bin 35 -> 0 bytes .../doc/support/lua2dox/docs/html/tab_b.png | Bin 0 -> 170 bytes .../doc/support/lua2dox/docs/html/tab_h.png | Bin 0 -> 177 bytes .../doc/support/lua2dox/docs/html/tab_l.gif | Bin 706 -> 0 bytes .../doc/support/lua2dox/docs/html/tab_r.gif | Bin 2585 -> 0 bytes .../doc/support/lua2dox/docs/html/tab_s.png | Bin 0 -> 184 bytes .../doc/support/lua2dox/docs/html/tabs.css | 130 +- .../doc/support/lua2dox/examples/lua/Doxyfile | 1705 +++++++++++-------- .../doc/support/lua2dox/examples/lua/class.lua | 2 +- .../lua/docs/html/animals_8lua-source.html | 141 -- .../examples/lua/docs/html/animals_8lua.html | 184 ++- .../lua/docs/html/animals_8lua_source.html | 176 ++ .../lua2dox/examples/lua/docs/html/annotated.html | 85 +- .../lua2dox/examples/lua/docs/html/bc_s.png | Bin 0 -> 676 bytes .../lua2dox/examples/lua/docs/html/bdwn.png | Bin 0 -> 147 bytes .../lua/docs/html/classAnimal-members.html | 77 +- .../examples/lua/docs/html/classAnimal.html | 201 +-- .../lua2dox/examples/lua/docs/html/classAnimal.png | Bin 733 -> 1001 bytes .../examples/lua/docs/html/classBird-members.html | 77 +- .../lua2dox/examples/lua/docs/html/classBird.html | 152 +- .../lua2dox/examples/lua/docs/html/classBird.png | Bin 498 -> 644 bytes .../examples/lua/docs/html/classCat-members.html | 77 +- .../lua2dox/examples/lua/docs/html/classCat.html | 152 +- .../lua2dox/examples/lua/docs/html/classCat.png | Bin 346 -> 464 bytes .../examples/lua/docs/html/classDog-members.html | 77 +- .../lua2dox/examples/lua/docs/html/classDog.html | 152 +- .../lua2dox/examples/lua/docs/html/classDog.png | Bin 351 -> 465 bytes .../lua/docs/html/classMammal-members.html | 77 +- .../examples/lua/docs/html/classMammal.html | 152 +- .../lua2dox/examples/lua/docs/html/classMammal.png | Bin 461 -> 631 bytes .../lua/docs/html/classPigeon-members.html | 77 +- .../examples/lua/docs/html/classPigeon.html | 152 +- .../lua2dox/examples/lua/docs/html/classPigeon.png | Bin 343 -> 413 bytes .../lua/docs/html/classRedKite-members.html | 77 +- .../examples/lua/docs/html/classRedKite.html | 152 +- .../examples/lua/docs/html/classRedKite.png | Bin 354 -> 464 bytes .../examples/lua/docs/html/class_8lua-source.html | 106 -- .../lua2dox/examples/lua/docs/html/class_8lua.html | 126 +- .../examples/lua/docs/html/class_8lua_source.html | 141 ++ .../lua2dox/examples/lua/docs/html/classes.html | 75 + .../lua2dox/examples/lua/docs/html/closed.png | Bin 0 -> 132 bytes .../lua2dox/examples/lua/docs/html/doxygen.css | 1425 +++++++++++----- .../lua2dox/examples/lua/docs/html/doxygen.png | Bin 1281 -> 3779 bytes .../lua2dox/examples/lua/docs/html/dynsections.js | 78 + .../lua2dox/examples/lua/docs/html/files.html | 77 +- .../lua2dox/examples/lua/docs/html/ftv2blank.png | Bin 0 -> 86 bytes .../lua2dox/examples/lua/docs/html/ftv2cl.png | Bin 0 -> 453 bytes .../lua2dox/examples/lua/docs/html/ftv2doc.png | Bin 0 -> 746 bytes .../examples/lua/docs/html/ftv2folderclosed.png | Bin 0 -> 616 bytes .../examples/lua/docs/html/ftv2folderopen.png | Bin 0 -> 597 bytes .../examples/lua/docs/html/ftv2lastnode.png | Bin 0 -> 86 bytes .../lua2dox/examples/lua/docs/html/ftv2link.png | Bin 0 -> 746 bytes .../examples/lua/docs/html/ftv2mlastnode.png | Bin 0 -> 246 bytes .../lua2dox/examples/lua/docs/html/ftv2mnode.png | Bin 0 -> 246 bytes .../lua2dox/examples/lua/docs/html/ftv2mo.png | Bin 0 -> 403 bytes .../lua2dox/examples/lua/docs/html/ftv2node.png | Bin 0 -> 86 bytes .../lua2dox/examples/lua/docs/html/ftv2ns.png | Bin 0 -> 388 bytes .../examples/lua/docs/html/ftv2plastnode.png | Bin 0 -> 229 bytes .../lua2dox/examples/lua/docs/html/ftv2pnode.png | Bin 0 -> 229 bytes .../examples/lua/docs/html/ftv2splitbar.png | Bin 0 -> 314 bytes .../examples/lua/docs/html/ftv2vertline.png | Bin 0 -> 86 bytes .../lua2dox/examples/lua/docs/html/functions.html | 92 +- .../examples/lua/docs/html/functions_func.html | 92 +- .../lua2dox/examples/lua/docs/html/globals.html | 80 +- .../examples/lua/docs/html/globals_func.html | 80 +- .../lua2dox/examples/lua/docs/html/hierarchy.html | 95 +- .../lua2dox/examples/lua/docs/html/index.html | 60 +- .../lua2dox/examples/lua/docs/html/jquery.js | 8 + .../examples/lua/docs/html/main_8lua-source.html | 63 - .../lua2dox/examples/lua/docs/html/main_8lua.html | 80 +- .../examples/lua/docs/html/main_8lua_source.html | 98 ++ .../lua2dox/examples/lua/docs/html/nav_f.png | Bin 0 -> 153 bytes .../lua2dox/examples/lua/docs/html/nav_g.png | Bin 0 -> 95 bytes .../lua2dox/examples/lua/docs/html/nav_h.png | Bin 0 -> 98 bytes .../lua2dox/examples/lua/docs/html/open.png | Bin 0 -> 123 bytes .../lua2dox/examples/lua/docs/html/sync_off.png | Bin 0 -> 853 bytes .../lua2dox/examples/lua/docs/html/sync_on.png | Bin 0 -> 845 bytes .../lua2dox/examples/lua/docs/html/tab_a.png | Bin 0 -> 142 bytes .../lua2dox/examples/lua/docs/html/tab_b.gif | Bin 35 -> 0 bytes .../lua2dox/examples/lua/docs/html/tab_b.png | Bin 0 -> 170 bytes .../lua2dox/examples/lua/docs/html/tab_h.png | Bin 0 -> 177 bytes .../lua2dox/examples/lua/docs/html/tab_l.gif | Bin 706 -> 0 bytes .../lua2dox/examples/lua/docs/html/tab_r.gif | Bin 2585 -> 0 bytes .../lua2dox/examples/lua/docs/html/tab_s.png | Bin 0 -> 184 bytes .../lua2dox/examples/lua/docs/html/tabs.css | 130 +- .../doc/support/lua2dox/examples/php/Doxyfile | 1705 +++++++++++-------- .../php/docs/html/animals_8php-source.html | 104 -- .../examples/php/docs/html/animals_8php.html | 187 ++- .../php/docs/html/animals_8php_source.html | 139 ++ .../lua2dox/examples/php/docs/html/annotated.html | 85 +- .../lua2dox/examples/php/docs/html/bc_s.png | Bin 0 -> 676 bytes .../lua2dox/examples/php/docs/html/bdwn.png | Bin 0 -> 147 bytes .../php/docs/html/classAnimal-members.html | 77 +- .../examples/php/docs/html/classAnimal.html | 189 ++- .../lua2dox/examples/php/docs/html/classAnimal.png | Bin 733 -> 1001 bytes .../examples/php/docs/html/classBird-members.html | 79 +- .../lua2dox/examples/php/docs/html/classBird.html | 142 +- .../lua2dox/examples/php/docs/html/classBird.png | Bin 498 -> 644 bytes .../examples/php/docs/html/classCat-members.html | 79 +- .../lua2dox/examples/php/docs/html/classCat.html | 133 +- .../lua2dox/examples/php/docs/html/classCat.png | Bin 346 -> 464 bytes .../examples/php/docs/html/classDog-members.html | 79 +- .../lua2dox/examples/php/docs/html/classDog.html | 133 +- .../lua2dox/examples/php/docs/html/classDog.png | Bin 351 -> 465 bytes .../php/docs/html/classMammal-members.html | 77 +- .../examples/php/docs/html/classMammal.html | 117 +- .../lua2dox/examples/php/docs/html/classMammal.png | Bin 461 -> 631 bytes .../php/docs/html/classPigeon-members.html | 81 +- .../examples/php/docs/html/classPigeon.html | 143 +- .../lua2dox/examples/php/docs/html/classPigeon.png | Bin 343 -> 413 bytes .../php/docs/html/classRedKite-members.html | 81 +- .../examples/php/docs/html/classRedKite.html | 143 +- .../examples/php/docs/html/classRedKite.png | Bin 354 -> 464 bytes .../lua2dox/examples/php/docs/html/classes.html | 75 + .../lua2dox/examples/php/docs/html/closed.png | Bin 0 -> 132 bytes .../lua2dox/examples/php/docs/html/doxygen.css | 1425 +++++++++++----- .../lua2dox/examples/php/docs/html/doxygen.png | Bin 1281 -> 3779 bytes .../lua2dox/examples/php/docs/html/dynsections.js | 78 + .../lua2dox/examples/php/docs/html/files.html | 75 +- .../lua2dox/examples/php/docs/html/ftv2blank.png | Bin 0 -> 86 bytes .../lua2dox/examples/php/docs/html/ftv2cl.png | Bin 0 -> 453 bytes .../lua2dox/examples/php/docs/html/ftv2doc.png | Bin 0 -> 746 bytes .../examples/php/docs/html/ftv2folderclosed.png | Bin 0 -> 616 bytes .../examples/php/docs/html/ftv2folderopen.png | Bin 0 -> 597 bytes .../examples/php/docs/html/ftv2lastnode.png | Bin 0 -> 86 bytes .../lua2dox/examples/php/docs/html/ftv2link.png | Bin 0 -> 746 bytes .../examples/php/docs/html/ftv2mlastnode.png | Bin 0 -> 246 bytes .../lua2dox/examples/php/docs/html/ftv2mnode.png | Bin 0 -> 246 bytes .../lua2dox/examples/php/docs/html/ftv2mo.png | Bin 0 -> 403 bytes .../lua2dox/examples/php/docs/html/ftv2node.png | Bin 0 -> 86 bytes .../lua2dox/examples/php/docs/html/ftv2ns.png | Bin 0 -> 388 bytes .../examples/php/docs/html/ftv2plastnode.png | Bin 0 -> 229 bytes .../lua2dox/examples/php/docs/html/ftv2pnode.png | Bin 0 -> 229 bytes .../examples/php/docs/html/ftv2splitbar.png | Bin 0 -> 314 bytes .../examples/php/docs/html/ftv2vertline.png | Bin 0 -> 86 bytes .../lua2dox/examples/php/docs/html/functions.html | 95 +- .../examples/php/docs/html/functions_func.html | 95 +- .../lua2dox/examples/php/docs/html/globals.html | 80 +- .../examples/php/docs/html/globals_func.html | 77 +- .../examples/php/docs/html/globals_vars.html | 74 +- .../lua2dox/examples/php/docs/html/hierarchy.html | 95 +- .../lua2dox/examples/php/docs/html/index.html | 60 +- .../lua2dox/examples/php/docs/html/jquery.js | 8 + .../examples/php/docs/html/main_8php-source.html | 51 - .../lua2dox/examples/php/docs/html/main_8php.html | 116 +- .../examples/php/docs/html/main_8php_source.html | 86 + .../lua2dox/examples/php/docs/html/nav_f.png | Bin 0 -> 153 bytes .../lua2dox/examples/php/docs/html/nav_g.png | Bin 0 -> 95 bytes .../lua2dox/examples/php/docs/html/nav_h.png | Bin 0 -> 98 bytes .../lua2dox/examples/php/docs/html/open.png | Bin 0 -> 123 bytes .../lua2dox/examples/php/docs/html/sync_off.png | Bin 0 -> 853 bytes .../lua2dox/examples/php/docs/html/sync_on.png | Bin 0 -> 845 bytes .../lua2dox/examples/php/docs/html/tab_a.png | Bin 0 -> 142 bytes .../lua2dox/examples/php/docs/html/tab_b.gif | Bin 35 -> 0 bytes .../lua2dox/examples/php/docs/html/tab_b.png | Bin 0 -> 170 bytes .../lua2dox/examples/php/docs/html/tab_h.png | Bin 0 -> 177 bytes .../lua2dox/examples/php/docs/html/tab_l.gif | Bin 706 -> 0 bytes .../lua2dox/examples/php/docs/html/tab_r.gif | Bin 2585 -> 0 bytes .../lua2dox/examples/php/docs/html/tab_s.png | Bin 0 -> 184 bytes .../lua2dox/examples/php/docs/html/tabs.css | 130 +- Master/texmf-dist/doc/support/lua2dox/install.bat | 41 + Master/texmf-dist/doc/support/lua2dox/install.sh | 5 +- .../doc/support/lua2dox/lua2dox-refm.pdf | Bin 389213 -> 401749 bytes .../doc/support/lua2dox/lua2dox-refm.tex | 131 +- Master/texmf-dist/scripts/lua2dox/lua2dox.lua | 973 +++++------ Master/texmf-dist/scripts/lua2dox/lua2dox_filter | 86 + Master/texmf-dist/scripts/lua2dox/lua2dox_lua | 86 - Master/tlpkg/libexec/ctan2tds | 18 +- Master/tlpkg/tlpsrc/lua2dox.tlpsrc | 1 - 261 files changed, 14822 insertions(+), 8014 deletions(-) delete mode 120000 Master/bin/alpha-linux/lua2dox_lua delete mode 120000 Master/bin/amd64-freebsd/lua2dox_lua delete mode 120000 Master/bin/amd64-kfreebsd/lua2dox_lua delete mode 120000 Master/bin/armel-linux/lua2dox_lua delete mode 120000 Master/bin/i386-cygwin/lua2dox_lua delete mode 120000 Master/bin/i386-freebsd/lua2dox_lua delete mode 120000 Master/bin/i386-kfreebsd/lua2dox_lua delete mode 120000 Master/bin/i386-linux/lua2dox_lua delete mode 120000 Master/bin/i386-solaris/lua2dox_lua delete mode 120000 Master/bin/mipsel-linux/lua2dox_lua delete mode 120000 Master/bin/powerpc-aix/lua2dox_lua delete mode 120000 Master/bin/powerpc-linux/lua2dox_lua delete mode 120000 Master/bin/sparc-solaris/lua2dox_lua delete mode 120000 Master/bin/universal-darwin/lua2dox_lua create mode 100755 Master/bin/win32/lua2dox_filter.bat delete mode 120000 Master/bin/x86_64-darwin/lua2dox_lua delete mode 120000 Master/bin/x86_64-linux/lua2dox_lua delete mode 120000 Master/bin/x86_64-solaris/lua2dox_lua create mode 100644 Master/texmf-dist/doc/support/lua2dox/ChangeLog delete mode 100644 Master/texmf-dist/doc/support/lua2dox/INSTALL create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/annotated.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/bc_s.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/bdwn.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/classTApp-members.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/classTApp.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Clock-members.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Clock.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Commandline-members.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Commandline.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__IO.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/classTLua2DoX__filter-members.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/classTLua2DoX__filter.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Read-members.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Read.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Write-members.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Write.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/classes.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/closed.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/dynsections.js create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2blank.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2cl.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2doc.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2folderclosed.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2folderopen.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2lastnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2link.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2mlastnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2mnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2mo.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2node.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2ns.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2plastnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2pnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2splitbar.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2vertline.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/functions.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/functions_func.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/jquery.js delete mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua-source.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua_source.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/nav_f.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/nav_g.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/nav_h.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/open.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/sync_off.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/sync_on.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/tab_a.png delete mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/tab_b.gif create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/tab_b.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/tab_h.png delete mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/tab_l.gif delete mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/tab_r.gif create mode 100644 Master/texmf-dist/doc/support/lua2dox/docs/html/tab_s.png delete mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/animals_8lua-source.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/animals_8lua_source.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/bc_s.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/bdwn.png delete mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/class_8lua-source.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/class_8lua_source.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/classes.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/closed.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/dynsections.js create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2blank.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2cl.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2doc.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2folderclosed.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2folderopen.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2lastnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2link.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2mlastnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2mnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2mo.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2node.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2ns.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2plastnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2pnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2splitbar.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/ftv2vertline.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/jquery.js delete mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/main_8lua-source.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/main_8lua_source.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/nav_f.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/nav_g.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/nav_h.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/open.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/sync_off.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/sync_on.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_a.png delete mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_b.gif create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_b.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_h.png delete mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_l.gif delete mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_r.gif create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/tab_s.png delete mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/animals_8php-source.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/animals_8php_source.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/bc_s.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/bdwn.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/classes.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/closed.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/dynsections.js create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2blank.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2cl.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2doc.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2folderclosed.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2folderopen.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2lastnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2link.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2mlastnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2mnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2mo.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2node.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2ns.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2plastnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2pnode.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2splitbar.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/ftv2vertline.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/jquery.js delete mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/main_8php-source.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/main_8php_source.html create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/nav_f.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/nav_g.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/nav_h.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/open.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/sync_off.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/sync_on.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_a.png delete mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_b.gif create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_b.png create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_h.png delete mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_l.gif delete mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_r.gif create mode 100644 Master/texmf-dist/doc/support/lua2dox/examples/php/docs/html/tab_s.png create mode 100755 Master/texmf-dist/doc/support/lua2dox/install.bat create mode 100755 Master/texmf-dist/scripts/lua2dox/lua2dox_filter delete mode 100755 Master/texmf-dist/scripts/lua2dox/lua2dox_lua (limited to 'Master') diff --git a/Master/bin/alpha-linux/lua2dox_filter b/Master/bin/alpha-linux/lua2dox_filter index 813f7749250..545465ae6a2 120000 --- a/Master/bin/alpha-linux/lua2dox_filter +++ b/Master/bin/alpha-linux/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/alpha-linux/lua2dox_lua b/Master/bin/alpha-linux/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/alpha-linux/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/amd64-freebsd/lua2dox_filter +++ b/Master/bin/amd64-freebsd/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/amd64-freebsd/lua2dox_lua b/Master/bin/amd64-freebsd/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/amd64-freebsd/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/amd64-kfreebsd/lua2dox_filter +++ b/Master/bin/amd64-kfreebsd/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/amd64-kfreebsd/lua2dox_lua b/Master/bin/amd64-kfreebsd/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/amd64-kfreebsd/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/armel-linux/lua2dox_filter +++ b/Master/bin/armel-linux/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/armel-linux/lua2dox_lua b/Master/bin/armel-linux/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/armel-linux/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/i386-cygwin/lua2dox_filter +++ b/Master/bin/i386-cygwin/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/i386-cygwin/lua2dox_lua b/Master/bin/i386-cygwin/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/i386-cygwin/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/i386-freebsd/lua2dox_filter +++ b/Master/bin/i386-freebsd/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/i386-freebsd/lua2dox_lua b/Master/bin/i386-freebsd/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/i386-freebsd/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/i386-kfreebsd/lua2dox_filter +++ b/Master/bin/i386-kfreebsd/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/i386-kfreebsd/lua2dox_lua b/Master/bin/i386-kfreebsd/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/i386-kfreebsd/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/i386-linux/lua2dox_filter +++ b/Master/bin/i386-linux/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/i386-linux/lua2dox_lua b/Master/bin/i386-linux/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/i386-linux/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/i386-solaris/lua2dox_filter +++ b/Master/bin/i386-solaris/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/i386-solaris/lua2dox_lua b/Master/bin/i386-solaris/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/i386-solaris/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/mipsel-linux/lua2dox_filter +++ b/Master/bin/mipsel-linux/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/mipsel-linux/lua2dox_lua b/Master/bin/mipsel-linux/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/mipsel-linux/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/powerpc-aix/lua2dox_filter +++ b/Master/bin/powerpc-aix/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/powerpc-aix/lua2dox_lua b/Master/bin/powerpc-aix/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/powerpc-aix/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/powerpc-linux/lua2dox_filter +++ b/Master/bin/powerpc-linux/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/powerpc-linux/lua2dox_lua b/Master/bin/powerpc-linux/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/powerpc-linux/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/sparc-solaris/lua2dox_filter +++ b/Master/bin/sparc-solaris/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/sparc-solaris/lua2dox_lua b/Master/bin/sparc-solaris/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/sparc-solaris/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/universal-darwin/lua2dox_filter +++ b/Master/bin/universal-darwin/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/universal-darwin/lua2dox_lua b/Master/bin/universal-darwin/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/universal-darwin/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../texmf-dist/scripts/lua2dox/lua2dox_lua \ No newline at end of file diff --git a/Master/bin/win32/lua2dox_filter.bat b/Master/bin/win32/lua2dox_filter.bat new file mode 100755 index 00000000000..a75d2eb6746 --- /dev/null +++ b/Master/bin/win32/lua2dox_filter.bat @@ -0,0 +1,69 @@ +@echo off + +:init + + rem Avoid clobbering anyone else's variables + + setlocal + + rem Safety precaution against awkward paths + + cd /d "%~dp0" + +:main + + call :set_lua + if ERRORLEVEL 1 ( + goto :end + ) + + set BASENAME=%~n0 + set DIRNAME=%~dp0 + + set LUASCRIPT=%DIRNAME%\lua2dox.lua %BASENAME% + + if not [%*] == [] ( + echo %* + ) + %EXE% %LUASCRIPT% %* + + goto :end + +:set_lua + + call :exe-search texlua + + if not defined EXE ( + call :exe-search lua + ) + + if not defined EXE ( + echo No Lua interpreter available + exit /b 1 + ) + + goto :EOF + +:exe-search + + set PATHCOPY=%PATH% + +:exe-search-loop + + rem Search for a binary + + if defined EXE goto :EOF + + for /f "delims=; tokens=1,2*" %%I in ("%PATHCOPY%") do ( + if exist "%%I\%1.exe" ( + set EXE=%1 + ) + set PATHCOPY=%%J;%%K + ) + if not "%PATHCOPY%" == ";" goto :exe-search-loop + + exit /b 1 + + goto :EOF + +:end \ No newline at end of file diff --git a/Master/bin/x86_64-darwin/lua2dox_filter b/Master/bin/x86_64-darwin/lua2dox_filter index 813f7749250..545465ae6a2 120000 --- a/Master/bin/x86_64-darwin/lua2dox_filter +++ b/Master/bin/x86_64-darwin/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/x86_64-darwin/lua2dox_lua b/Master/bin/x86_64-darwin/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/x86_64-darwin/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/x86_64-linux/lua2dox_filter +++ b/Master/bin/x86_64-linux/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/x86_64-linux/lua2dox_lua b/Master/bin/x86_64-linux/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/x86_64-linux/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../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 index 813f7749250..545465ae6a2 120000 --- a/Master/bin/x86_64-solaris/lua2dox_filter +++ b/Master/bin/x86_64-solaris/lua2dox_filter @@ -1 +1 @@ -lua2dox_lua \ No newline at end of file +../../texmf-dist/scripts/lua2dox/lua2dox_filter \ No newline at end of file diff --git a/Master/bin/x86_64-solaris/lua2dox_lua b/Master/bin/x86_64-solaris/lua2dox_lua deleted file mode 120000 index 3dcc4b61c72..00000000000 --- a/Master/bin/x86_64-solaris/lua2dox_lua +++ /dev/null @@ -1 +0,0 @@ -../../texmf-dist/scripts/lua2dox/lua2dox_lua \ No newline at end of file diff --git a/Master/texmf-dist/doc/support/lua2dox/ChangeLog b/Master/texmf-dist/doc/support/lua2dox/ChangeLog new file mode 100644 index 00000000000..3b9e33bafb8 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/ChangeLog @@ -0,0 +1,17 @@ +%%%%%%%%%%%%%%%%%%%%% +% changelog for lua2dox +% Note that this is in TeX format. + +0.2 2013-02-07 + + * removed reliance on temporary files, but now requires doxygen >= 1.8.1. + +0.1a 2012-09-26 + + * Cleaned up documentation. + +0.1 2012-07-04 + + * Initial release + +%%eof \ No newline at end of file diff --git a/Master/texmf-dist/doc/support/lua2dox/Doxyfile b/Master/texmf-dist/doc/support/lua2dox/Doxyfile index dd9865d6497..775ab603713 100644 --- a/Master/texmf-dist/doc/support/lua2dox/Doxyfile +++ b/Master/texmf-dist/doc/support/lua2dox/Doxyfile @@ -1,224 +1,270 @@ -# Doxyfile 1.5.6 +# Doxyfile 1.8.2 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project +# doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored +# 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 (" ") +# 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 +# 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. +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. -PROJECT_NAME = "Lua2dox.lua" +PROJECT_NAME = "lua2dox" -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or +# 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" +PROJECT_NUMBER = "0.2 20130128" -# 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 +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# 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 +# 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. +# 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, Esperanto, 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, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. OUTPUT_LANGUAGE = English +#OUTPUT_LANGUAGE = French -# 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). +# 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 +# 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" +# 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 = +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 +# 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 +# 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 +# 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 +# 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. Note that you specify absolute paths here, but also +# relative paths, which will be relative from the directory where doxygen is +# started. + +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 = +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 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system # 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 +# 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 +# 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 +# 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 +# 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 +# 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. +# 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:". +# 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 = +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding +# "class=itcl::class" will allow you to use the command class in the +# itcl::class meaning. -# 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 +TCL_SUBST = + +# 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 +# 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 +# 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 +# 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 +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, +# and language is one of the parsers supported by doxygen: IDL, Java, +# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, +# C++. For instance to make doxygen treat .inc files as Fortran files (default +# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note +# that for custom extensions you also need to set FILE_PATTERNS otherwise the +# files are not read by doxygen. + +EXTENSION_MAPPING = + +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all +# comments according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you +# can mix doxygen, HTML, and XML commands with Markdown formatting. +# Disable only in case of backward compatibilities issues. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented classes, +# or namespaces to their corresponding documentation. Such a link can be +# prevented in individual cases by by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. + +AUTOLINK_SUPPORT = YES + +# 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 makes the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = NO @@ -228,449 +274,544 @@ BUILTIN_STL_SUPPORT = NO 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 +# 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. +# 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 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 +# 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 +# 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 +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# 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 +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +SYMBOL_CACHE_SIZE = 0 + +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given +# their name and scope. Since this can be an expensive process and often the +# same symbol appear multiple times in the code, doxygen keeps a cache of +# pre-resolved symbols. If the cache is too small doxygen will become slower. +# If the cache is too large, memory is wasted. The cache size is given by this +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +LOOKUP_CACHE_SIZE = 0 + #--------------------------------------------------------------------------- # 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 +# 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 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. -EXTRACT_PRIVATE = NO +EXTRACT_PRIVATE = yes + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. -# If the EXTRACT_STATIC tag is set to YES all static members of a file +EXTRACT_PACKAGE = 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 +EXTRACT_STATIC = yes -# 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 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. +# 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. +# 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 namespaces 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. +# 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 +# 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 +# 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 +# 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. +# 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 +# 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 +# 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 +# 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] +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# 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 +# 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 +# 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 +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. -# 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) +SORT_MEMBERS_CTORS_1ST = NO + +# 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. +# 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 +# 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 +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = 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 +# 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 +# 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 +# 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 +# The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. -ENABLED_SECTIONS = +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 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro 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 macros 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 +# 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 +# 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 +# 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 , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output +# 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 , where is the value of +# the FILE_VERSION_FILTER tag, and 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 = +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. + +CITE_BIB_FILES = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated +# 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 +# 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 +# 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 +# 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 +# The WARN_NO_PARAMDOC option can be enabled 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 +# 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 +# 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 = +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 +# 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 = +INPUT = . ## test_src -# 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 +# 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 +# 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++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl -FILE_PATTERNS = *.lua +FILE_PATTERNS = *.lua \ + *.cpp -# 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. +# 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 +# The EXCLUDE tag can be used to specify files and/or directories that should be +# 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. +# Note that relative paths are relative to the directory from which doxygen is +# run. -EXCLUDE = +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 +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system 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 +# 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 = +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, +# 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 = +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 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 = +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 +# 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 = +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. +# 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_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 = +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 , where -# is the value of the INPUT_FILTER tag, and 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 +# 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 , where +# is the value of the INPUT_FILTER tag, and 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 = +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. +# 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 or if +# non of the patterns match the file name, INPUT_FILTER is applied. +#FILTER_PATTERNS = *.lua=./l2dx_filter 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 +# 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 +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + #--------------------------------------------------------------------------- # 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 +# 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 +# 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. +# 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, C++ and Fortran 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 +# 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 +# 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 @@ -678,20 +819,21 @@ 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. +# link to the source code. +# Otherwise they will link to the documentation. 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 +# 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 +# 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 @@ -700,130 +842,201 @@ 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 +# 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 +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 +# 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 +# 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 = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# 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 +# 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 +# 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. +# 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. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +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_HEADER = +HTML_FOOTER = -# 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. +# 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 left blank doxygen will +# generate a default style sheet. Note that it is recommended to use +# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this +# tag will in the future become obsolete. -HTML_FOOTER = +HTML_STYLESHEET = -# 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! +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional +# user-defined cascading style sheet that is included after the standard +# style sheets created by doxygen. Using this option one can overrule +# certain style aspects. This is preferred over using HTML_STYLESHEET +# since it does not replace the standard style sheet and is therefor more +# robust against future updates. Doxygen will copy the style sheet file to +# the output directory. -HTML_STYLESHEET = +HTML_EXTRA_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. +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. -HTML_ALIGN_MEMBERS = YES +HTML_EXTRA_FILES = -# 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. +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. -GENERATE_HTMLHELP = NO +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + +# 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. + +HTML_DYNAMIC_SECTIONS = 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 +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of +# entries shown in the various tree structured indices initially; the user +# can expand and collapse entries dynamically later on. Doxygen will expand +# the tree to such a level that at most the specified number of entries are +# visible (unless a fully collapsed tree already exceeds this amount). +# So setting the number of entries 1 will produce a full collapsed tree by +# default. 0 is a special value representing an infinite number of entries +# and will result in a full expanded tree by default. + +HTML_INDEX_NUM_ENTRIES = 100 + +# 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. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. 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) +# 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 +# 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). +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely +# identify the documentation publisher. This should be a reverse domain-name +# style string, e.g. com.mycompany.MyDocSet.documentation. -HTML_DYNAMIC_SECTIONS = NO +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# 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_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 +# 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 = +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 +# 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 = +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 +# 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 @@ -832,204 +1045,354 @@ GENERATE_CHI = NO # is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. -CHM_INDEX_ENCODING = +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 +# 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 +# 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. +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. -DISABLE_INDEX = NO +GENERATE_QHP = 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. +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. -ENUM_VALUES_PER_LINE = 4 +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = NO # 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. +# If the tag value is set to YES, 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 (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. 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 +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# 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 +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# 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 +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you may also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to +# the MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. +# However, it is strongly recommended to install a local +# copy of MathJax from http://www.mathjax.org before deployment. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = NO + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# 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 +# 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 +# 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. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. 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 +# 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 +# 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 +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, 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 +# 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 = +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 +# 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 = +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! -# 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 +LATEX_FOOTER = + +# 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 +# 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. +# 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.) +# 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 +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + #--------------------------------------------------------------------------- # 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 +# 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 +# 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 +# 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. +# 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 +# Load style sheet 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 = +RTF_STYLESHEET_FILE = -# Set optional variables used in the generation of an rtf document. +# Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. -RTF_EXTENSIONS_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 +# 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 +# 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 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 +# 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 @@ -1038,33 +1401,33 @@ 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 +# 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 +# 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 +# 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 = +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 +# 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 = +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 +# 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 @@ -1073,10 +1436,10 @@ 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 +# 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 @@ -1085,338 +1448,364 @@ 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 +# 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 +# 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 +# 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 +# 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 = +PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# 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 +# 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 +# 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 +# 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. +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when 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 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 = +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 +# 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 = +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 +# 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 = +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. +# 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 that +# overrules the definition found in the source code. -EXPAND_AS_DEFINED = +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. +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# 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 +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. 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. 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 = +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 +# 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 +# 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 +# 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 +# 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. +# 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 also works with HAVE_DOT disabled, but 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 +# 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 = +MSCGEN_PATH = -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented +# 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 +# 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. +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You 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. +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. -DOT_FONTPATH = +DOT_FONTSIZE = 10 -# 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. +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +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 +# 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 +# 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 +# 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 +# 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 +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# managable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + +# 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 +# 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 +# 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 +# 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 +# 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. +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a 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 +# If the DIRECTORY_GRAPH 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. +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). DOT_IMAGE_FORMAT = png -# The tag DOT_PATH can be used to specify the path where the dot tool can be +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# 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 = +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 +# 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 = +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). -# 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 +MSCFILE_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 +# 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). +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. 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) +# 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 +# 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 +# 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 deleted file mode 100644 index 9a1cc4886af..00000000000 --- a/Master/texmf-dist/doc/support/lua2dox/INSTALL +++ /dev/null @@ -1,42 +0,0 @@ -////////////////////// -// 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/docs/html/annotated.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/annotated.html new file mode 100644 index 00000000000..45c559df422 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/annotated.html @@ -0,0 +1,67 @@ + + + + + +lua2dox: Class List + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+
+
Class List
+
+
+
Here are the classes, structs, unions and interfaces with brief descriptions:
+ + + + + + + + +
oCTAppThis application
oCTCore_ClockClock
oCTCore_CommandlineReads/parses commandline
oCTCore_IOIo to console
oCTLua2DoX_filterInput filter
oCTStream_ReadFile buffer
\CTStream_WriteOutput stream
+
+
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/bc_s.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/bc_s.png new file mode 100644 index 00000000000..224b29aa984 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/bc_s.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/bdwn.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/bdwn.png new file mode 100644 index 00000000000..940a0b95044 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/bdwn.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/classTApp-members.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTApp-members.html new file mode 100644 index 00000000000..338c4fc2828 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTApp-members.html @@ -0,0 +1,63 @@ + + + + + +lua2dox: Member List + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+
+
TApp Member List
+
+
+ +

This is the complete list of members for TApp, including all inherited members.

+ + + + + +
getCopyright(this)TApp
getRunStamp(this)TApp
getVersion(this)TApp
init(this)TApp
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/classTApp.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTApp.html new file mode 100644 index 00000000000..fd6796703e4 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTApp.html @@ -0,0 +1,157 @@ + + + + + +lua2dox: TApp Class Reference + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+ +
+
TApp Class Reference
+
+
+ +

this application + More...

+ + + + + + + + + + + +

+Public Member Functions

 init (this)
 constructor
 
 getRunStamp (this)
 
 getVersion (this)
 
 getCopyright (this)
 
+

Detailed Description

+

this application

+ +

Definition at line 609 of file lua2dox.lua.

+

Member Function Documentation

+ +
+
+ + + + + + + + +
getCopyright (this )
+
+ +

Definition at line 629 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + +
getRunStamp (this )
+
+ +

Definition at line 620 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + +
getVersion (this )
+
+ +

Definition at line 625 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + +
init (this )
+
+ +

constructor

+ +

Definition at line 612 of file lua2dox.lua.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Clock-members.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Clock-members.html new file mode 100644 index 00000000000..7faf2ff03c0 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Clock-members.html @@ -0,0 +1,62 @@ + + + + + +lua2dox: Member List + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+
+
TCore_Clock Member List
+
+
+ +

This is the complete list of members for TCore_Clock, including all inherited members.

+ + + + +
GetTimeNow()TCore_Clock
getTimeStamp(this, T0)TCore_Clock
init(this, T0)TCore_Clock
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Clock.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Clock.html new file mode 100644 index 00000000000..8f10b9098f5 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Clock.html @@ -0,0 +1,162 @@ + + + + + +lua2dox: TCore_Clock Class Reference + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+ +
+
TCore_Clock Class Reference
+
+
+ +

a clock + More...

+ + + + + + + + + + + +

+Public Member Functions

 GetTimeNow ()
 get the current time
 
 init (this, T0)
 constructor
 
 getTimeStamp (this, T0)
 get time string
 
+

Detailed Description

+

a clock

+ +

Definition at line 172 of file lua2dox.lua.

+

Member Function Documentation

+ +
+
+ + + + + + + +
GetTimeNow ()
+
+ +

get the current time

+ +

Definition at line 175 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
getTimeStamp (this ,
T0  
)
+
+ +

get time string

+ +

Definition at line 193 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
init (this ,
T0  
)
+
+ +

constructor

+ +

Definition at line 184 of file lua2dox.lua.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Commandline-members.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Commandline-members.html new file mode 100644 index 00000000000..e56f70e3f04 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Commandline-members.html @@ -0,0 +1,61 @@ + + + + + +lua2dox: Member List + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+
+
TCore_Commandline Member List
+
+
+ +

This is the complete list of members for TCore_Commandline, including all inherited members.

+ + + +
getRaw(this, Key, Default)TCore_Commandline
init(this)TCore_Commandline
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Commandline.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Commandline.html new file mode 100644 index 00000000000..5df4e8b4564 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__Commandline.html @@ -0,0 +1,136 @@ + + + + + +lua2dox: TCore_Commandline Class Reference + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+ +
+
TCore_Commandline Class Reference
+
+
+ +

reads/parses commandline + More...

+ + + + + + + + +

+Public Member Functions

 init (this)
 constructor
 
 getRaw (this, Key, Default)
 get value
 
+

Detailed Description

+

reads/parses commandline

+ +

Definition at line 264 of file lua2dox.lua.

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
getRaw (this ,
Key ,
Default  
)
+
+ +

get value

+ +

Definition at line 274 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + +
init (this )
+
+ +

constructor

+ +

Definition at line 267 of file lua2dox.lua.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__IO.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__IO.html new file mode 100644 index 00000000000..1e7255ea7a6 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTCore__IO.html @@ -0,0 +1,67 @@ + + + + + +lua2dox: TCore_IO Class Reference + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+
+
TCore_IO Class Reference
+
+
+ +

io to console + More...

+

Detailed Description

+

io to console

+

pseudo class (no methods, just to keep documentation tidy)

+ +

Definition at line 210 of file lua2dox.lua.

+

The documentation for this class was generated from the following file: +
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/classTLua2DoX__filter-members.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTLua2DoX__filter-members.html new file mode 100644 index 00000000000..97842a5a752 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTLua2DoX__filter-members.html @@ -0,0 +1,61 @@ + + + + + +lua2dox: Member List + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+
+
TLua2DoX_filter Member List
+
+
+ +

This is the complete list of members for TLua2DoX_filter, including all inherited members.

+ + + +
readfile(this, AppStamp, Filename)TLua2DoX_filter
warning(this, Line, LineNo, Legend)TLua2DoX_filter
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/classTLua2DoX__filter.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTLua2DoX__filter.html new file mode 100644 index 00000000000..37c1d3b2681 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTLua2DoX__filter.html @@ -0,0 +1,158 @@ + + + + + +lua2dox: TLua2DoX_filter Class Reference + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+ +
+
TLua2DoX_filter Class Reference
+
+
+ +

input filter + More...

+ + + + + + + + +

+Public Member Functions

 warning (this, Line, LineNo, Legend)
 allow us to do errormessages
 
 readfile (this, AppStamp, Filename)
 run the filter
 
+

Detailed Description

+

input filter

+ +

Definition at line 398 of file lua2dox.lua.

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
readfile (this ,
AppStamp ,
Filename  
)
+
+ +

run the filter

+ +

Definition at line 464 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
warning (this ,
Line ,
LineNo ,
Legend  
)
+
+ +

allow us to do errormessages

+ +

Definition at line 401 of file lua2dox.lua.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Read-members.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Read-members.html new file mode 100644 index 00000000000..1c9c203e661 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Read-members.html @@ -0,0 +1,64 @@ + + + + + +lua2dox: Member List + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+
+
TStream_Read Member List
+
+
+ +

This is the complete list of members for TStream_Read, including all inherited members.

+ + + + + + +
eof(this)TStream_Read
getContents(this, Filename)TStream_Read
getLine(this)TStream_Read
getLineNo(this)TStream_Read
ungetLine(this, LineFrag)TStream_Read
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Read.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Read.html new file mode 100644 index 00000000000..89c04342e65 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Read.html @@ -0,0 +1,216 @@ + + + + + +lua2dox: TStream_Read Class Reference + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+ +
+
TStream_Read Class Reference
+
+
+ +

file buffer + More...

+ + + + + + + + + + + + + + + + + +

+Public Member Functions

 getContents (this, Filename)
 get contents of file
 
 getLineNo (this)
 get lineno
 
 getLine (this)
 get a line
 
 ungetLine (this, LineFrag)
 save line fragment
 
 eof (this)
 is it eof?
 
+

Detailed Description

+

file buffer

+

an input file buffer

+ +

Definition at line 289 of file lua2dox.lua.

+

Member Function Documentation

+ +
+
+ + + + + + + + +
eof (this )
+
+ +

is it eof?

+ +

Definition at line 350 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
getContents (this ,
Filename  
)
+
+ +

get contents of file

+
Parameters
+ + +
Filenamename of file to read (or nil == stdin)
+
+
+ +

Definition at line 294 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + +
getLine (this )
+
+ +

get a line

+ +

Definition at line 327 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + +
getLineNo (this )
+
+ +

get lineno

+ +

Definition at line 322 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
ungetLine (this ,
LineFrag  
)
+
+ +

save line fragment

+ +

Definition at line 345 of file lua2dox.lua.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Write-members.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Write-members.html new file mode 100644 index 00000000000..7df9625721f --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Write-members.html @@ -0,0 +1,65 @@ + + + + + +lua2dox: Member List + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+
+
TStream_Write Member List
+
+
+ +

This is the complete list of members for TStream_Write, including all inherited members.

+ + + + + + + +
init(this)TStream_Write
write(this, Str)TStream_Write
write_tailLines(this)TStream_Write
writeln(this, Str)TStream_Write
writelnComment(this, Str)TStream_Write
writelnTail(this, Line)TStream_Write
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Write.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Write.html new file mode 100644 index 00000000000..5a5caf170e9 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/classTStream__Write.html @@ -0,0 +1,252 @@ + + + + + +lua2dox: TStream_Write Class Reference + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+ +
+
TStream_Write Class Reference
+
+
+ +

output stream + More...

+ + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 init (this)
 constructor
 
 write (this, Str)
 write immediately
 
 writeln (this, Str)
 write immediately
 
 writelnComment (this, Str)
 write immediately
 
 writelnTail (this, Line)
 write to tail
 
 write_tailLines (this)
 outout tail lines
 
+

Detailed Description

+

output stream

+ +

Definition at line 358 of file lua2dox.lua.

+

Member Function Documentation

+ +
+
+ + + + + + + + +
init (this )
+
+ +

constructor

+ +

Definition at line 361 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
write (this ,
Str  
)
+
+ +

write immediately

+ +

Definition at line 366 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + +
write_tailLines (this )
+
+ +

outout tail lines

+ +

Definition at line 390 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
writeln (this ,
Str  
)
+
+ +

write immediately

+ +

Definition at line 371 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
writelnComment (this ,
Str  
)
+
+ +

write immediately

+ +

Definition at line 376 of file lua2dox.lua.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
writelnTail (this ,
Line  
)
+
+ +

write to tail

+ +

Definition at line 382 of file lua2dox.lua.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/classes.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/classes.html new file mode 100644 index 00000000000..533ad8d79ac --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/classes.html @@ -0,0 +1,65 @@ + + + + + +lua2dox: Class Index + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+
+
Class Index
+
+
+ + + + + + +
  T  
+
TCore_Clock   TCore_IO   TStream_Read   
TCore_Commandline   TLua2DoX_filter   TStream_Write   
TApp   
+ +
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/closed.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/closed.png new file mode 100644 index 00000000000..98cc2c909da Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/closed.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/doxygen.css b/Master/texmf-dist/doc/support/lua2dox/docs/html/doxygen.css index 22c484301dd..2642e8f9ecb 100644 --- a/Master/texmf-dist/doc/support/lua2dox/docs/html/doxygen.css +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/doxygen.css @@ -1,473 +1,1172 @@ -BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { - font-family: Geneva, Arial, Helvetica, sans-serif; +/* The standard CSS for doxygen */ + +body, table, div, p, dl { + font: 400 14px/19px Roboto,sans-serif; } -BODY,TD { - font-size: 90%; + +/* @group Heading Levels */ + +h1.groupheader { + font-size: 150%; } -H1 { - text-align: center; - font-size: 160%; + +.title { + font-size: 150%; + font-weight: bold; + margin: 10px 2px; } -H2 { - font-size: 120%; + +h2.groupheader { + border-bottom: 1px solid #879ECB; + color: #354C7B; + font-size: 150%; + font-weight: normal; + margin-top: 1.75em; + padding-top: 8px; + padding-bottom: 4px; + width: 100%; } -H3 { + +h3.groupheader { font-size: 100%; } -CAPTION { - font-weight: bold + +h1, h2, h3, h4, h5, h6 { + -webkit-transition: text-shadow 0.5s linear; + -moz-transition: text-shadow 0.5s linear; + -ms-transition: text-shadow 0.5s linear; + -o-transition: text-shadow 0.5s linear; + transition: text-shadow 0.5s linear; + margin-right: 15px; } -DIV.qindex { - width: 100%; - background-color: #e8eef2; - border: 1px solid #84b0c7; + +h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { + text-shadow: 0 0 15px cyan; +} + +dt { + font-weight: bold; +} + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd, p.starttd { + margin-top: 2px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex, div.navtab{ + background-color: #EBEFF6; + border: 1px solid #A3B4D7; text-align: center; - margin: 2px; - padding: 2px; - line-height: 140%; } -DIV.navpath { + +div.qindex, 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; + +div.navtab { + margin-right: 15px; } -TD.navtab { - font-size: 70%; + +/* @group Link Styling */ + +a { + color: #3D578C; + font-weight: normal; + text-decoration: none; } -A.qindex { - text-decoration: none; - font-weight: bold; - color: #1A419D; + +.contents a:visited { + color: #4665A2; } -A.qindex:visited { - text-decoration: none; - font-weight: bold; - color: #1A419D + +a:hover { + text-decoration: underline; } -A.qindex:hover { - text-decoration: none; - background-color: #ddddff; + +a.qindex { + font-weight: bold; } -A.qindexHL { - text-decoration: none; + +a.qindexHL { font-weight: bold; - background-color: #6666cc; + background-color: #9CAFD4; color: #ffffff; - border: 1px double #9295C2; + border: 1px double #869DCA; } -A.qindexHL:hover { - text-decoration: none; - background-color: #6666cc; - color: #ffffff; + +.contents a.qindexHL:visited { + color: #ffffff; } -A.qindexHL:visited { - text-decoration: none; - background-color: #6666cc; - color: #ffffff + +a.el { + font-weight: bold; } -A.el { - text-decoration: none; - font-weight: bold + +a.elRef { } -A.elRef { - font-weight: bold + +a.code, a.code:visited { + color: #4665A2; } -A.code:link { - text-decoration: none; - font-weight: normal; - color: #0000FF + +a.codeRef, a.codeRef:visited { + color: #4665A2; } -A.code:visited { - text-decoration: none; - font-weight: normal; - color: #0000FF + +/* @end */ + +dl.el { + margin-left: -1cm; } -A.codeRef:link { - font-weight: normal; - color: #0000FF + +pre.fragment { + border: 1px solid #C4CFE5; + background-color: #FBFCFD; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; + font-family: monospace, fixed; + font-size: 105%; } -A.codeRef:visited { - font-weight: normal; - color: #0000FF + +div.fragment { + padding: 4px; + margin: 4px; + background-color: #FBFCFD; + border: 1px solid #C4CFE5; } -A:hover { - text-decoration: none; - background-color: #f2f2ff + +div.line { + font-family: monospace, fixed; + font-size: 13px; + min-height: 13px; + line-height: 1.0; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + text-indent: -53px; + padding-left: 53px; + padding-bottom: 0px; + margin: 0px; + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; } -DL.el { - margin-left: -1cm + +div.line.glow { + background-color: cyan; + box-shadow: 0 0 10px cyan; } -.fragment { - font-family: monospace, fixed; - font-size: 95%; + + +span.lineno { + padding-right: 4px; + text-align: right; + border-right: 2px solid #0F0; + background-color: #E8E8E8; + white-space: pre; } -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; +span.lineno a { + background-color: #D8D8D8; } -DIV.ah { - background-color: black; - font-weight: bold; - color: #ffffff; - margin-bottom: 3px; - margin-top: 3px + +span.lineno a:hover { + background-color: #C8C8C8; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000); } -DIV.groupHeader { - margin-left: 16px; - margin-top: 12px; - margin-bottom: 6px; - font-weight: bold; +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + font-weight: bold; } -DIV.groupText { - margin-left: 16px; - font-style: italic; - font-size: 90% + +div.groupText { + margin-left: 16px; + font-style: italic; } -BODY { - background: white; + +body { + background-color: white; color: black; - margin-right: 20px; - margin-left: 20px; + margin: 0; } -TD.indexkey { - background-color: #e8eef2; + +div.contents { + margin-top: 10px; + margin-left: 12px; + margin-right: 8px; +} + +td.indexkey { + background-color: #EBEFF6; 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; + border: 1px solid #C4CFE5; + margin: 2px 0px 2px 0; + padding: 2px 10px; + white-space: nowrap; + vertical-align: top; } -.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; + +td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C4CFE5; + padding: 2px 10px; + margin: 2px 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%; + +tr.memlist { + background-color: #EEF1F7; } -.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%; + +p.formulaDsp { + text-align: center; } -.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%; + +img.formulaDsp { + } -.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%; + +img.formulaInl { + vertical-align: middle; } -.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%; + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 } -.search { + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +blockquote { + background-color: #F7F8FB; + border-left: 2px solid #9CAFD4; + margin: 0 24px 0 4px; + padding: 0 12px 0 16px; +} + +/* @end */ + +/* +.search { color: #003399; font-weight: bold; } -FORM.search { + +form.search { margin-bottom: 0px; margin-top: 0px; } -INPUT.search { + +input.search { font-size: 75%; color: #000080; font-weight: normal; background-color: #e8eef2; } -TD.tiny { +*/ + +td.tiny { font-size: 75%; } -a { - color: #1A41A8; -} -a:visited { - color: #2A3798; -} -.dirtab { + +.dirtab { padding: 4px; border-collapse: collapse; - border: 1px solid #84b0c7; + border: 1px solid #A3B4D7; } -TH.dirtab { - background: #e8eef2; + +th.dirtab { + background: #EBEFF6; font-weight: bold; } -HR { + +hr { + height: 0px; + border: none; + border-top: 1px solid #4A6AAA; +} + +hr.footer { height: 1px; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + +.memberdecls td, .fieldtable tr { + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +.memberdecls td.glow, .fieldtable tr.glow { + background-color: cyan; + box-shadow: 0 0 15px cyan; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #F9FAFC; border: none; - border-top: 1px solid black; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memSeparator { + border-bottom: 1px solid #DEE4F0; + line-height: 1px; + margin: 0px; + padding: 0px; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memItemRight { + width: 100%; } -/* Style for detailed member documentation */ +.memTemplParams { + color: #4665A2; + white-space: nowrap; + font-size: 80%; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + .memtemplate { font-size: 80%; - color: #606060; + color: #4665A2; font-weight: normal; - margin-left: 3px; -} -.memnav { - background-color: #e8eef2; - border: 1px solid #84b0c7; + margin-left: 9px; +} + +.memnav { + background-color: #EBEFF6; + border: 1px solid #A3B4D7; text-align: center; margin: 2px; margin-right: 15px; padding: 2px; } + +.mempage { + width: 100%; +} + .memitem { - padding: 4px; - background-color: #eef3f5; - border-width: 1px; - border-style: solid; - border-color: #dedeee; - -moz-border-radius: 8px 8px 8px 8px; + padding: 0; + margin-bottom: 10px; + margin-right: 5px; + -webkit-transition: box-shadow 0.5s linear; + -moz-transition: box-shadow 0.5s linear; + -ms-transition: box-shadow 0.5s linear; + -o-transition: box-shadow 0.5s linear; + transition: box-shadow 0.5s linear; + display: table !important; + width: 100%; } + +.memitem.glow { + box-shadow: 0 0 15px cyan; +} + .memname { - white-space: nowrap; - font-weight: bold; + font-weight: bold; + margin-left: 6px; } -.memdoc{ - padding-left: 10px; + +.memname td { + vertical-align: bottom; } -.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; + +.memproto, dl.reflist dt { + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 0px 6px 0px; + color: #253555; + font-weight: bold; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + /* opera specific markup */ + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + border-top-right-radius: 4px; + border-top-left-radius: 4px; + /* firefox specific markup */ + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 4px; + -moz-border-radius-topleft: 4px; + /* webkit specific markup */ + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 4px; + -webkit-border-top-left-radius: 4px; + +} + +.memdoc, dl.reflist dd { + border-bottom: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 10px 2px 10px; + background-color: #FBFCFD; + border-top-width: 0; + background-image:url('nav_g.png'); + background-repeat:repeat-x; + background-color: #FFFFFF; + /* opera specific markup */ + border-bottom-left-radius: 4px; + border-bottom-right-radius: 4px; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + /* firefox specific markup */ + -moz-border-radius-bottomleft: 4px; + -moz-border-radius-bottomright: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +dl.reflist dt { + padding: 5px; +} + +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; } + .paramkey { text-align: right; } + .paramtype { white-space: nowrap; } + .paramname { color: #602020; - font-style: italic; white-space: nowrap; } -/* End Styling for detailed member documentation */ +.paramname em { + font-style: normal; +} +.paramname code { + line-height: 14px; +} + +.params, .retval, .exception, .tparams { + margin-left: 0px; + padding-left: 0px; +} + +.params .paramname, .retval .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; +} + +table.mlabels { + border-spacing: 0px; +} + +td.mlabels-left { + width: 100%; + padding: 0px; +} + +td.mlabels-right { + vertical-align: bottom; + padding: 0px; + white-space: nowrap; +} -/* for the tree view */ -.ftvtree { - font-family: sans-serif; - margin:0.5em; +span.mlabels { + margin-left: 8px; } -/* these are for tree view when used as main index */ -.directory { - font-size: 9pt; - font-weight: bold; + +span.mlabel { + background-color: #728DC1; + border-top:1px solid #5373B4; + border-left:1px solid #5373B4; + border-right:1px solid #C4CFE5; + border-bottom:1px solid #C4CFE5; + text-shadow: none; + color: white; + margin-right: 4px; + padding: 2px 3px; + border-radius: 3px; + font-size: 7pt; + white-space: nowrap; + vertical-align: middle; } -.directory h3 { - margin: 0px; - margin-top: 1em; - font-size: 11pt; + + + +/* @end */ + +/* these are for tree view when not used as main index */ + +div.directory { + margin: 10px 0px; + border-top: 1px solid #A8B8D9; + border-bottom: 1px solid #A8B8D9; + width: 100%; } -/* 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 table { + border-collapse:collapse; +} -/* .directory h3.swap { */ -/* height: 61px; */ -/* background-repeat: no-repeat; */ -/* background-image: url("yourimage.gif"); */ -/* } */ -/* .directory h3.swap span { */ -/* display: none; */ -/* } */ +.directory td { + margin: 0px; + padding: 0px; + vertical-align: top; +} -.directory > h3 { - margin-top: 0; +.directory td.entry { + white-space: nowrap; + padding-right: 6px; } -.directory p { - margin: 0px; - white-space: nowrap; + +.directory td.entry a { + outline:none; } -.directory div { - display: none; - margin: 0px; + +.directory td.entry a img { + border: none; } -.directory img { - vertical-align: -30%; + +.directory td.desc { + width: 100%; + padding-left: 6px; + padding-right: 6px; + padding-top: 3px; + border-left: 1px solid rgba(0,0,0,0.05); } -/* these are for tree view when not used as main index */ -.directory-alt { - font-size: 100%; - font-weight: bold; + +.directory tr.even { + padding-left: 6px; + background-color: #F7F8FB; +} + +.directory img { + vertical-align: -30%; } -.directory-alt h3 { - margin: 0px; - margin-top: 1em; - font-size: 11pt; + +.directory .levels { + white-space: nowrap; + width: 100%; + text-align: right; + font-size: 9pt; +} + +.directory .levels span { + cursor: pointer; + padding-left: 2px; + padding-right: 2px; + color: #3D578C; } -.directory-alt > h3 { - margin-top: 0; + +div.dynheader { + margin-top: 8px; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; } -.directory-alt p { - margin: 0px; - white-space: nowrap; + +address { + font-style: normal; + color: #2A3D61; } -.directory-alt div { - display: none; - margin: 0px; + +table.doxtable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +table.fieldtable { + width: 100%; + margin-bottom: 10px; + border: 1px solid #A8B8D9; + border-spacing: 0px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); + box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); +} + +.fieldtable td, .fieldtable th { + padding: 3px 7px 2px; +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname { + white-space: nowrap; + border-right: 1px solid #A8B8D9; + border-bottom: 1px solid #A8B8D9; + vertical-align: top; +} + +.fieldtable td.fielddoc { + border-bottom: 1px solid #A8B8D9; + width: 100%; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable th { + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + font-size: 90%; + color: #253555; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; + -moz-border-radius-topleft: 4px; + -moz-border-radius-topright: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + border-top-left-radius: 4px; + border-top-right-radius: 4px; + border-bottom: 1px solid #A8B8D9; +} + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image:url('tab_b.png'); + background-repeat:repeat-x; + background-position: 0 -5px; + height:30px; + line-height:30px; + color:#8AA0CC; + border:solid 1px #C2CDE4; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + background-image:url('bc_s.png'); + background-repeat:no-repeat; + background-position:right; + color:#364D7C; } -.directory-alt img { - vertical-align: -30%; + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; + color: #283A5D; + font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; +} + +.navpath li.navelem a:hover +{ + color:#6884BD; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + color:#364D7C; + font-size: 8pt; +} + + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +div.ingroups +{ + font-size: 8pt; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F9FAFC; + margin: 0px; + border-bottom: 1px solid #C4CFE5; +} + +div.headertitle +{ + padding: 5px 5px 5px 10px; +} + +dl +{ + padding: 0 0 0 10px; +} + +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ +dl.section +{ + margin-left: 0px; + padding-left: 0px; +} + +dl.note +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #D0C000; +} + +dl.warning, dl.attention +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #00D000; +} + +dl.deprecated +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #505050; +} + +dl.todo +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #00C0E0; +} + +dl.test +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #3030E0; +} + +dl.bug +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #C08050; +} + +dl.section dd { + margin-bottom: 6px; +} + + +#projectlogo +{ + text-align: center; + vertical-align: bottom; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectname +{ + font: 300% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 2px 0px; +} + +#projectbrief +{ + font: 120% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#projectnumber +{ + font: 50% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid #5373B4; +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + +div.zoom +{ + border: 1px solid #90A5CE; +} + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:#334975; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; +} + +dl.citelist dd { + margin:2px 0; + padding:5px 0; +} + +div.toc { + padding: 14px 25px; + background-color: #F4F6FA; + border: 1px solid #D8DFEE; + border-radius: 7px 7px 7px 7px; + float: right; + height: auto; + margin: 0 20px 10px 10px; + width: 200px; +} + +div.toc li { + background: url("bdwn.png") no-repeat scroll 0 5px transparent; + font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +div.toc h3 { + font: bold 12px/1.2 Arial,FreeSans,sans-serif; + color: #4665A2; + border-bottom: 0 none; + margin: 0; +} + +div.toc ul { + list-style: none outside none; + border: medium none; + padding: 0px; +} + +div.toc li.level1 { + margin-left: 0px; +} + +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 30px; +} + +div.toc li.level4 { + margin-left: 45px; +} + +.inherit_header { + font-weight: bold; + color: gray; + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.inherit_header td { + padding: 6px 0px 2px 5px; +} + +.inherit { + display: none; +} + +tr.heading h2 { + margin-top: 12px; + margin-bottom: 4px; +} + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } } diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/doxygen.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/doxygen.png index f0a274bbaff..3ff17d807fd 100644 Binary files a/Master/texmf-dist/doc/support/lua2dox/docs/html/doxygen.png and b/Master/texmf-dist/doc/support/lua2dox/docs/html/doxygen.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/dynsections.js b/Master/texmf-dist/doc/support/lua2dox/docs/html/dynsections.js new file mode 100644 index 00000000000..116542f181a --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/dynsections.js @@ -0,0 +1,78 @@ +function toggleVisibility(linkObj) +{ + var base = $(linkObj).attr('id'); + var summary = $('#'+base+'-summary'); + var content = $('#'+base+'-content'); + var trigger = $('#'+base+'-trigger'); + var src=$(trigger).attr('src'); + if (content.is(':visible')===true) { + content.hide(); + summary.show(); + $(linkObj).addClass('closed').removeClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png'); + } else { + content.show(); + summary.hide(); + $(linkObj).removeClass('closed').addClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-10)+'open.png'); + } + return false; +} + +function updateStripes() +{ + $('table.directory tr'). + removeClass('even').filter(':visible:even').addClass('even'); +} +function toggleLevel(level) +{ + $('table.directory tr').each(function(){ + var l = this.id.split('_').length-1; + var i = $('#img'+this.id.substring(3)); + var a = $('#arr'+this.id.substring(3)); + if (l - -Lua2dox.lua: File Index - - - - - + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2blank.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2blank.png new file mode 100644 index 00000000000..63c605bb4c3 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2blank.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2cl.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2cl.png new file mode 100644 index 00000000000..132f6577bf7 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2cl.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2doc.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2doc.png new file mode 100644 index 00000000000..17edabff95f Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2doc.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2folderclosed.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2folderclosed.png new file mode 100644 index 00000000000..bb8ab35edce Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2folderclosed.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2folderopen.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2folderopen.png new file mode 100644 index 00000000000..d6c7f676a3b Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2folderopen.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2lastnode.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2lastnode.png new file mode 100644 index 00000000000..63c605bb4c3 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2lastnode.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2link.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2link.png new file mode 100644 index 00000000000..17edabff95f Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2link.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2mlastnode.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2mlastnode.png new file mode 100644 index 00000000000..0b63f6d38c4 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2mlastnode.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2mnode.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2mnode.png new file mode 100644 index 00000000000..0b63f6d38c4 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2mnode.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2mo.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2mo.png new file mode 100644 index 00000000000..4bfb80f76e6 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2mo.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2node.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2node.png new file mode 100644 index 00000000000..63c605bb4c3 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2node.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2ns.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2ns.png new file mode 100644 index 00000000000..72e3d71c289 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2ns.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2plastnode.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2plastnode.png new file mode 100644 index 00000000000..c6ee22f937a Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2plastnode.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2pnode.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2pnode.png new file mode 100644 index 00000000000..c6ee22f937a Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2pnode.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2splitbar.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2splitbar.png new file mode 100644 index 00000000000..fe895f2c581 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2splitbar.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2vertline.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2vertline.png new file mode 100644 index 00000000000..63c605bb4c3 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/ftv2vertline.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/functions.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/functions.html new file mode 100644 index 00000000000..7402e7a6c7c --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/functions.html @@ -0,0 +1,120 @@ + + + + + +lua2dox: Class Members + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + + +
+
+
Here is a list of all class members with links to the classes they belong to:
+
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/functions_func.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/functions_func.html new file mode 100644 index 00000000000..229b9b20db4 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/functions_func.html @@ -0,0 +1,120 @@ + + + + + +lua2dox: Class Members - Functions + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + + +
+
+
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/globals.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/globals.html index c0ba18117fa..8a00f468466 100644 --- a/Master/texmf-dist/doc/support/lua2dox/docs/html/globals.html +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/globals.html @@ -1,92 +1,84 @@ - - -Lua2dox.lua: Class Members - - - - - + + 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..dae61018a51 --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua_source.html @@ -0,0 +1,719 @@ + + + + + +lua2dox: lua2dox.lua Source File + + + + + + +
+
+ + + + + + +
+
lua2dox +  0.2 20130128 +
+
+
+ + + + +
+
+
+
lua2dox.lua
+
+
+Go to the documentation of this file.
1 --[[--------------------------------------------------------------------------
+
2  -- Copyright (C) 2012 by Simon Dales --
+
3  -- simon@purrsoft.co.uk --
+
4  -- --
+
5  -- This program is free software; you can redistribute it and/or modify --
+
6  -- it under the terms of the GNU General Public License as published by --
+
7  -- the Free Software Foundation; either version 2 of the License, or --
+
8  -- (at your option) any later version. --
+
9  -- --
+
10  -- This program is distributed in the hope that it will be useful, --
+
11  -- but WITHOUT ANY WARRANTY; without even the implied warranty of --
+
12  -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the --
+
13  -- GNU General Public License for more details. --
+
14  -- --
+
15  -- You should have received a copy of the GNU General Public License --
+
16  -- along with this program; if not, write to the --
+
17  -- Free Software Foundation, Inc., --
+
18  -- 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. --
+
19 ----------------------------------------------------------------------------]]
+
20 --[[!
+
21  \file
+
22  \brief a hack lua2dox converter
+
23  ]]
+
24 
+
25 --[[!
+
26  \mainpage
+
27 
+
28  Introduction
+
29  ------------
+
30 
+
31  A hack lua2dox converter
+
32  Version 0.2
+
33 
+
34  This lets us make Doxygen output some documentation to let
+
35  us develop this code.
+
36 
+
37  It is partially cribbed from the functionality of lua2dox
+
38  (http://search.cpan.org/~alec/Doxygen-Lua-0.02/lib/Doxygen/Lua.pm).
+
39  Found on CPAN when looking for something else; kinda handy.
+
40 
+
41  Improved from lua2dox to make the doxygen output more friendly.
+
42  Also it runs faster in lua rather than Perl.
+
43 
+
44  Because this Perl based system is called "lua2dox"., I have decided to add ".lua" to the name
+
45  to keep the two separate.
+
46 
+
47  Running
+
48  -------
+
49 
+
50  <ol>
+
51  <li> Ensure doxygen is installed on your system and that you are familiar with its use.
+
52  Best is to try to make and document some simple C/C++/PHP to see what it produces.
+
53  You can experiment with the enclosed example code.
+
54 
+
55  <li> Run "doxygen -g" to create a default Doxyfile.
+
56 
+
57  Then alter it to let it recognise lua. Add the two following lines:
+
58 
+
59  \code{.bash}
+
60  FILE_PATTERNS = *.lua
+
61 
+
62  FILTER_PATTERNS = *.lua=lua2dox_filter
+
63  \endcode
+
64 
+
65 
+
66  Either add them to the end or find the appropriate entry in Doxyfile.
+
67 
+
68  There are other lines that you might like to alter, but see futher documentation for details.
+
69 
+
70  <li> When Doxyfile is edited run "doxygen"
+
71 
+
72  The core function reads the input file (filename or stdin) and outputs some pseudo C-ish language.
+
73  It only has to be good enough for doxygen to see it as legal.
+
74  Therefore our lua interpreter is fairly limited, but "good enough".
+
75 
+
76  One limitation is that each line is treated separately (except for long comments).
+
77  The implication is that class and function declarations must be on the same line.
+
78  Some functions can have their parameter lists extended over multiple lines to make it look neat.
+
79  Managing this where there are also some comments is a bit more coding than I want to do at this stage,
+
80  so it will probably not document accurately if we do do this.
+
81 
+
82  However I have put in a hack that will insert the "missing" close paren.
+
83  The effect is that you will get the function documented, but not with the parameter list you might expect.
+
84  </ol>
+
85 
+
86  Installation
+
87  ------------
+
88 
+
89  Here for linux or unix-like, for any other OS you need to refer to other documentation.
+
90 
+
91  This file is "lua2dox.lua". It gets called by "lua2dox_filter"(bash).
+
92  Somewhere in your path (e.g. "~/bin" or "/usr/local/bin") put a link to "lua2dox_filter".
+
93 
+
94  Documentation
+
95  -------------
+
96 
+
97  Read the external documentation that should be part of this package.
+
98  For example look for the "README" and some .PDFs.
+
99 
+
100  ]]
+
101 
+
102 -- we won't use our library code, so this becomes more portable
+
103 
+
104 -- require 'elijah_fix_require'
+
105 -- require 'elijah_class'
+
106 --
+
107 --! \brief ``declare'' as class
+
108 --!
+
109 --! use as:
+
110 --! \code{.lua}
+
111 --! TWibble = class()
+
112 --! function TWibble.init(this,Str)
+
113 --! this.str = Str
+
114 --! -- more stuff here
+
115 --! end
+
116 --! \endcode
+
117 --!
+
118 function class(BaseClass, ClassInitialiser)
+
119  local newClass = {} -- a new class newClass
+
120  if not ClassInitialiser and type(BaseClass) == 'function' then
+
121  ClassInitialiser = BaseClass
+
122  BaseClass = nil
+
123  elseif type(BaseClass) == 'table' then
+
124  -- our new class is a shallow copy of the base class!
+
125  for i,v in pairs(BaseClass) do
+
126  newClass[i] = v
+
127  end
+
128  newClass._base = BaseClass
+
129  end
+
130  -- the class will be the metatable for all its newInstanceects,
+
131  -- and they will look up their methods in it.
+
132  newClass.__index = newClass
+
133 
+
134  -- expose a constructor which can be called by <classname>(<args>)
+
135  local classMetatable = {}
+
136  classMetatable.__call =
+
137  function(class_tbl, ...)
+
138  local newInstance = {}
+
139  setmetatable(newInstance,newClass)
+
140  --if init then
+
141  -- init(newInstance,...)
+
142  if class_tbl.init then
+
143  class_tbl.init(newInstance,...)
+
144  else
+
145  -- make sure that any stuff from the base class is initialized!
+
146  if BaseClass and BaseClass.init then
+
147  BaseClass.init(newInstance, ...)
+
148  end
+
149  end
+
150  return newInstance
+
151  end
+
152  newClass.init = ClassInitialiser
+
153  newClass.is_a =
+
154  function(this, klass)
+
155  local thisMetatable = getmetatable(this)
+
156  while thisMetatable do
+
157  if thisMetatable == klass then
+
158  return true
+
159  end
+
160  thisMetatable = thisMetatable._base
+
161  end
+
162  return false
+
163  end
+
164  setmetatable(newClass, classMetatable)
+
165  return newClass
+
166 end
+
167 
+
168 -- require 'elijah_clock'
+
169 
+
170 --! \class TCore_Clock
+
171 --! \brief a clock
+ +
173 
+
174 --! \brief get the current time
+ +
176  if os.gettimeofday then
+
177  return os.gettimeofday()
+
178  else
+
179  return os.time()
+
180  end
+
181 end
+
182 
+
183 --! \brief constructor
+
184 function TCore_Clock.init(this,T0)
+
185  if T0 then
+
186  this.t0 = T0
+
187  else
+
188  this.t0 = TCore_Clock.GetTimeNow()
+
189  end
+
190 end
+
191 
+
192 --! \brief get time string
+
193 function TCore_Clock.getTimeStamp(this,T0)
+
194  local t0
+
195  if T0 then
+
196  t0 = T0
+
197  else
+
198  t0 = this.t0
+
199  end
+
200  return os.date('%c %Z',t0)
+
201 end
+
202 
+
203 
+
204 --require 'elijah_io'
+
205 
+
206 --! \class TCore_IO
+
207 --! \brief io to console
+
208 --!
+
209 --! pseudo class (no methods, just to keep documentation tidy)
+ +
211 --
+
212 --! \brief write to stdout
+
213 function TCore_IO_write(Str)
+
214  if (Str) then
+
215  io.write(Str)
+
216  end
+
217 end
+
218 
+
219 --! \brief write to stdout
+
220 function TCore_IO_writeln(Str)
+
221  if (Str) then
+
222  io.write(Str)
+
223  end
+
224  io.write("\n")
+
225 end
+
226 
+
227 
+
228 --require 'elijah_string'
+
229 
+
230 --! \brief trims a string
+
231 function string_trim(Str)
+
232  return Str:match("^%s*(.-)%s*$")
+
233 end
+
234 
+
235 --! \brief split a string
+
236 --!
+
237 --! \param Str
+
238 --! \param Pattern
+
239 --! \returns table of string fragments
+
240 function string_split(Str, Pattern)
+
241  local splitStr = {}
+
242  local fpat = "(.-)" .. Pattern
+
243  local last_end = 1
+
244  local str, e, cap = string.find(Str,fpat, 1)
+
245  while str do
+
246  if str ~= 1 or cap ~= "" then
+
247  table.insert(splitStr,cap)
+
248  end
+
249  last_end = e+1
+
250  str, e, cap = string.find(Str,fpat, last_end)
+
251  end
+
252  if last_end <= #Str then
+
253  cap = string.sub(Str,last_end)
+
254  table.insert(splitStr, cap)
+
255  end
+
256  return splitStr
+
257 end
+
258 
+
259 
+
260 --require 'elijah_commandline'
+
261 
+
262 --! \class TCore_Commandline
+
263 --! \brief reads/parses commandline
+ +
265 
+
266 --! \brief constructor
+
267 function TCore_Commandline.init(this)
+
268  this.argv = arg
+
269  this.parsed = {}
+
270  this.params = {}
+
271 end
+
272 
+
273 --! \brief get value
+
274 function TCore_Commandline.getRaw(this,Key,Default)
+
275  local val = this.argv[Key]
+
276  if not val then
+
277  val = Default
+
278  end
+
279  return val
+
280 end
+
281 
+
282 
+
283 --require 'elijah_debug'
+
284 
+
285 -------------------------------
+
286 --! \brief file buffer
+
287 --!
+
288 --! an input file buffer
+
289 TStream_Read = class()
+
290 
+
291 --! \brief get contents of file
+
292 --!
+
293 --! \param Filename name of file to read (or nil == stdin)
+
294 function TStream_Read.getContents(this,Filename)
+
295  -- get lines from file
+
296  local filecontents
+
297  if Filename then
+
298  -- syphon lines to our table
+
299  --TCore_Debug_show_var('Filename',Filename)
+
300  filecontents={}
+
301  for line in io.lines(Filename) do
+
302  table.insert(filecontents,line)
+
303  end
+
304  else
+
305  -- get stuff from stdin as a long string (with crlfs etc)
+
306  filecontents=io.read('*a')
+
307  -- make it a table of lines
+
308  filecontents = TString_split(filecontents,'[\n]') -- note this only works for unix files.
+
309  Filename = 'stdin'
+
310  end
+
311 
+
312  if filecontents then
+
313  this.filecontents = filecontents
+
314  this.contentsLen = #filecontents
+
315  this.currentLineNo = 1
+
316  end
+
317 
+
318  return filecontents
+
319 end
+
320 
+
321 --! \brief get lineno
+
322 function TStream_Read.getLineNo(this)
+
323  return this.currentLineNo
+
324 end
+
325 
+
326 --! \brief get a line
+
327 function TStream_Read.getLine(this)
+
328  local line
+
329  if this.currentLine then
+
330  line = this.currentLine
+
331  this.currentLine = nil
+
332  else
+
333  -- get line
+
334  if this.currentLineNo<=this.contentsLen then
+
335  line = this.filecontents[this.currentLineNo]
+
336  this.currentLineNo = this.currentLineNo + 1
+
337  else
+
338  line = ''
+
339  end
+
340  end
+
341  return line
+
342 end
+
343 
+
344 --! \brief save line fragment
+
345 function TStream_Read.ungetLine(this,LineFrag)
+
346  this.currentLine = LineFrag
+
347 end
+
348 
+
349 --! \brief is it eof?
+
350 function TStream_Read.eof(this)
+
351  if this.currentLine or this.currentLineNo<=this.contentsLen then
+
352  return false
+
353  end
+
354  return true
+
355 end
+
356 
+
357 --! \brief output stream
+
358 TStream_Write = class()
+
359 
+
360 --! \brief constructor
+
361 function TStream_Write.init(this)
+
362  this.tailLine = {}
+
363 end
+
364 
+
365 --! \brief write immediately
+
366 function TStream_Write.write(this,Str)
+
367  TCore_IO_write(Str)
+
368 end
+
369 
+
370 --! \brief write immediately
+
371 function TStream_Write.writeln(this,Str)
+
372  TCore_IO_writeln(Str)
+
373 end
+
374 
+
375 --! \brief write immediately
+
376 function TStream_Write.writelnComment(this,Str)
+
377  TCore_IO_write('// ZZ: ')
+
378  TCore_IO_writeln(Str)
+
379 end
+
380 
+
381 --! \brief write to tail
+
382 function TStream_Write.writelnTail(this,Line)
+
383  if not Line then
+
384  Line = ''
+
385  end
+
386  table.insert(this.tailLine,Line)
+
387 end
+
388 
+
389 --! \brief outout tail lines
+ +
391  for k,line in ipairs(this.tailLine) do
+
392  TCore_IO_writeln(line)
+
393  end
+
394  TCore_IO_write('// Lua2DoX new eof')
+
395 end
+
396 
+
397 --! \brief input filter
+ +
399 
+
400 --! \brief allow us to do errormessages
+
401 function TLua2DoX_filter.warning(this,Line,LineNo,Legend)
+
402  this.outStream:writelnTail(
+
403  '
+
404  )
+
405 end
+
406 
+
407 --! \brief trim comment off end of string
+
408 --!
+
409 --! If the string has a comment on the end, this trims it off.
+
410 --!
+
411 local function TString_removeCommentFromLine(Line)
+
412  local pos_comment = string.find(Line,'%-%-')
+
413  local tailComment
+
414  if pos_comment then
+
415  Line = string.sub(Line,1,pos_comment-1)
+
416  tailComment = string.sub(Line,pos_comment)
+
417  end
+
418  return Line,tailComment
+
419 end
+
420 
+
421 --! \brief get directive from magic
+
422 local function getMagicDirective(Line)
+
423  local macro,tail
+
424  local macroStr = '[\\\@]'
+
425  local pos_macro = string.find(Line,macroStr)
+
426  if pos_macro then
+
427  --! ....\\ macro...stuff
+
428  --! ....\@ macro...stuff
+
429  local line = string.sub(Line,pos_macro+1)
+
430  local space = string.find(line,'%s+')
+
431  if space then
+
432  macro = string.sub(line,1,space-1)
+
433  tail = string_trim(string.sub(line,space+1))
+
434  else
+
435  macro = line
+
436  tail = ''
+
437  end
+
438  end
+
439  return macro,tail
+
440 end
+
441 
+
442 --! \brief check comment for fn
+
443 local function checkComment4fn(Fn_magic,MagicLines)
+
444  local fn_magic = Fn_magic
+
445 -- TCore_IO_writeln('// checkComment4fn "' .. MagicLines .. '"')
+
446 
+
447  local magicLines = string_split(MagicLines,'\n')
+
448 
+
449  local macro,tail
+
450 
+
451  for k,line in ipairs(magicLines) do
+
452  macro,tail = getMagicDirective(line)
+
453  if macro == 'fn' then
+
454  fn_magic = tail
+
455  -- TCore_IO_writeln('// found fn "' .. fn_magic .. '"')
+
456  else
+
457  --TCore_IO_writeln('// not found fn "' .. line .. '"')
+
458  end
+
459  end
+
460 
+
461  return fn_magic
+
462 end
+
463 --! \brief run the filter
+
464 function TLua2DoX_filter.readfile(this,AppStamp,Filename)
+
465  local err
+
466 
+
467  local inStream = TStream_Read()
+
468  local outStream = TStream_Write()
+
469  this.outStream = outStream -- save to this obj
+
470 
+
471  if (inStream:getContents(Filename)) then
+
472  -- output the file
+
473  local line
+
474  local fn_magic -- function name/def from magic comment
+
475 
+
476  outStream:writelnTail('// #######################')
+
477  outStream:writelnTail('// app run:' .. AppStamp)
+
478  outStream:writelnTail('// #######################')
+
479  outStream:writelnTail()
+
480 
+
481  while not (err or inStream:eof()) do
+
482  line = string_trim(inStream:getLine())
+
483 -- TCore_Debug_show_var('inStream',inStream)
+
484 -- TCore_Debug_show_var('line',line )
+
485  if string.sub(line,1,2)=='--' then -- its a comment
+
486  if string.sub(line,3,3)=='!' then -- it's a magic comment
+
487  local magic = string.sub(line,4)
+
488  outStream:writeln('
+
489  fn_magic = checkComment4fn(fn_magic,magic)
+
490  elseif string.sub(line,3,4)=='[[' then -- it's a long comment
+
491  line = string.sub(line,5) -- nibble head
+
492  local comment = ''
+
493  local closeSquare,hitend,thisComment
+
494  while (not err) and (not hitend) and (not inStream:eof()) do
+
495  closeSquare = string.find(line,']]')
+
496  if not closeSquare then -- need to look on another line
+
497  thisComment = line .. '\n'
+
498  line = inStream:getLine()
+
499  else
+
500  thisComment = string.sub(line,1,closeSquare-1)
+
501  hitend = true
+
502 
+
503  -- unget the tail of the line
+
504  -- in most cases it's empty. This may make us less efficient but
+
505  -- easier to program
+
506  inStream:ungetLine(string_trim(string.sub(line,closeSquare+2)))
+
507  end
+
508  comment = comment .. thisComment
+
509  end
+
510  if string.sub(comment,1,1)=='!' then -- it's a long magic comment
+
511  outStream:write('/*' .. comment .. '*/ ')
+
512  fn_magic = checkComment4fn(fn_magic,comment)
+
513  else -- discard
+
514  outStream:write('/* zz:' .. comment .. '*/ ')
+
515  fn_magic = nil
+
516  end
+
517  else
+
518  outStream:writeln('// zz:"' .. line .. '"')
+
519  fn_magic = nil
+
520  end
+
521  elseif string.find(line,'^function') or string.find(line,'^local%s+function') then
+
522  -- it's a function
+
523  local pos_fn = string.find(line,'function')
+
524  -- function
+
525  -- ....v...
+
526  if pos_fn then
+
527  -- we've got a function
+
528  local fn_type
+
529  if string.find(line,'^local%s+') then
+
530  fn_type = 'static '
+
531  else
+
532  fn_type = ''
+
533  end
+
534  local fn = TString_removeCommentFromLine(string_trim(string.sub(line,pos_fn+8)))
+
535  if fn_magic then
+
536  fn = fn_magic
+
537  fn_magic = nil
+
538  end
+
539 
+
540  if string.sub(fn,1,1)=='(' then
+
541  -- it's an anonymous function
+
542  outStream:writelnComment(line)
+
543  else
+
544  -- fn has a name, so is interesting
+
545 
+
546  -- want to fix for iffy declarations
+
547  local open_paren = string.find(fn,'[%({]')
+
548  local fn0 = fn
+
549  if open_paren then
+
550  fn0 = string.sub(fn,1,open_paren-1)
+
551  -- we might have a missing close paren
+
552  if not string.find(fn,'%)') then
+
553  fn = fn .. ' ___MissingCloseParenHere___)'
+
554  end
+
555  end
+
556 
+
557  local dot = string.find(fn0,'[%.:]')
+
558  if dot then -- it's a method
+
559  local klass = string.sub(fn,1,dot-1)
+
560  local method = string.sub(fn,dot+1)
+
561  --TCore_IO_writeln('function ' .. klass .. '::' .. method .. ftail .. '{}')
+
562  --TCore_IO_writeln(klass .. '::' .. method .. ftail .. '{}')
+
563  outStream:writeln(
+
564  '/*! \\memberof ' .. klass .. ' */ '
+
565  .. method .. '{}'
+
566  )
+
567  else
+
568  -- add vanilla function
+
569 
+
570  outStream:writeln(fn_type .. 'function ' .. fn .. '{}')
+
571  end
+
572  end
+
573  else
+
574  this:warning(inStream:getLineNo(),'something weird here')
+
575  end
+
576  fn_magic = nil -- mustn't indavertently use it again
+
577  elseif string.find(line,'=%s*class%(') then
+
578  -- it's a class declaration
+
579  local tailComment
+
580  line,tailComment = TString_removeCommentFromLine(line)
+
581  local equals = string.find(line,'=')
+
582  local klass = string_trim(string.sub(line,1,equals-1))
+
583  local tail = string_trim(string.sub(line,equals+1))
+
584  -- class(wibble wibble)
+
585  -- ....v.
+
586  local parent = string.sub(tail,7,-2)
+
587  if #parent>0 then
+
588  parent = ' :public ' .. parent
+
589  end
+
590  outStream:writeln('class ' .. klass .. parent .. '{};')
+
591  else
+
592  -- we don't know what this line means, so we can probably just comment it out
+
593  if #line>0 then
+
594  outStream:writeln('// zz: ' .. line)
+
595  else
+
596  outStream:writeln() -- keep this line blank
+
597  end
+
598  end
+
599  end
+
600 
+
601  -- output the tail
+
602  outStream:write_tailLines()
+
603  else
+
604  outStream:writeln('!empty file')
+
605  end
+
606 end
+
607 
+
608 --! \brief this application
+
609 TApp = class()
+
610 
+
611 --! \brief constructor
+
612 function TApp.init(this)
+
613  local t0 = TCore_Clock()
+
614  this.timestamp = t0:getTimeStamp()
+
615  this.name = 'Lua2DoX'
+
616  this.version = '0.2 20130128'
+
617  this.copyright = 'Copyright (c) Simon Dales 2012-13'
+
618 end
+
619 
+
620 function TApp.getRunStamp(this)
+
621  return this.name .. ' (' .. this.version .. ') '
+
622  .. this.timestamp
+
623 end
+
624 
+
625 function TApp.getVersion(this)
+
626  return this.name .. ' (' .. this.version .. ') '
+
627 end
+
628 
+
629 function TApp.getCopyright(this)
+
630  return this.copyright
+
631 end
+
632 
+
633 local This_app = TApp()
+
634 
+
635 --main
+
636 local cl = TCore_Commandline()
+
637 
+
638 local argv1 = cl:getRaw(2)
+
639 if argv1 == '--help' then
+
640  TCore_IO_writeln(This_app:getVersion())
+
641  TCore_IO_writeln(This_app:getCopyright())
+ +
643 run as:
+
644 lua2dox_filter <param>
+
645 --------------
+
646 Param:
+
647  <filename> : interprets filename
+
648  --version : show version/copyright info
+
649  --help : this help text]])
+
650 elseif argv1 == '--version' then
+
651  TCore_IO_writeln(This_app:getVersion())
+
652  TCore_IO_writeln(This_app:getCopyright())
+
653 else
+
654  -- it's a filter
+
655  local appStamp = This_app:getRunStamp()
+
656  local filename = argv1
+
657 
+
658  local filter = TLua2DoX_filter()
+
659  filter:readfile(appStamp,filename)
+
660 end
+
661 
+
662 
+
663 --eof
+
+ + + + diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/nav_f.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/nav_f.png new file mode 100644 index 00000000000..72a58a529ed Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/nav_f.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/nav_g.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/nav_g.png new file mode 100644 index 00000000000..2093a237a94 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/nav_g.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/nav_h.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/nav_h.png new file mode 100644 index 00000000000..33389b101d9 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/nav_h.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/open.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/open.png new file mode 100644 index 00000000000..30f75c7efe2 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/open.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/sync_off.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/sync_off.png new file mode 100644 index 00000000000..3b443fc6289 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/sync_off.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/sync_on.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/sync_on.png new file mode 100644 index 00000000000..e08320fb64e Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/sync_on.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_a.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_a.png new file mode 100644 index 00000000000..3b725c41c5a Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_a.png differ 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 deleted file mode 100644 index 0d623483ffd..00000000000 Binary files a/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_b.gif and /dev/null differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_b.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_b.png new file mode 100644 index 00000000000..5f6601a813b Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_b.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_h.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_h.png new file mode 100644 index 00000000000..fd5cb705488 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_h.png differ 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 deleted file mode 100644 index 9b1e6337c92..00000000000 Binary files a/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_l.gif and /dev/null differ 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 deleted file mode 100644 index ce9dd9f533c..00000000000 Binary files a/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_r.gif and /dev/null differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_s.png b/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_s.png new file mode 100644 index 00000000000..ab478c95b67 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/docs/html/tab_s.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/tabs.css b/Master/texmf-dist/doc/support/lua2dox/docs/html/tabs.css index 95f00a91da3..9cf578f23a1 100644 --- a/Master/texmf-dist/doc/support/lua2dox/docs/html/tabs.css +++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/tabs.css @@ -1,102 +1,60 @@ -/* 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; +.tabs, .tabs2, .tabs3 { + background-image: url('tab_b.png'); + width: 100%; + z-index: 101; + font-size: 13px; + font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; } -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; +.tabs2 { + font-size: 10px; } - -DIV.tabs A:hover -{ - background-position: 100% -150px; +.tabs3 { + font-size: 9px; } -DIV.tabs A:link, DIV.tabs A:visited, -DIV.tabs A:active, DIV.tabs A:hover -{ - color: #1A419D; +.tablist { + margin: 0; + padding: 0; + display: table; } -DIV.tabs SPAN -{ - float : left; - display : block; - background : url("tab_l.gif") no-repeat left top; - padding : 5px 9px; - white-space : nowrap; +.tablist li { + float: left; + display: table-cell; + background-image: url('tab_b.png'); + line-height: 36px; + list-style: none; } -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; +.tablist a { + display: block; + padding: 0 20px; + font-weight: bold; + background-image:url('tab_s.png'); + background-repeat:no-repeat; + background-position:right; + color: #283A5D; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; + outline: none; } -DIV.tabs LI.current A -{ - background-position: 100% -150px; - border-width : 0px; +.tabs3 .tablist a { + padding: 0 10px; } -DIV.tabs LI.current SPAN -{ - background-position: 0% -150px; - padding-bottom : 6px; +.tablist a:hover { + background-image: url('tab_h.png'); + background-repeat:repeat-x; + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); + text-decoration: none; } -DIV.navpath -{ - background : none; - border : none; - border-bottom : 1px solid #84B0C7; +.tablist li.current a { + background-image: url('tab_a.png'); + background-repeat:repeat-x; + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); } diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/Doxyfile b/Master/texmf-dist/doc/support/lua2dox/examples/lua/Doxyfile index 07a22d3f4eb..599848425f2 100644 --- a/Master/texmf-dist/doc/support/lua2dox/examples/lua/Doxyfile +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/Doxyfile @@ -1,224 +1,269 @@ -# Doxyfile 1.5.6 +# Doxyfile 1.8.2 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project +# doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored +# 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 (" ") +# 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 +# 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. +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. 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 +# 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 +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# 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 +# 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. +# 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, Esperanto, 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, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 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). +# 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 +# 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" +# 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 = +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 +# 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 +# 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 +# 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 +# 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. Note that you specify absolute paths here, but also +# relative paths, which will be relative from the directory where doxygen is +# started. + +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 = +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 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system # 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 +# 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 +# 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 +# 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 +# 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 +# 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. +# 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:". +# 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 = +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding +# "class=itcl::class" will allow you to use the command class in the +# itcl::class meaning. -# 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 +TCL_SUBST = + +# 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 +# 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 +# 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 +# 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 +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, +# and language is one of the parsers supported by doxygen: IDL, Java, +# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, +# C++. For instance to make doxygen treat .inc files as Fortran files (default +# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note +# that for custom extensions you also need to set FILE_PATTERNS otherwise the +# files are not read by doxygen. + +EXTENSION_MAPPING = + +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all +# comments according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you +# can mix doxygen, HTML, and XML commands with Markdown formatting. +# Disable only in case of backward compatibilities issues. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented classes, +# or namespaces to their corresponding documentation. Such a link can be +# prevented in individual cases by by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. + +AUTOLINK_SUPPORT = YES + +# 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 makes the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = NO @@ -228,449 +273,542 @@ BUILTIN_STL_SUPPORT = NO 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 +# 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. +# 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 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 +# 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 +# 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 +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# 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 +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +SYMBOL_CACHE_SIZE = 0 + +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given +# their name and scope. Since this can be an expensive process and often the +# same symbol appear multiple times in the code, doxygen keeps a cache of +# pre-resolved symbols. If the cache is too small doxygen will become slower. +# If the cache is too large, memory is wasted. The cache size is given by this +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +LOOKUP_CACHE_SIZE = 0 + #--------------------------------------------------------------------------- # 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 +# 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 +# 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 +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. + +EXTRACT_PACKAGE = 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 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. +# 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. +# 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 namespaces 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. +# 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 +# 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 +# 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 +# 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. +# 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 +# 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 +# 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 +# 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] +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# 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 +# 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 +# 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) +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# 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. +# 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 +# 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 +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = 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 +# 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 +# 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 +# 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 +# The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. -ENABLED_SECTIONS = +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 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro 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 macros 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 +# 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 +# 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 +# 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 , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output +# 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 , where is the value of +# the FILE_VERSION_FILTER tag, and 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 = +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. + +CITE_BIB_FILES = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated +# 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 +# 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 +# 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 +# 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 +# The WARN_NO_PARAMDOC option can be enabled 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 +# 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 +# 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 = +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 +# 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 = +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 +# 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 +# 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++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl 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. +# 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 +# The EXCLUDE tag can be used to specify files and/or directories that should be +# 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. +# Note that relative paths are relative to the directory from which doxygen is +# run. -EXCLUDE = +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 +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system 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 +# 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 = +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, +# 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 = +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 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 = +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 +# 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 = +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. +# 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_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 = +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 , where -# is the value of the INPUT_FILTER tag, and 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 +# 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 , where +# is the value of the INPUT_FILTER tag, and 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 = +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. +# 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 or if +# non of the patterns match the file name, INPUT_FILTER is applied. 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 +# 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 +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + #--------------------------------------------------------------------------- # 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 +# 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 +# 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. +# 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, C++ and Fortran 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 +# 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 +# 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 @@ -678,20 +816,21 @@ 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. +# link to the source code. +# Otherwise they will link to the documentation. 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 +# 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 +# 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 @@ -700,129 +839,201 @@ 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 +# 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 +# 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 +# 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 = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# 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 +# 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 +# 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. +# 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. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +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_HEADER = +HTML_FOOTER = -# 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. +# 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 left blank doxygen will +# generate a default style sheet. Note that it is recommended to use +# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this +# tag will in the future become obsolete. -HTML_FOOTER = +HTML_STYLESHEET = -# 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! +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional +# user-defined cascading style sheet that is included after the standard +# style sheets created by doxygen. Using this option one can overrule +# certain style aspects. This is preferred over using HTML_STYLESHEET +# since it does not replace the standard style sheet and is therefor more +# robust against future updates. Doxygen will copy the style sheet file to +# the output directory. -HTML_STYLESHEET = +HTML_EXTRA_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. +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. -HTML_ALIGN_MEMBERS = YES +HTML_EXTRA_FILES = -# 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. +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. -GENERATE_HTMLHELP = NO +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + +# 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. + +HTML_DYNAMIC_SECTIONS = 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 +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of +# entries shown in the various tree structured indices initially; the user +# can expand and collapse entries dynamically later on. Doxygen will expand +# the tree to such a level that at most the specified number of entries are +# visible (unless a fully collapsed tree already exceeds this amount). +# So setting the number of entries 1 will produce a full collapsed tree by +# default. 0 is a special value representing an infinite number of entries +# and will result in a full expanded tree by default. + +HTML_INDEX_NUM_ENTRIES = 100 + +# 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. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. 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) +# 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 +# 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). +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely +# identify the documentation publisher. This should be a reverse domain-name +# style string, e.g. com.mycompany.MyDocSet.documentation. -HTML_DYNAMIC_SECTIONS = NO +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# 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_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 +# 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 = +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 +# 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 = +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 +# 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 @@ -831,204 +1042,354 @@ GENERATE_CHI = NO # is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. -CHM_INDEX_ENCODING = +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 +# 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 +# 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. +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. -DISABLE_INDEX = NO +GENERATE_QHP = 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. +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. -ENUM_VALUES_PER_LINE = 4 +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = NO # 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. +# If the tag value is set to YES, 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 (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. 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 +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# 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 +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# 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 +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you may also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to +# the MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. +# However, it is strongly recommended to install a local +# copy of MathJax from http://www.mathjax.org before deployment. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = NO + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# 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 +# 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 +# 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. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. 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 +# 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 +# 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 +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, 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 +# 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 = +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 +# 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 = +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! -# 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 +LATEX_FOOTER = + +# 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 +# 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. +# 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.) +# 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 +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + #--------------------------------------------------------------------------- # 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 +# 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 +# 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 +# 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. +# 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 +# Load style sheet 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 = +RTF_STYLESHEET_FILE = -# Set optional variables used in the generation of an rtf document. +# Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. -RTF_EXTENSIONS_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 +# 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 +# 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 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 +# 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 @@ -1037,33 +1398,33 @@ 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 +# 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 +# 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 +# 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 = +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 +# 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 = +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 +# 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 @@ -1072,10 +1433,10 @@ 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 +# 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 @@ -1084,338 +1445,364 @@ 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 +# 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 +# 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 +# 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 +# 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 = +PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# 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 +# 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 +# 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 +# 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. +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when 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 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 = +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 +# 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 = +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 +# 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 = +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. +# 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 that +# overrules the definition found in the source code. -EXPAND_AS_DEFINED = +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. +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# 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 +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. 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. 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 = +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 +# 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 +# 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 +# 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 +# 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. +# 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 also works with HAVE_DOT disabled, but 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 +# 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 = +MSCGEN_PATH = -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented +# 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 +# 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. +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You 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. +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. -DOT_FONTPATH = +DOT_FONTSIZE = 10 -# 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. +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +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 +# 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 +# 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 +# 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 +# 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 +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# managable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + +# 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 +# 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 +# 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 +# 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 +# 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. +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a 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 +# If the DIRECTORY_GRAPH 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. +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). DOT_IMAGE_FORMAT = png -# The tag DOT_PATH can be used to specify the path where the dot tool can be +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# 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 = +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 +# 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 = +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). -# 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 +MSCFILE_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 +# 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). +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. 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) +# 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 +# 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 +# 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/class.lua b/Master/texmf-dist/doc/support/lua2dox/examples/lua/class.lua index 7e155ceb050..7ed245b755e 100644 --- a/Master/texmf-dist/doc/support/lua2dox/examples/lua/class.lua +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/class.lua @@ -27,7 +27,7 @@ --! use as: --! \code{lua} --! TWibble = class() ---! function TWibble:init(instance) +--! function TWibble.init(instance) --! self.instance = instance --! -- more stuff here --! end 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 deleted file mode 100644 index ef52b3662e6..00000000000 --- a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/animals_8lua-source.html +++ /dev/null @@ -1,141 +0,0 @@ - - -Sample Code: animals.lua Source File - - - - - -
Generated on Mon Jun 11 16:15:30 2012 for Sample Code by  - -doxygen 1.5.6
- - 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 index deefb5e17a5..9461a26774a 100644 --- 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 @@ -1,113 +1,143 @@ - - + + + + + Sample Code: animals.lua File Reference - - - - - -
Generated on Mon Jun 11 16:15:30 2012 for Sample Code by  - -doxygen 1.5.6
+ + + 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..329cae63eab --- /dev/null +++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/animals_8lua_source.html @@ -0,0 +1,176 @@ + + + + + +Sample Code: animals.lua Source File + + + + + + +
+
+ + + + + + +
+
Sample Code +  0.1 20120518 +
+
+
+ + + + +
+
+
+
animals.lua
+
+
+Go to the documentation of this file.
1 ---- Copyright 2012 Simon Dales
+
2 --
+
3 -- This work may be distributed and/or modified under the
+
4 -- conditions of the LaTeX Project Public License, either version 1.3
+
5 -- of this license or (at your option) any later version.
+
6 -- The latest version of this license is in
+
7 -- http://www.latex-project.org/lppl.txt
+
8 --
+
9 -- This work has the LPPL maintenance status `maintained'.
+
10 --
+
11 -- The Current Maintainer of this work is Simon Dales.
+
12 --
+
13 
+
14 --[[!
+
15  \file
+
16  \brief test some classes
+
17 
+
18  ]]
+
19 
+
20 require 'class'
+
21 
+
22 --! \brief write to stdout
+
23 function TIO_write(Str)
+
24  if Str then
+
25  io.write(Str)
+
26  end
+
27 end
+
28 
+
29 --! \brief writeln to stdout
+
30 function TIO_writeln(Str)
+
31  if Str then
+
32  io.write(Str)
+
33  end
+
34  io.write('\n')
+
35 end
+
36 
+
37 --! \class Animal
+
38 --! \brief a base class
+
39 Animal = class()
+
40 
+
41 --! \brief constructor
+
42 function Animal.init(this)
+
43  this:setKind('animal')
+
44 end
+
45 
+
46 --! \brief set kind of object
+
47 function Animal.setKind(this,Kind)
+
48  this.kind = Kind
+
49 end
+
50 
+
51 --! \brief say the call of this animal
+
52 function Animal.call(this)
+
53  local speigel = this.speigel
+
54  if speigel then
+
55  speigel = ' says "' .. speigel .. '"'
+
56  else
+
57  speigel = ' <undefined call>'
+
58  end
+
59 
+
60  TIO_writeln(this.kind .. speigel)
+
61 end
+
62 
+
63 --! \brief an abstract bird
+
64 Bird = class(Animal)
+
65 
+
66 --! \brief constructor
+
67 function Bird.init(this)
+
68  Animal.init(this)
+
69  this:setKind('bird')
+
70 end
+
71 
+
72 --! \brief a subclassed bird
+
73 Pigeon = class(Bird)
+
74 
+
75 --! \brief constructor
+
76 function Pigeon.init(this)
+
77  Bird.init(this)
+
78  this:setKind('pigeon')
+
79  this.speigel = 'oh my poor toe Betty'
+
80 end
+
81 
+
82 --! \brief another subclassed bird
+
83 RedKite = class(Bird)
+
84 
+
85 --! \brief constructor
+
86 function RedKite.init(this)
+
87  Bird.init(this)
+
88  this:setKind('red kite')
+
89  this.speigel = 'weee-ooo ee oo ee oo ee oo'
+
90 end
+
91 
+
92 --! \brief a base mammal
+
93 Mammal = class(Animal)
+
94 
+
95 --! \brief constructor
+
96 function Mammal.init(this)
+
97  Animal.init(this)
+
98 end
+
99 
+
100 --! \brief a subclassed mammal
+
101 Cat = class(Mammal)
+
102 
+
103 --! \brief constructor
+
104 function Cat.init(this)
+
105  Mammal.init(this)
+
106  this:setKind('cat')
+
107  this.speigel = 'meow'
+
108 end
+
109 
+
110 --! \brief another subclassed mammal
+
111 Dog = class(Mammal)
+
112 
+
113 --! \brief constructor
+
114 function Dog.init(this)
+
115  Mammal.init(this)
+
116  this:setKind('dog')
+
117  this.speigel = 'woof'
+
118 end
+
119 
+
120 --eof
+
+ + + + 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 index 562b4c6971b..b3ca93abf78 100644 --- 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 @@ -1,39 +1,68 @@ - - + + + + + Sample Code: Class List - - - - - + + diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/bc_s.png b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/bc_s.png new file mode 100644 index 00000000000..224b29aa984 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/bc_s.png differ diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/bdwn.png b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/bdwn.png new file mode 100644 index 00000000000..940a0b95044 Binary files /dev/null and b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/bdwn.png differ 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 index 1eb543d4790..75d6f0c56ef 100644 --- 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 @@ -1,34 +1,63 @@ - - + + + + + Sample Code: Member List - - - - -