Dokumentation eingebaut und aktuelle Element wird nun gekennzeichnet
This commit is contained in:
parent
0147753ff6
commit
2abef7a2a4
49 changed files with 3505 additions and 39 deletions
|
|
@ -0,0 +1,82 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<title>${h(Type.PrettyName)} - ${WriteProductName(Assemblies[0])} Documentation</title>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
||||
<link type="text/css" rel="stylesheet" href="../main.css" />
|
||||
<script type="text/javascript" src="../js/jquery-1.3.2.min.js"></script>
|
||||
<script type="text/javascript" src="../js/jquery.scrollTo-min.js"></script>
|
||||
<script type="text/javascript" src="../js/navigation.js"></script>
|
||||
<script type="text/javascript" src="../js/example.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<header><h1>${WriteProductName(Assemblies[0])} : API Documentation</h1>
|
||||
</header>
|
||||
|
||||
<namespaces />
|
||||
<types />
|
||||
<article>
|
||||
<header>
|
||||
<p class="class"><strong>Type</strong> ${h(Type.PrettyName)}</p>
|
||||
</header>
|
||||
<section>
|
||||
<header>
|
||||
<p><strong>Namespace</strong> ${Namespace.Name}</p>
|
||||
<p if="Type.ParentType != null && Type.ParentType.PrettyName != 'object'"><strong>Parent</strong> ${Format(Type.ParentType)}</p>
|
||||
<p if="Type.Interfaces.Count > 0"><strong>Interfaces</strong> ${WriteInterfaces(Type.Interfaces)}</p>
|
||||
</header>
|
||||
<div class="sub-header">
|
||||
<if condition="(Type.Summary != null && Type.Summary.Children.Count() > 0) || (Type.Remarks != null && Type.Remarks.Children.Count() > 0)">
|
||||
<div id="summary">
|
||||
<comment content="Type.Summary" />
|
||||
<remarks content="Type.Remarks" />
|
||||
<example content="Type.Example" />
|
||||
</div>
|
||||
</if>
|
||||
|
||||
<if condition="Type.Events.Count > 0">
|
||||
<h3 class="section">Events</h3>
|
||||
<ul>
|
||||
<li each="var ev in Type.Events">${Format(ev)}</li>
|
||||
</ul>
|
||||
</if>
|
||||
|
||||
<if condition="Type.Methods.Count > 0">
|
||||
<h3 class="section">Methods</h3>
|
||||
<ul>
|
||||
<li each="var method in Type.Methods">${Format(method)}</li>
|
||||
</ul>
|
||||
</if>
|
||||
|
||||
<if condition="Type.Properties.Count > 0">
|
||||
<h3 class="section">Properties</h3>
|
||||
<ul>
|
||||
<li each="var property in Type.Properties">${Format(property)}</li>
|
||||
</ul>
|
||||
</if>
|
||||
|
||||
<if condition="Type.Fields.Count > 0">
|
||||
<h3 class="section">Fields</h3>
|
||||
<ul>
|
||||
<li each="var field in Type.Fields">${Format(field)}</li>
|
||||
</ul>
|
||||
</if>
|
||||
</div>
|
||||
<events events="Type.Events" title="'Events'" />
|
||||
|
||||
<var publicInstanceMethods="Type.Methods.Where(x => x.IsPublic && !x.IsStatic)" />
|
||||
<methods methods="publicInstanceMethods" title="'Public instance methods'" />
|
||||
|
||||
<var publicStaticMethods="Type.Methods.Where(x => x.IsPublic && x.IsStatic)" />
|
||||
<methods methods="publicStaticMethods" title="'Public static methods'" />
|
||||
|
||||
<properties properties="Type.Properties" title="'Public properties'" />
|
||||
<fields fields="Type.Fields" title="'Public fields'" />
|
||||
</section>
|
||||
</article>
|
||||
<use file="../_common_footer" />
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1 @@
|
|||
${Format(content)}
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
<if condition="events.Count() > 0">
|
||||
<h3 class="section">${title}</h3>
|
||||
|
||||
<div id="${ev.Name}" class="method" each="var ev in events">
|
||||
<h4><strong>${h(ev.Name)}</strong></h4>
|
||||
<div class="content">
|
||||
<comment content="ev.Summary" />
|
||||
<remarks content="ev.Remarks" />
|
||||
<example content="ev.Example" />
|
||||
</div>
|
||||
</div>
|
||||
</if>
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
<div class="example" if="content != null && content.Children.Count() > 0">
|
||||
<a href="javascript:void(0)">Show Example</a>
|
||||
<pre>${Format(content)}</pre>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
<if condition="fields.Count() > 0">
|
||||
<h3 class="section">${title}</h3>
|
||||
|
||||
<div id="${field.Name}" class="method" each="var field in fields">
|
||||
<h4>${h(field.ReturnType.PrettyName)} <strong>${h(field.Name)}</strong></h4>
|
||||
<div class="content">
|
||||
<comment content="field.Summary" />
|
||||
<remarks content="field.Remarks" />
|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
<code>return ${Format(field.ReturnType)}</code>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<example content="field.Example" />
|
||||
</div>
|
||||
</div>
|
||||
</if>
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
<if condition="methods.Count() > 0">
|
||||
<h3 class="section">${title}</h3>
|
||||
|
||||
<div id="${method.Name}" class="method" each="var method in methods">
|
||||
<h4>
|
||||
${Format(method.ReturnType)} <strong>${h(method.PrettyName)}</strong>(${OutputMethodParams(method)})
|
||||
</h4>
|
||||
<div class="content">
|
||||
<comment content="method.Summary" />
|
||||
<remarks content="method.Remarks" />
|
||||
|
||||
<var hasReturn="method.ReturnType.PrettyName != 'void'" />
|
||||
<var hasParams="method.Parameters.Any(x => x.HasDocumentation)" />
|
||||
|
||||
<div class="parameters" if="hasParams">
|
||||
<h5>Parameters</h5>
|
||||
<dl>
|
||||
<for each="var param in method.Parameters">
|
||||
<dt>
|
||||
<code>${Format(param.Reference)}</code> ${param.Name}
|
||||
</dt>
|
||||
<dd if="!param.Summary.IsEmpty">
|
||||
<comment content="param.Summary" />
|
||||
</dd>
|
||||
</for>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
<div class="return" if="!method.Returns.IsEmpty">
|
||||
|
||||
<h5>Returns</h5>
|
||||
<dl>
|
||||
<dt>
|
||||
<code>${Format(method.ReturnType)}</code>
|
||||
</dt>
|
||||
<dd>
|
||||
<comment content="method.Returns" />
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
<value content="method.Value" />
|
||||
<example content="method.Example" />
|
||||
</div>
|
||||
</div>
|
||||
</if>
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
<nav id="namespaces">
|
||||
<h2 class="fixed">Namespaces</h2>
|
||||
<div class="scroll">
|
||||
<ul>
|
||||
<li each="var ns in Namespaces">
|
||||
<if condition="ns == Namespace">
|
||||
${Format(ns, class => "current")}
|
||||
<else />
|
||||
${Format(ns)}
|
||||
</if>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
<if condition="properties.Count() > 0">
|
||||
<h3 class="section">${title}</h3>
|
||||
|
||||
<div id="${property.Name}" class="method" each="var property in properties">
|
||||
<h4>
|
||||
${Format(property.ReturnType)} <strong>${h(property.Name)}</strong> <if condition="property.HasGet">get;</if> <if condition="property.HasSet">set;</if>
|
||||
</h4>
|
||||
<div class="content">
|
||||
<comment content="property.Summary" />
|
||||
<remarks content="property.Remarks" />
|
||||
|
||||
<div class="return" if="property.ReturnType.HasDocumentation">
|
||||
<h5>Property type</h5>
|
||||
<dl>
|
||||
<dt>
|
||||
<code>${Format(property.ReturnType)}</code>
|
||||
</dt>
|
||||
<dd>
|
||||
<comment content="property.ReturnType.Summary" />
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<value content="property.Value" />
|
||||
<example content="property.Example" />
|
||||
</div>
|
||||
</div>
|
||||
</if>
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
<blockquote class="remarks" if="content != null && content.Children.Count() > 0">
|
||||
${Format(content)}
|
||||
</blockquote>
|
||||
14
TimeScheduler/package/docu/templates/!namespace/_types.spark
Normal file
14
TimeScheduler/package/docu/templates/!namespace/_types.spark
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
<nav id="types">
|
||||
<h2 class="fixed">Types in ${Namespace.PrettyName}</h2>
|
||||
<div class="scroll">
|
||||
<ul>
|
||||
<li each="var type in Namespace.Types">
|
||||
<if condition="type == Type">
|
||||
${Format(type, class => "current")}
|
||||
<else />
|
||||
${Format(type)}
|
||||
</if>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
<blockquote class="value" if="content.Children.Count() > 0">
|
||||
<strong>Value: </strong>${Format(content)}
|
||||
</blockquote>
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<title>${Namespace.Name} - ${WriteProductName(Assemblies[0])} Documentation</title>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
||||
<link type="text/css" rel="stylesheet" href="../main.css" />
|
||||
<script type="text/javascript" src="../js/jquery-1.3.2.min.js"></script>
|
||||
<script type="text/javascript" src="../js/jquery.scrollTo-min.js"></script>
|
||||
<script type="text/javascript" src="../js/navigation.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<header><h1>${WriteProductName(Assemblies[0])} : API Documentation</h1>
|
||||
</header>
|
||||
<namespaces />
|
||||
<types />
|
||||
<article>
|
||||
<header>
|
||||
<p class="class"><strong>Namespace</strong> ${Namespace.Name}</p>
|
||||
</header>
|
||||
<section>
|
||||
<div class="sub-header">
|
||||
<if condition="Namespace.HasClasses">
|
||||
<h3 class="section">Classes</h3>
|
||||
<ul>
|
||||
<for each="var type in Namespace.Classes">
|
||||
<li>${Format(type)}</li>
|
||||
</for>
|
||||
</ul>
|
||||
</if>
|
||||
|
||||
<if condition="Namespace.HasInterfaces">
|
||||
<h3 class="section">Interfaces</h3>
|
||||
<ul>
|
||||
<for each="var type in Namespace.Interfaces">
|
||||
<li>${Format(type)}</li>
|
||||
</for>
|
||||
</ul>
|
||||
</if>
|
||||
<p if="!Namespace.HasTypes">This namespace is empty.</p>
|
||||
</div>
|
||||
</section>
|
||||
</article>
|
||||
<use file="../_common_footer" />
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue