LDoc/ldoc/html/ldoc_ltp.lua at 1.3.1 · 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

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

return [==[

<!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 no_spaces = ldoc.no_spaces

# local use_li = ldoc.use_li

# local display_name = ldoc.display_name

# local iter = ldoc.modules.iter

# local M = ldoc.markup

<br/>

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

# if not ldoc.single and module then -- reference back to project index

<ul>

<li><a href="../$(ldoc.output).html">Index</a></li>

</ul>

# end

# --------- contents of module -------------

# if module and not ldoc.no_summary and #module.items > 0 then

<h2>Contents</h2>

<ul>

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

# end

</ul>

# end

# if ldoc.no_summary and module then -- bang out the functions on the side

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

<ul>

# for item in items() do

<li><a href="#$(item.name)">$(display_name(item))</a></li>

# end

</ul>

# end

# -------- contents of project ----------

# -- if not ldoc.no_summary then

# local this_mod = module and module.name

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

# if not ldoc.kinds_allowed or ldoc.kinds_allowed[type] then

<ul>

# for mod in mods() do

# if mod.name == this_mod then -- highlight current module, link to others

# else

# end

# -- end

</ul>

# end

</div>

#if module then

<h1>$(ldoc.titlecase(module.type)) <code>$(module.name)</code></h1>

# end

# if ldoc.body then -- verbatim HTML as contents; 'non-code' entries

$(ldoc.body)

# elseif module then -- module documentation

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

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

# if module.usage then

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

<h3>Usage:</h3>

<ul>

# for usage in iter(module.usage) do

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

# end -- for

</ul>

# end -- if usage

# if module.info then

<ul>

# for tag, value in ldoc.pairs(module.info) do

<li><strong>$(tag)</strong>: $(value)</li>

# end

</ul>

# end -- if module.info

# if not ldoc.no_summary then

# -- 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,item))</td>

</tr>

# end -- for items

</table>

#end -- for kinds

<br/>

#end -- if not no_summary

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

# --- function parameters or table fields.

# local show_return = not ldoc.no_return_or_parms

# local show_parms = show_return

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

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

# for item in items() do

<dt>

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

</dt>

<dd>

$(M((item.summary or '?')..' '..(item.description or ''),item))

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

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

<ul>

# for p in iter(item.params) do

# local tp = ldoc.typename(item:type_of_param(p))

# if tp ~= '' then

# end

$(M(item.params[p],item))</li>

# end -- for

</ul>

# end -- if params

# if show_return and item.ret then

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

<h3>Returns:</h3>

<ol>

# for i,r in ldoc.ipairs(item.ret) do

$(li)

# local tp = ldoc.typename(item:type_of_ret(i))

# if tp ~= '' then

# end

$(M(r,item))$(il)

# end -- for

</ol>

# end -- if returns

# if show_return and item.raise then

<h3>Raises:</h3>

$(M(item.raise,item))

# end

# if item.see then

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

<ul>

# for see in iter(item.see) do

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

# end -- for

</ul>

# end -- if see

# 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">$(ldoc.escape(usage))</pre>$(il)

# end -- for

</ul>

# end -- if usage

</dd>

# end -- for items

</dl>

# end -- for kinds

# else -- if module; project-level contents

# if ldoc.description then

<h2>$(M(ldoc.description,nil))</h2>

# end

# if ldoc.full_description then

<p>$(M(ldoc.full_description,nil))</p>

# end

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

# kind = kind:lower()

# for m in mods() do

<tr>

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

</tr>

# end -- for modules

</table>

# end -- for kinds

# end -- if module

</div>

</div>

<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.3</a></i>

</div>

</div>

</body>

</html>

]==]

FilesExpand file tree

ldoc_ltp.lua

Latest commit

History

ldoc_ltp.lua

File metadata and controls