y5nw
/
advtrains-doc-integration
镜像来自 https://codeberg.org/y5nw/advtrains-doc-integration/wiki


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Manual for advtrains_doc_integration</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>Documentation System Integration for Advtrains</h1>


<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>


<h2>Modules</h2>
<ul class="nowrap">
  <li><a href="../modules/advtrains_doc_integration.bc.html">advtrains_doc_integration.bc</a></li>
  <li><strong>advtrains_doc_integration.describe</strong></li>
  <li><a href="../modules/advtrains_doc_integration.hypertext.html">advtrains_doc_integration.hypertext</a></li>
  <li><a href="../modules/advtrains_doc_integration.html">advtrains_doc_integration</a></li>
  <li><a href="../modules/advtrains_doc_integration.latex.html">advtrains_doc_integration.latex</a></li>
  <li><a href="../modules/advtrains_doc_integration.mathutils.html">advtrains_doc_integration.mathutils</a></li>
  <li><a href="../modules/advtrains_doc_integration.utils.html">advtrains_doc_integration.utils</a></li>
</ul>
<h2>Topics</h2>
<ul class="">
  <li><a href="../topics/README.md.html">README</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>advtrains_doc_integration.describe</code></h1>
<p>Describing things.</p>
<p> This module includes functions used for describing things.</p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#conns">conns (conns)</a></td>
	<td class="summary">Describe a conns object</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#mixed_fraction">mixed_fraction (int, num, denom)</a></td>
	<td class="summary">Describe a (mixed) fraction</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#length">length (x)</a></td>
	<td class="summary">Describe a short length (using mm and in).</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#speed">speed (x)</a></td>
	<td class="summary">Describe a speed value (using m/s, km/h and mph).</td>
	</tr>
</table>

<br/>
<br/>


    <h2 class="section-header "><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "conns"></a>
    <strong>conns (conns)</strong>
    </dt>
    <dd>
    Describe a conns object


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">conns</span>
            <span class="types"><a class="type" href="https://git.bananach.space/advtrains.git/tree/advtrains/api_doc.txt">advtrains.conns</a> or <a class="type" href="https://git.bananach.space/advtrains.git/tree/advtrains/api_doc.txt">{advtrains.conns,number,...}</a></span>
         The conns object to describe.
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a> or <span class="type">nil</span></span>
        The description of the conns object.
    </ol>


</dd>
    <dt>
    <a name = "mixed_fraction"></a>
    <strong>mixed_fraction (int, num, denom)</strong>
    </dt>
    <dd>
    Describe a (mixed) fraction


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">int</span>
            <span class="types"><span class="type">integer</span></span>
         The integer part of the number.
        </li>
        <li><span class="parameter">num</span>
            <span class="types"><span class="type">integer</span></span>
         The numerator.
        </li>
        <li><span class="parameter">denom</span>
            <span class="types"><span class="type">integer</span></span>
         The denominator.
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
        The description of the mixed fraction.
    </ol>


</dd>
    <dt>
    <a name = "length"></a>
    <strong>length (x)</strong>
    </dt>
    <dd>
    Describe a short length (using mm and in).


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">x</span>
            <span class="types"><span class="type">number</span></span>
         The length in meters.
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
        The description of the length.
    </ol>


</dd>
    <dt>
    <a name = "speed"></a>
    <strong>speed (x)</strong>
    </dt>
    <dd>
    Describe a speed value (using m/s, km/h and mph).


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">x</span>
            <span class="types"><span class="type">number</span></span>
         The speed in m/s.
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
        The description of the speed.
    </ol>


</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2024-01-29 22:34:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>