examples of syntax highlighting in function @usage blocks; 'static' member functions
This commit is contained in:
parent
95f293e67e
commit
987c5fbc9c
|
@ -0,0 +1,5 @@
|
||||||
|
project = 'usage'
|
||||||
|
file = 'usage.lua'
|
||||||
|
format='markdown'
|
||||||
|
no_return_or_parms=true
|
||||||
|
no_summary=true
|
|
@ -0,0 +1,38 @@
|
||||||
|
--[[--------
|
||||||
|
A simple module with examples.
|
||||||
|
|
||||||
|
@module usage
|
||||||
|
]]
|
||||||
|
|
||||||
|
local usage = {}
|
||||||
|
|
||||||
|
----------
|
||||||
|
-- A simple vector class
|
||||||
|
-- @type Vector
|
||||||
|
|
||||||
|
local Vector = {}
|
||||||
|
usage.Vector = {}
|
||||||
|
|
||||||
|
----------
|
||||||
|
-- Create a vector from an array `t`.
|
||||||
|
function Vector.new (t)
|
||||||
|
end
|
||||||
|
|
||||||
|
----------
|
||||||
|
-- Create a vector from a string.
|
||||||
|
-- @usage
|
||||||
|
-- v = Vector.parse '[1,2,3]'
|
||||||
|
-- assert (v == Vector.new {1,2,3})
|
||||||
|
function Vector.parse (s)
|
||||||
|
end
|
||||||
|
|
||||||
|
----------
|
||||||
|
-- Add another vector, array or scalar `v` to this vector.
|
||||||
|
-- Returns new `Vector`
|
||||||
|
-- @usage assert(Vector.new{1,2,3}:add(1) == Vector{2,3,4})
|
||||||
|
function Vector:add (v)
|
||||||
|
end
|
||||||
|
|
||||||
|
return usage
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue