Reuh/ubiquitousse
1
0
Fork 0
mirror of https://github.com/Reuh/ubiquitousse.git synced 2025-10-27 17:19:31 +00:00
Code Releases Activity

Improve documentation

Browse source
This commit is contained in:
Étienne Fildadut 2021-12-26 18:13:32 +01:00
parent 489d0b4ba7
commit af3bd51cb3
25 changed files with 1468 additions and 725 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/modules/ubiquitousse.html
View file

@ -103,12 +103,9 @@
</ul>
<p> Regarding the documentation: Ubiquitousse used LDoc/LuaDoc styled-comments, but since LDoc hates me and my code, the
generated result is complete garbage, so please read the documentation directly in the comments here until fix this.
Stuff you're interested in starts with triple &ndash; (e.g., &ldquo;&mdash;&ndash; This functions saves the world&rdquo;).</p>
<p> <em>UPDATE</em>: I give up, currently in the process of admitting defat to LDoc and progressively porting all my documentation to it.
Though I had to modify a few things to get LDoc to like me, so the documentation is generated using <a href="https://github.com/Reuh/LDoc">my LDoc fork</a>.</p>
<p> Regarding the documentation: Ubiquitousse uses LDoc/LuaDoc styled-comments, but since LDoc hates me and my code, the
generated result is mostly garbage, so to generate the documentation you will need to use my <a href="https://github.com/Reuh/LDoc">LDoc fork</a>
which I modified to force LDoc to like me.</p>
<h3>Usage:</h3>
<ul>
<pre class="example">local ubiquitousse = require(&quot;ubiquitousse&quot;)
@ -364,7 +361,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-12-25 23:19:42 </i>
<i style="float:right;">Last updated 2021-12-26 18:13:01 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>