examples updated

This commit is contained in:
steve donovan 2011-07-06 11:49:50 +02:00
parent efd03cccb3
commit c1c507c2a7
2 changed files with 23 additions and 9 deletions

View File

@ -48,7 +48,7 @@
<ul>
# for kind, items in module.kinds() do
# for item in items() do
<li><a href="$(item.name)">$(display_name(item))</a></li>
<li><a href="#$(item.name)">$(display_name(item))</a></li>
# end
# end
</ul>

View File

@ -1,25 +1,39 @@
--[[-----------
testing underscores
testing underscores and Markdown pre-formatting.
A list may immediately follow a line, if it is indented. Necessary lines
will also be inserted after resuming current indentation.
- a list
* sublist
* more
- sublist (note the needed indentation for Markdown to recognize this)
- more
* of items
more than one line
- indeed
can keep going
Look at <<_ONE_>> and <<table.concat>>
Inline _see references_: look at <_ONE_> and <table.concat>.
Indented code blocks may also follow immediately.
function test(a,b)
return three(a,b)
end
@module underscore
]]
----------
-- A function (<<_TWO_>>).
-- @see _TWO_
-- A function.
-- Can also use <_TWO_>
function _ONE_() end
-----------
-- another function
-- @see string.format
function _TWO_() end
------
-- a longer summary.
-- @param a
-- @param b
-- @return one
-- - one-1
-- - one-2
-- @return two
function three(a,b) end