mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
This is an important refactor of the way documentation generation works
* Installs luarocks WITH it's executable (easy to install other rocks if necessary) * Use Lua supplied with luarocks * Create Utils/luadocumentor.bat, which works with RELATIVE PATH ! -> Everybody can generate the doc * Updated launch files accordingly
This commit is contained in:
33
Utils/luarocks/systree/share/lua/5.1/template/usage.lua
Normal file
33
Utils/luarocks/systree/share/lua/5.1/template/usage.lua
Normal file
@@ -0,0 +1,33 @@
|
||||
--------------------------------------------------------------------------------
|
||||
-- Copyright (c) 2012-2014 Sierra Wireless.
|
||||
-- All rights reserved. This program and the accompanying materials
|
||||
-- are made available under the terms of the Eclipse Public License v1.0
|
||||
-- which accompanies this distribution, and is available at
|
||||
-- http://www.eclipse.org/legal/epl-v10.html
|
||||
--
|
||||
-- Contributors:
|
||||
-- Marc AUBRY <maubry@sierrawireless.com>
|
||||
-- - initial API and implementation
|
||||
--------------------------------------------------------------------------------
|
||||
return[[#
|
||||
#--
|
||||
#-- Show usage samples
|
||||
#--
|
||||
#if _usage then
|
||||
# if #_usage > 1 then
|
||||
# -- Show all usages
|
||||
<h$(i)>Usages:</h$(i)>
|
||||
<ul>
|
||||
# -- Loop over several usage description
|
||||
# for _, usage in ipairs(_usage) do
|
||||
<li><pre class="example"><code>$( securechevrons(usage.description) )</code></pre></li>
|
||||
# end
|
||||
</ul>
|
||||
# elseif #_usage == 1 then
|
||||
# -- Show unique usage sample
|
||||
<h$(i)>Usage:</h$(i)>
|
||||
# local usage = _usage[1]
|
||||
<pre class="example"><code>$( securechevrons(usage.description) )</code></pre>
|
||||
# end
|
||||
#end
|
||||
#]]
|
||||
Reference in New Issue
Block a user