summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua.html
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua.html')
-rw-r--r--Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua.html891
1 files changed, 891 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua.html b/Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua.html
new file mode 100644
index 00000000000..3d6ae4e376c
--- /dev/null
+++ b/Master/texmf-dist/doc/support/lua2dox/docs/html/lua2dox_8lua.html
@@ -0,0 +1,891 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Lua2dox.lua: lua2dox.lua File Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.6 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li class="current"><a href="files.html"><span>Files</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>lua2dox.lua File Reference</h1>a hack lua2dox converter <a href="#_details">More...</a>
+<p>
+
+<p>
+<a href="lua2dox_8lua-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#a8d8cb1164baddf56a0f4ef092205c4e">TApp_get_appname</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get appname <a href="#a8d8cb1164baddf56a0f4ef092205c4e"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#74b88070bd5a95792a78d7689683bbc5">TApp_lua2dox</a> (FileContents)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">hack converter from lua to a pseudoC-ish language for doxygen <a href="#74b88070bd5a95792a78d7689683bbc5"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#ee20d6bfef623e5b2c79724b9f678f34">TApp_run_doxygen</a> (AppTimestamp, Argv, CommentaryFiles)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">run doxygen for one <a href="#ee20d6bfef623e5b2c79724b9f678f34"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#df242b2b881a8435694df310f4c4d4c8">TApp_run_filter</a> (AppTimestamp, Filename, CommentaryFiles)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">run the filter <a href="#df242b2b881a8435694df310f4c4d4c8"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#733cdf7057ec0d5b75d3fb75c53ca1a8">TClassList_method_add</a> (Klass, Method)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">add a method to list of known methods <a href="#733cdf7057ec0d5b75d3fb75c53ca1a8"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#5b7b06ae331027a06a3fc06b57d85d17">TClassList_method_get</a> (Klass)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get methods <a href="#5b7b06ae331027a06a3fc06b57d85d17"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#19a8b481c5a12ffc3f25401650906ce9">TClock_GetTimeNow</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get the current time <a href="#19a8b481c5a12ffc3f25401650906ce9"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#3fd5846eddbb7ec9f76d5ce2357c0e88">TClock_getTimeStamp</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get a timestamp <a href="#3fd5846eddbb7ec9f76d5ce2357c0e88"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#09cdc805182dbf41bbb112a070d7f8d3">TCommandline_getargv</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">setup the commandline now <a href="#09cdc805182dbf41bbb112a070d7f8d3"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#bee561867bc98123cb2b32cd4fcdd194">TCommandline_setup</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">setup/parse the commandline <a href="#bee561867bc98123cb2b32cd4fcdd194"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#190a7dd20e13556bfc965ecb0e1daead">TCommentary_addMethod</a> (Klass, Method)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">method to save file <a href="#190a7dd20e13556bfc965ecb0e1daead"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#6ee37dbd5aa2492ec864bab74cef9353">TCommentary_close</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">close the methods save file <a href="#6ee37dbd5aa2492ec864bab74cef9353"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#d8f4828fcd44acdd083644d9a62a4634">TCommentary_open</a> (Filename, InputLuaFilename)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">open the commentary save file <a href="#d8f4828fcd44acdd083644d9a62a4634"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#0745f5bf0c673993c099aa4698f63b3e">TCommentary_readFileContents</a> (Filename)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">read stuff from save file <a href="#0745f5bf0c673993c099aa4698f63b3e"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#11e685141b538df2a4a7ca9383e59b51">TCommentary_writeln</a> (Str)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">write to output file <a href="#11e685141b538df2a4a7ca9383e59b51"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#e5e473269b2227008c0f13a56ed2e813">TConfig_get</a> (Key, Default)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets a config val. <a href="#e5e473269b2227008c0f13a56ed2e813"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#6d8afe836be7511dd5149c14710b274b">TConfig_set</a> (Key, Val)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">sets a config val <a href="#6d8afe836be7511dd5149c14710b274b"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#a73dd4ef7ce5825633598152540e5c00">TIO_out2stream</a> (Line)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">output line to stream <a href="#a73dd4ef7ce5825633598152540e5c00"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#8f7d772cf375b991ed20c07eaa77c2bd">TIO_out2stream_commented</a> (Line, Prefix, Suffix)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">suppress line <a href="#8f7d772cf375b991ed20c07eaa77c2bd"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#383b6fb624afb857097cbbc1d5520ffa">TIO_showError</a> (Err, Str)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">show error to stdout <a href="#383b6fb624afb857097cbbc1d5520ffa"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#d0e8552aa4af17b3d2b59bf0abd352a2">TIO_write</a> (Str)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">write to stdout <a href="#d0e8552aa4af17b3d2b59bf0abd352a2"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#29f2cc64b69b929d83a5e004340291c5">TIO_writeln</a> (Str)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">write to stdout <a href="#29f2cc64b69b929d83a5e004340291c5"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#ffdf3f8e4c73a649c71763128e3cf129">TOS_fileExists</a> (Filename)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">does file exist? <a href="#ffdf3f8e4c73a649c71763128e3cf129"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#1bda95a5b1b0216dc2ec005846137653">TOS_system</a> (Cmd)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">run system command <a href="#1bda95a5b1b0216dc2ec005846137653"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#7c90afc5e8c521ab4a5cc6515e101e53">TString_removeCommentFromLine</a> (Line)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">trim comment off end of string <a href="#7c90afc5e8c521ab4a5cc6515e101e53"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#30ee7784cec05b0340a0a2ab3ad25f0d">TString_split</a> (Str, Pattern)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">split a string <a href="#30ee7784cec05b0340a0a2ab3ad25f0d"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">local function&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lua2dox_8lua.html#0cbbd73f5feb3232120247f9f8707c3e">TString_trim</a> (Str)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">trims a string from both ends <a href="#0cbbd73f5feb3232120247f9f8707c3e"></a><br></td></tr>
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+a hack lua2dox converter
+<p>
+
+<p>Definition in file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="a8d8cb1164baddf56a0f4ef092205c4e"></a><!-- doxytag: member="lua2dox.lua::TApp_get_appname" ref="a8d8cb1164baddf56a0f4ef092205c4e" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TApp_get_appname </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+get appname
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00378">378</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="74b88070bd5a95792a78d7689683bbc5"></a><!-- doxytag: member="lua2dox.lua::TApp_lua2dox" ref="74b88070bd5a95792a78d7689683bbc5" args="(FileContents)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TApp_lua2dox </td>
+ <td>(</td>
+ <td class="paramtype">FileContents&nbsp;</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+hack converter from lua to a pseudoC-ish language for doxygen
+<p>
+This is a hack to make lua readable to doxygen.<p>
+It works well enough to document functions/methods and classes, but not assignments. Our pseudo-C gets confused if we allow assginments to be shown. Because these are less interesting than class/functions/methods I have decided to live with this limitation.
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00391">391</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="ee20d6bfef623e5b2c79724b9f678f34"></a><!-- doxytag: member="lua2dox.lua::TApp_run_doxygen" ref="ee20d6bfef623e5b2c79724b9f678f34" args="(AppTimestamp, Argv, CommentaryFiles)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TApp_run_doxygen </td>
+ <td>(</td>
+ <td class="paramtype">AppTimestamp&nbsp;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">Argv&nbsp;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">CommentaryFiles&nbsp;</td>
+ <td class="paramname"></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+run doxygen for one
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>AppTimestamp</em>&nbsp;</td><td>application + timestamp for this run </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>Argv</em>&nbsp;</td><td>commandline for this run </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>CommentaryFiles</em>&nbsp;</td><td>names of commentary files </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>err or nil </dd></dl>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00558">558</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="df242b2b881a8435694df310f4c4d4c8"></a><!-- doxytag: member="lua2dox.lua::TApp_run_filter" ref="df242b2b881a8435694df310f4c4d4c8" args="(AppTimestamp, Filename, CommentaryFiles)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TApp_run_filter </td>
+ <td>(</td>
+ <td class="paramtype">AppTimestamp&nbsp;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">Filename&nbsp;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">CommentaryFiles&nbsp;</td>
+ <td class="paramname"></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+run the filter
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>AppTimestamp</em>&nbsp;</td><td>application + timestamp for this run </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>Filename</em>&nbsp;</td><td>the filename or if nil stdin </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>CommentaryFiles</em>&nbsp;</td><td>names of commentary files </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>err or nil </dd></dl>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00519">519</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="733cdf7057ec0d5b75d3fb75c53ca1a8"></a><!-- doxytag: member="lua2dox.lua::TClassList_method_add" ref="733cdf7057ec0d5b75d3fb75c53ca1a8" args="(Klass, Method)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TClassList_method_add </td>
+ <td>(</td>
+ <td class="paramtype">Klass&nbsp;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">Method&nbsp;</td>
+ <td class="paramname"></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+add a method to list of known methods
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00236">236</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="5b7b06ae331027a06a3fc06b57d85d17"></a><!-- doxytag: member="lua2dox.lua::TClassList_method_get" ref="5b7b06ae331027a06a3fc06b57d85d17" args="(Klass)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TClassList_method_get </td>
+ <td>(</td>
+ <td class="paramtype">Klass&nbsp;</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+get methods
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00231">231</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="19a8b481c5a12ffc3f25401650906ce9"></a><!-- doxytag: member="lua2dox.lua::TClock_GetTimeNow" ref="19a8b481c5a12ffc3f25401650906ce9" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TClock_GetTimeNow </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+get the current time
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00167">167</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="3fd5846eddbb7ec9f76d5ce2357c0e88"></a><!-- doxytag: member="lua2dox.lua::TClock_getTimeStamp" ref="3fd5846eddbb7ec9f76d5ce2357c0e88" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TClock_getTimeStamp </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+get a timestamp
+<p>
+not strictly necessary here but lets us put a timestamp on the end of the output stream. Note that doxygen won't read this, and being off the end of the true file length (num lines), it will have no effect. However it lets us check the output file tail when debugging.
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00182">182</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="09cdc805182dbf41bbb112a070d7f8d3"></a><!-- doxytag: member="lua2dox.lua::TCommandline_getargv" ref="09cdc805182dbf41bbb112a070d7f8d3" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TCommandline_getargv </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+setup the commandline now
+<p>
+get commandline args
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00373">373</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="bee561867bc98123cb2b32cd4fcdd194"></a><!-- doxytag: member="lua2dox.lua::TCommandline_setup" ref="bee561867bc98123cb2b32cd4fcdd194" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TCommandline_setup </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+setup/parse the commandline
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00352">352</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="190a7dd20e13556bfc965ecb0e1daead"></a><!-- doxytag: member="lua2dox.lua::TCommentary_addMethod" ref="190a7dd20e13556bfc965ecb0e1daead" args="(Klass, Method)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TCommentary_addMethod </td>
+ <td>(</td>
+ <td class="paramtype">Klass&nbsp;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">Method&nbsp;</td>
+ <td class="paramname"></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+method to save file
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00316">316</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="6ee37dbd5aa2492ec864bab74cef9353"></a><!-- doxytag: member="lua2dox.lua::TCommentary_close" ref="6ee37dbd5aa2492ec864bab74cef9353" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TCommentary_close </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+close the methods save file
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00266">266</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="d8f4828fcd44acdd083644d9a62a4634"></a><!-- doxytag: member="lua2dox.lua::TCommentary_open" ref="d8f4828fcd44acdd083644d9a62a4634" args="(Filename, InputLuaFilename)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TCommentary_open </td>
+ <td>(</td>
+ <td class="paramtype">Filename&nbsp;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">InputLuaFilename&nbsp;</td>
+ <td class="paramname"></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+open the commentary save file
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00257">257</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="0745f5bf0c673993c099aa4698f63b3e"></a><!-- doxytag: member="lua2dox.lua::TCommentary_readFileContents" ref="0745f5bf0c673993c099aa4698f63b3e" args="(Filename)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TCommentary_readFileContents </td>
+ <td>(</td>
+ <td class="paramtype">Filename&nbsp;</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+read stuff from save file
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00275">275</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="11e685141b538df2a4a7ca9383e59b51"></a><!-- doxytag: member="lua2dox.lua::TCommentary_writeln" ref="11e685141b538df2a4a7ca9383e59b51" args="(Str)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TCommentary_writeln </td>
+ <td>(</td>
+ <td class="paramtype">Str&nbsp;</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+write to output file
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00249">249</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="e5e473269b2227008c0f13a56ed2e813"></a><!-- doxytag: member="lua2dox.lua::TConfig_get" ref="e5e473269b2227008c0f13a56ed2e813" args="(Key, Default)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TConfig_get </td>
+ <td>(</td>
+ <td class="paramtype">Key&nbsp;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">Default&nbsp;</td>
+ <td class="paramname"></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Gets a config val.
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00099">99</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="6d8afe836be7511dd5149c14710b274b"></a><!-- doxytag: member="lua2dox.lua::TConfig_set" ref="6d8afe836be7511dd5149c14710b274b" args="(Key, Val)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TConfig_set </td>
+ <td>(</td>
+ <td class="paramtype">Key&nbsp;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">Val&nbsp;</td>
+ <td class="paramname"></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+sets a config val
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00108">108</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="a73dd4ef7ce5825633598152540e5c00"></a><!-- doxytag: member="lua2dox.lua::TIO_out2stream" ref="a73dd4ef7ce5825633598152540e5c00" args="(Line)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TIO_out2stream </td>
+ <td>(</td>
+ <td class="paramtype">Line&nbsp;</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+output line to stream
+<p>
+Wraps IO_writeln()
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00331">331</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="8f7d772cf375b991ed20c07eaa77c2bd"></a><!-- doxytag: member="lua2dox.lua::TIO_out2stream_commented" ref="8f7d772cf375b991ed20c07eaa77c2bd" args="(Line, Prefix, Suffix)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TIO_out2stream_commented </td>
+ <td>(</td>
+ <td class="paramtype">Line&nbsp;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">Prefix&nbsp;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">Suffix&nbsp;</td>
+ <td class="paramname"></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+suppress line
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00336">336</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="383b6fb624afb857097cbbc1d5520ffa"></a><!-- doxytag: member="lua2dox.lua::TIO_showError" ref="383b6fb624afb857097cbbc1d5520ffa" args="(Err, Str)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TIO_showError </td>
+ <td>(</td>
+ <td class="paramtype">Err&nbsp;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">Str&nbsp;</td>
+ <td class="paramname"></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+show error to stdout
+<p>
+writelns Str (if not nil) and then an eoln.
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00134">134</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="d0e8552aa4af17b3d2b59bf0abd352a2"></a><!-- doxytag: member="lua2dox.lua::TIO_write" ref="d0e8552aa4af17b3d2b59bf0abd352a2" args="(Str)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TIO_write </td>
+ <td>(</td>
+ <td class="paramtype">Str&nbsp;</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+write to stdout
+<p>
+writes Str (if not nil)
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00115">115</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="29f2cc64b69b929d83a5e004340291c5"></a><!-- doxytag: member="lua2dox.lua::TIO_writeln" ref="29f2cc64b69b929d83a5e004340291c5" args="(Str)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TIO_writeln </td>
+ <td>(</td>
+ <td class="paramtype">Str&nbsp;</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+write to stdout
+<p>
+writelns Str (if not nil) and then an eoln.
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00124">124</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="ffdf3f8e4c73a649c71763128e3cf129"></a><!-- doxytag: member="lua2dox.lua::TOS_fileExists" ref="ffdf3f8e4c73a649c71763128e3cf129" args="(Filename)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TOS_fileExists </td>
+ <td>(</td>
+ <td class="paramtype">Filename&nbsp;</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+does file exist?
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00157">157</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="1bda95a5b1b0216dc2ec005846137653"></a><!-- doxytag: member="lua2dox.lua::TOS_system" ref="1bda95a5b1b0216dc2ec005846137653" args="(Cmd)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TOS_system </td>
+ <td>(</td>
+ <td class="paramtype">Cmd&nbsp;</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+run system command
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00146">146</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="7c90afc5e8c521ab4a5cc6515e101e53"></a><!-- doxytag: member="lua2dox.lua::TString_removeCommentFromLine" ref="7c90afc5e8c521ab4a5cc6515e101e53" args="(Line)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TString_removeCommentFromLine </td>
+ <td>(</td>
+ <td class="paramtype">Line&nbsp;</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+trim comment off end of string
+<p>
+If the string has a comment on the end, this trims it off.
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00221">221</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="30ee7784cec05b0340a0a2ab3ad25f0d"></a><!-- doxytag: member="lua2dox.lua::TString_split" ref="30ee7784cec05b0340a0a2ab3ad25f0d" args="(Str, Pattern)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TString_split </td>
+ <td>(</td>
+ <td class="paramtype">Str&nbsp;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">Pattern&nbsp;</td>
+ <td class="paramname"></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+split a string
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>Str</em>&nbsp;</td><td></td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>Pattern</em>&nbsp;</td><td></td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>table of string fragments </dd></dl>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00198">198</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="0cbbd73f5feb3232120247f9f8707c3e"></a><!-- doxytag: member="lua2dox.lua::TString_trim" ref="0cbbd73f5feb3232120247f9f8707c3e" args="(Str)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">local function TString_trim </td>
+ <td>(</td>
+ <td class="paramtype">Str&nbsp;</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+trims a string from both ends
+<p>
+
+<p>Definition at line <a class="el" href="lua2dox_8lua-source.html#l00189">189</a> of file <a class="el" href="lua2dox_8lua-source.html">lua2dox.lua</a>.</p>
+
+</div>
+</div><p>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 4 18:43:04 2012 for Lua2dox.lua by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
+</body>
+</html>