Skip to content

Add a lua example #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rottmann merged 1 commit into from
Aug 3, 2017
Merged

Add a lua example #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ <h3>apiDoc creates a documentation from API annotations in your source code.</h3
<li title="Perl">Perl</li>
<li title="Python">Python</li>
<li title="Ruby">Ruby</li>
<li title="Lua">Lua</li>
</ul>
<div class="resp-tabs-container">
<!-- Tab 1 -->
Expand Down Expand Up @@ -137,6 +138,20 @@ <h3>apiDoc creates a documentation from API annotations in your source code.</h3
@apiSuccess {String} lastname Lastname of the User.
=end</code></pre>
</div>

<!-- Tab Lua -->
<div>
<pre class="example"><code>--[[
@api {get} /user/:id Request User information
@apiName GetUser
@apiGroup User

@apiParam {Number} id Users unique ID.

@apiSuccess {String} firstname Firstname of the User.
@apiSuccess {String} lastname Lastname of the User.
--]]</code></pre>
</div>
</div>
</div>

Expand Down Expand Up @@ -267,6 +282,12 @@ <h2>Preface</h2>
<pre class="example"><code>=begin
This is a comment.
=end</code></pre>

<p>Lua</p>
<pre class="example"><code>--[[
This is a comment.
--]]</code></pre>

</article>

<article id="install">
Expand Down