contrib/luadoc/lua/luadoc/doclet/html/module.lp

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html>
   4 <head>
   5     <title>Reference</title>
   6     <link rel="stylesheet" href="<%=luadoc.doclet.html.link('luadoc.css', 'modules/'..module_doc.name)%>" type="text/css" />
   7         <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
   8 </head>
   9
  10 <body>
  11 <div id="container">
  12
  13 <div id="product">
  14         <div id="product_logo"></div>
  15         <div id="product_name"><big><b></b></big></div>
  16         <div id="product_description"></div>
  17 </div> <!-- id="product" -->
  18
  19 <div id="main">
  20
  21 <div id="navigation">
  22 <%=luadoc.doclet.html.include("menu.lp", { doc=doc, module_doc=module_doc })%>
  23
  24 </div><!-- id="navigation" -->
  25
  26 <div id="content">
  27
  28 <h1>Module <code><%=module_doc.name%></code></h1>
  29
  30 <p><%=module_doc.description%></p>
  31 <%if module_doc.author then%>
  32 <p><b><%= #module_doc.author>1 and "Authors" or "Author" %>:</b>
  33 <table class="authors_list">
  34 <%for _, author in ipairs(module_doc.author) do%>
  35         <tr><td class="name"><%= author %></td></tr>
  36 <%end%>
  37 </table>
  38 </p>
  39 <%end%>
  40 <%if module_doc.copyright then%>
  41 <p>Copyright&copy; <%=module_doc.copyright%></p>
  42 <%end%>
  43 <%if module_doc.release then%>
  44 <p><small><b>Release:</b> <%=module_doc.release%></small></p>
  45 <%end%>
  46
  47 <%if #module_doc.functions > 0 then%>
  48 <h2>Functions</h2>
  49 <table class="function_list">
  50 <%for _, func_name in ipairs(module_doc.functions) do
  51   local func_data = module_doc.functions[func_name]%>
  52         <tr>
  53         <td class="name" nowrap><%=func_data.private and "local " or ""%><a href="#<%=func_name%>"><%=func_name%></a>&nbsp;(<%=table.concat(module_doc.functions[func_name].param, ", ")%>)</td>
  54         <td class="summary"><%=module_doc.functions[func_name].summary%></td>
  55         </tr>
  56 <%end%>
  57 </table>
  58 <%end%>
  59
  60
  61 <%if #module_doc.tables > 0 then%>
  62 <h2>Tables</h2>
  63 <table class="table_list">
  64 <%for _, tab_name in ipairs(module_doc.tables) do%>
  65         <tr>
  66         <td class="name" nowrap><a href="#<%=tab_name%>"><%=tab_name%></a></td>
  67         <td class="summary"><%=module_doc.tables[tab_name].summary%></td>
  68         </tr>
  69 <%end%>
  70 </table>
  71 <%end%>
  72
  73
  74 <br/>
  75 <br/>
  76
  77
  78 <%if #module_doc.functions > 0 then%>
  79 <h2><a name="functions"></a>Functions</h2>
  80 <dl class="function">
  81 <%for _, func_name in ipairs(module_doc.functions) do%>
  82 <%=luadoc.doclet.html.include("function.lp", { doc=doc, module_doc=module_doc, func=module_doc.functions[func_name] })%>
  83 <%end%>
  84 </dl>
  85 <%end%>
  86
  87
  88 <%if #module_doc.tables > 0 then%>
  89 <h2><a name="tables"></a>Tables</h2>
  90 <dl class="table">
  91 <%for _, tab_name in ipairs(module_doc.tables) do%>
  92 <%=luadoc.doclet.html.include("table.lp", { doc=doc, module_doc=module_doc, tab=module_doc.tables[tab_name] })%>
  93 <%end%>
  94 </dl>
  95 <%end%>
  96
  97
  98 </div> <!-- id="content" -->
  99
 100 </div> <!-- id="main" -->
 101
 102 <div id="about">
 103         <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
 104 </div> <!-- id="about" -->
 105
 106 </div> <!-- id="container" -->
 107 </body>
 108 </html>