luadocumentor/template/functiontypedef.lua at 9d8aef79ad3656014f644477a839ff478f93d625 · LuaDevelopmentTools/luadocumentor · GitHub

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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
--------------------------------------------------------------------------------
--  Copyright (c) 2012 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:
--       Kevin KIN-FOO <kkinfoo@sierrawireless.com>
--           - initial API and implementation and initial documentation
--------------------------------------------------------------------------------
return [[#
# local fdef = _functiontypedef
# local ignorefirstparam = templateparams[1]
# local ignoredescription = templateparams[2]
#
#if not ignoredescription then
# if fdef.shortdescription then
  $( format(fdef.shortdescription) )
# end
# if fdef.description and #fdef.description > 0 then
  $( format(fdef.description) )
# end
#end
# --
# -- Describe parameters
# --
#
#
# -- Adjust parameter count if first one is 'self'
# local paramcount
# if #fdef.params > 0 and ignorefirstparam then
#   paramcount = #fdef.params - 1
# else
#   paramcount = #fdef.params
# end
#
# -- List parameters
# if paramcount > 0 then
    <h$(i)>Parameter$( paramcount > 1 and 's' )</h$(i)>
    <ul>
#   for position, param in ipairs( fdef.params ) do
#     if not (position == 1 and ignorefirstparam) then
        <li>
#       local paramline = "<code><em>"
#       if param.type then
#         local link = linkto( param.type )
#         local name = purename( param.type )
#         if link then
#           paramline = paramline .. '<a href=\"' .. link .. '\">' .. name .. "</a>"
#         else
#           paramline = paramline .. name
#         end
#       end
#
#       paramline = paramline .. " " .. param.name ..  " "
#
#       if param.optional then
#         paramline = paramline .. "optional" .. " "
#       end
#       if param.hidden then
#         paramline = paramline .. "hidden"
#       end
#
#         paramline = paramline .. "</em></code>: "
#
#       if param.description and #param.description > 0 then
#         paramline = paramline .. "\n" .. param.description
#       end
#
        $( format (paramline))
        </li>
#     end
#   end
    </ul>
# end
#
# --
# -- Describe returns types
# --
# if fdef and #fdef.returns > 0 then
    <h$(i)>Return value$(#fdef.returns > 1 and 's')</h$(i)>
#   --
#   -- Format nice type list
#   --
#   local function niceparmlist( parlist )
#     local typelist = {}
#     for position, type in ipairs(parlist) do
#       local link = linkto( type )
#       local name = prettyname( type )
#       if link then
#         typelist[#typelist + 1] = '<a href="'..link..'">'..name..'</a>'
#       else
#         typelist[#typelist + 1] = name
#       end
#       -- Append end separator or separating comma
#       typelist[#typelist + 1] = position == #parlist and ':' or ', '
#     end
#     return table.concat( typelist )
#   end
#   --
#   -- Generate a list if they are several return clauses
#   --
#   if #fdef.returns > 1 then
      <ol>
#     for position, ret in ipairs(fdef.returns) do
        <li>
#       local returnline = "";
#
#       local paramlist = niceparmlist(ret.types)
#       if #ret.types > 0 and #paramlist > 0 then
#         returnline = "<em>" .. paramlist .. "</em>"
#       end
#       returnline = returnline .. "\n" .. ret.description
        $( format (returnline))
        </li>
#     end
      </ol>
#   else
#     local paramlist = niceparmlist(fdef.returns[1].types)
#     local isreturn = fdef.returns and #fdef.returns > 0 and #paramlist > 0
#     local isdescription = fdef.returns and fdef.returns[1].description and #format(fdef.returns[1].description) > 0
#
#       local returnline = "";
#     -- Show return type if provided
#     if isreturn then
#       returnline = "<em>"..paramlist.."</em>"
#     end
#     if isdescription then
#       returnline = returnline .. "\n" .. fdef.returns[1].description
#     end
        $( format(returnline))
#   end
# end
#
#--
#-- Show usage samples
#--
#if fdef.metadata and fdef.metadata.usage then
  $( applytemplate(fdef.metadata.usage, i) )
#end
]]