LDoc/html/ldoc.ltp at 0.4.2 · hishamhm/LDoc

Repository navigation

History

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

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html>

<head>

<title>$(ldoc.title)</title>

</head>

<body>

</div>

# local iter = ldoc.modules.iter

# local M = ldoc.markup

# local function no_spaces(s) return s:gsub('%s','_') end

<h1>$(ldoc.project)</h1>

# if not ldoc.single then

<ul>

<li><a href="../index.html">Index</a></li>

</ul>

# else

<p>$(ldoc.description)</p>

# end

# if module then

<h2>Contents</h2>

<ul>

# for kind,items in module.kinds() do

# end

</ul>

# end

# for kind, mods, type in ldoc.kinds() do

<ul>

# local this_mod = module and module.name

# local base = ""

# kind = kind:lower()

# if module then

# if module.type ~= type then base = "../"..kind.."/" end

# else base = kind.."/"

# end

# for mod in mods() do

# if mod.name == this_mod then

# else

# end

#end

</ul>

# end

</div>

# if module then

<h1>Module <code>$(module.name)</code></h1>

# local function use_li(ls)

# if #ls > 1 then return '<li>','</li>' else return '','' end

# end

# local function display_name(item)

# if item.type == 'function' then return item.name..' '..item.args

# else return item.name end

# end

<p>$(M(module.summary))</p>

<p>$(M(module.description))</p>

# -- bang out the tables of item types for this module (e.g Functions, Tables, etc)

# for kind,items in module.kinds() do

# for item in items() do

<tr>

<td class="name" nowrap><a href="#$(item.name)">$(display_name(item))</a></td>

<td class="summary">$(M(item.summary))</td>

</tr>

# end -- for items

</table>

#end -- for kinds

<br/>

# --- currently works for both Functions and Tables. The params field either contains

# --- function parameters or table fields.

# for kind, items in module.kinds() do

$(M(module.kinds:get_section_description(kind)))

# for item in items() do

<dt>

<strong>$(display_name(item))</strong>

</dt>

<dd>

$(M(item.summary))

$(M(item.description))

# if item.params and #item.params > 0 then

<h3>$(module.kinds:type_of(item).subnames):</h3>

<ul>

# for p in iter(item.params) do

<li><code><em>$(p)</em></code>: $(M(item.params[p]))</li>

# end -- for

</ul>

# end -- if params

# if item.usage then

# local li,il = use_li(item.usage)

<h3>Usage:</h3>

<ul>

# for usage in iter(item.usage) do

$(li)<pre class="example">$(usage)</pre>$(il)

# end -- for

</ul>

# end -- if usage

# if item.ret then

# local li,il = use_li(item.ret)

<h3>Returns:</h3>

<ol>

# for r in iter(item.ret) do

$(li)$(M(r))$(il)

# end -- for

</ol>

# end -- if returns

# local function href(see)

# if see.href then return see.href

# else return see.mod..'.html#'..see.name

# end

# if item.see then

# local li,il = use_li(item.see)

<ul>

# for see in iter(item.see) do

$(li)<a href="$(href(see))">$(see.label)</a>$(il)

# end -- for

</ul>

# end -- if see

</dd>

# end -- for items

</dl>

# end -- for kinds

# else -- if module

# if ldoc.description then

<p>$(M(ldoc.description))</p>

# end

# for kind, mods in ldoc.kinds() do

# kind = kind:lower()

# for m in mods() do

<tr>

<td class="summary">$(M(m.summary))</td>

</tr>

# end -- for modules

</table>

# end -- for kinds

# end -- if module

</div>

</div>

</div> 30E3

</div>

</body>

</html>

FilesExpand file tree

ldoc.ltp

Latest commit

History

ldoc.ltp

File metadata and controls