1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>LuaDoc: Documentation Generator Tool for the Lua language</title>
<link rel="stylesheet" href="http://www.keplerproject.org/doc.css" type="text/css" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"><a href="http://www.keplerproject.org">
<img alt="LuaDoc logo" src="lua.png"/>
</a></div>
<div id="product_name"><big><b>LuaDoc</b></big></div>
<div id="product_description">Documentation Generator Tool for the Lua language</div>
</div> <!-- id="product" -->
<div id="main">
<div id="navigation">
<h1>LuaDoc</h1>
<ul>
<li><a href="index.html">Home</a>
<ul>
<li><a href="index.html#overview">Overview</a></li>
<li><a href="index.html#status">Status</a></li>
<li><a href="index.html#download">Download</a></li>
<li><a href="index.html#dependencies">Dependencies</a></li>
<li><a href="index.html#history">History</a></li>
<li><a href="index.html#credits">Credits</a></li>
<li><a href="index.html#contact">Contact us</a></li>
</ul>
</li>
<li><a href="manual.html">Manual</a>
<ul>
<li><a href="manual.html#introduction">Introduction</a></li>
<li><a href="manual.html#installation">Installation</a></li>
<li><a href="manual.html#howto">How to</a></li>
<li><a href="manual.html#tags">Tags</a></li>
<li><a href="manual.html#options">Options</a></li>
</ul>
</li>
<li><a href="architecture.html">Customizing</a>
<ul>
<li><a href="architecture.html#architecture">Architecture</a></li>
<li><a href="architecture.html#taglet">Taglet</a></li>
<li><a href="architecture.html#documentation">Documentation</a></li>
<li><a href="architecture.html#doclet">Doclet</a></li>
</ul>
</li>
<li><strong>Examples</strong></li>
<li><a href="http://luaforge.net/projects/luadoc/">Project</a>
<ul>
<li><a href="http://luaforge.net/tracker/?group_id=18">Bug Tracker</a></li>
<li><a href="http://luaforge.net/scm/?group_id=18">CVS</a></li>
</ul>
</li>
<li><a href="license.html">License</a></li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h2><a name="examples">Examples</a></h2>
<p>
A documentation example is LuaDoc own source code and the generated documentation.
The source code can be browsed from the
<a href="http://luaforge.net/scm/?group_id=18">CVS</a> repository. The generated
documentation can be browsed <a href="api/index.html">online</a>.
</p>
<p>
You can also document a Lua library which is written in C. To do that simply write a file
with the <code>.luadoc</code> extension and define the function prototypes with
the documentation comments. This file will be parsed by LuaDoc and the documentation
will be generated.
</p>
<p>
As an example the <a href="http://www.keplerproject.org/luafilesystem">LuaFileSystem</a>
API was defined in a file called <a href="examples/lfs/lfs.luadoc"><code>lfs.luadoc</code></a>.
The generated documentation can be browsed <a href="examples/lfs/index.html">online</a>.
</p>
<p>
<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>
</p>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
<p><small>$Id: examples.html,v 1.3 2007/08/13 15:32:45 carregal Exp $</small></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
|
