Updated docu

mcliment · mcliment · commit 450674ee4339 · 2015-03-12T22:54:17.000+01:00
docu updated to shortsn/docu fork, with .NET 4.0 support
diff --git a/tools/docu/Spark.dll b/tools/docu/Spark.dll
diff --git a/tools/docu/docu.exe b/tools/docu/docu.exe
diff --git a/tools/docu/docu.pdb b/tools/docu/docu.pdb
diff --git a/tools/docu/templates/!namespace/!type.htm.spark b/tools/docu/templates/!namespace/!type.htm.spark
@@ -2,11 +2,12 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <title>${h(Type.PrettyName)} - ${WriteProductName(Assemblies[0])} Documentation</title>
-    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <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>
     <namespaces />
@@ -22,23 +23,42 @@
 			<div id="summary">
 				<comment content="Type.Summary" />
 				<remarks content="Type.Remarks" />
+				<example content="Type.Example" />
+			</div>
+		</if>
+		<if condition="Type.IsObsolete">
+			<div id="warning">
+				<b>Obsolete:</b> ${Type.ObsoleteReason}
 			</div>
 		</if>
 		
-		<if condition="Type.Events.Count > 0">
-			<h3 class="section">Events</h3>
+		<if condition="Type.Methods.Where(x => x.IsConstructor).Count() > 0">
+			<h3 class="section">Constructors</h3>
 			<ul>
-				<li each="var ev in Type.Events">${Format(ev)}</li>
+				<li each="var method in Type.Methods.Where(x => x.IsConstructor)">${Format(method)}</li>
 			</ul>
 		</if>
-		
-		<if condition="Type.Methods.Count > 0">
+
+		<if condition="Type.Methods.Where(x => !x.IsConstructor && x.IsStatic).Count() > 0">
+			<h3 class="section">Static Functions</h3>
+			<ul>
+				<li each="var method in Type.Methods.Where(x => !x.IsConstructor && x.IsStatic)">${Format(method)}</li>
+			</ul>
+		</if>
+		<if condition="!Type.IsStatic && Type.Methods.Where(x => !x.IsConstructor && !x.IsStatic).Count() > 0">
 			<h3 class="section">Methods</h3>
 			<ul>
-				<li each="var method in Type.Methods">${Format(method)}</li>
+				<li each="var method in Type.Methods.Where(x => !x.IsConstructor && !x.IsStatic)">${Format(method)}</li>
 			</ul>
 		</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.Properties.Count > 0">
 			<h3 class="section">Properties</h3>
 			<ul>
@@ -56,13 +76,18 @@
 	
 	<events events="Type.Events" title="'Events'" />
 	
-	<var publicInstanceMethods="Type.Methods.Where(x => x.IsPublic && !x.IsStatic)" />
-	<methods methods="publicInstanceMethods" title="'Public instance methods'" />
+	<var publicConstructors="Type.Methods.Where(x => x.IsPublic && x.IsConstructor)" />
+	<methods methods="publicConstructors" title="'Public Constructors'" />
 	
 	<var publicStaticMethods="Type.Methods.Where(x => x.IsPublic && x.IsStatic)" />
-	<methods methods="publicStaticMethods" title="'Public static methods'" />
+	<methods methods="publicStaticMethods" title="'Public Static Functions'" />
+
+	<if condition="!Type.IsStatic">
+		<var publicInstanceMethods="Type.Methods.Where(x => x.IsPublic && !x.IsStatic && !x.IsConstructor)" />
+		<methods methods="publicInstanceMethods" title="'Public Methods'" />
+	</if>
 	
-	<properties properties="Type.Properties" title="'Public properties'" />
+	<properties properties="Type.Properties" title="'Public Properties'" />
 	<fields fields="Type.Fields" title="'Public fields'" />
 	
 	<use file="../_footer" />
diff --git a/tools/docu/templates/!namespace/_events.spark b/tools/docu/templates/!namespace/_events.spark
@@ -6,6 +6,7 @@
     <div class="content">
       <comment content="ev.Summary" />
       <remarks content="ev.Remarks" />
+      <example content="ev.Example" />
     </div>
   </div>
 </if>
diff --git a/tools/docu/templates/!namespace/_example.spark b/tools/docu/templates/!namespace/_example.spark
@@ -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>
diff --git a/tools/docu/templates/!namespace/_fields.spark b/tools/docu/templates/!namespace/_fields.spark
@@ -13,6 +13,7 @@
           </td>
         </tr>
       </table>
+      <example content="field.Example" />
     </div>
   </div>
 </if>
diff --git a/tools/docu/templates/!namespace/_methods.spark b/tools/docu/templates/!namespace/_methods.spark
@@ -6,8 +6,13 @@
 		<div class="content">
       <comment content="method.Summary" />
       <remarks content="method.Remarks" />
+      <if condition="method.IsObsolete">
+        <div id="warning">
+          <b>Obsolete:</b> ${method.ObsoleteReason}
+        </div>
+      </if>
 
-      <var hasReturn="method.ReturnType.PrettyName != 'void'" />
+      <var hasReturn="method.ReturnType != null && method.ReturnType.PrettyName != 'void'" />
       <var hasParams="method.Parameters.Any(x => x.HasDocumentation)" />
 
       <div class="parameters" if="hasParams">
@@ -26,6 +31,7 @@
       </div>
       
       <value content="method.Value" />
-		</div>
+      <example content="method.Example" />
+    </div>
 	</div>
 </if>
diff --git a/tools/docu/templates/!namespace/_properties.spark b/tools/docu/templates/!namespace/_properties.spark
@@ -6,13 +6,19 @@
     <div class="content">
       <comment content="property.Summary" />
       <remarks content="property.Remarks" />
+      <if condition="property.IsObsolete">
+        <div id="warning">
+          <b>Obsolete:</b> ${property.ObsoleteReason}
+        </div>
+      </if>
       
       <div class="return" if="property.ReturnType.HasDocumentation">
         <h5>Property type</h5>
         <h6><code>${Format(property.ReturnType)}</code></h6>
         <p><comment content="property.ReturnType.Summary" /></p>
       </div>
       <value content="property.Value" />
+      <example content="property.Example" />
     </div>
   </div>
 </if>
diff --git a/tools/docu/templates/!namespace/index.htm.spark b/tools/docu/templates/!namespace/index.htm.spark
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <title>${Namespace.Name} - ${WriteProductName(Assemblies[0])} Documentation</title>
-    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <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>
diff --git a/tools/docu/templates/index.htm.spark b/tools/docu/templates/index.htm.spark
@@ -1,35 +1,17 @@
 ﻿<!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>
-    <title>${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" />
-  </head>
-  <body id="index">
+	<head>
+		<title>${WriteProductName(Assemblies[0])} Documentation</title>
+		<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+		<link type="text/css" rel="stylesheet" href="main.css" />
+	</head>
+	<body>
     <namespaces />
     <types />
     <div class="header">
-      <p class="class">${WriteProductName(Assemblies[0])} Documentation</p>
-    </div>
-
-    <div id="index">
-      <p><strong>You're reading the Fluent NHibernate API documentation.</strong> Above are all the namespaces
-        and types in Fluent NHibernate. Not everything will be of interest to you, as most of it is internal
-        workings, but you can find the public classes in here too. Not all our classes are documented, but we're
-        working on it; these docs are updated on every commit of Fluent NHibernate, so if something isn't documented
-        let us know and we'll update it.</p>
-
-      <p>Classes of interest:</p>
-      <ul>
-        <li><a href="FluentNHibernate.Mapping/ClassMap`1.htm">ClassMap&lt;T&gt;</a> - used to map your entities</li>
-        <li><a href="FluentNHibernate.Mapping/SubclassMap`1.htm">SubclassMap&lt;T&gt;</a> - for mapping any
-          subclasses of entities</li>
-        <li><a href="FluentNHibernate.Mapping/ComponentMap`1.htm">ComponentMap&lt;T&gt;</a> - create reusable component
-          mappings</li>
-        <li><a href="FluentNHibernate.Automapping/AutoMap.htm">AutoMap</a> - the starting point for automapping</li>
-        <li><a href="FluentNHibernate.Cfg/FluentConfiguration.htm">FluentConfiguration</a> - application configuration</li>
-      </ul>
-    </div>
+		<p class="class">${WriteProductName(Assemblies[0])} Documentation</p>
+	</div>
+    
     <use file="_footer" />
   </body>
-</html>
+</html>
diff --git a/tools/docu/templates/js/example.js b/tools/docu/templates/js/example.js
@@ -0,0 +1,21 @@
+﻿$(document).ready(function() {
+    $('div.example').each(function(i, div) {
+        var a = $('a', div);
+        var pre = $('pre', div);
+
+        a.pre = pre;
+        a.preVisible = false;
+        pre.hide();
+        a.click(function() {
+            if (a.preVisible) {
+                a.pre.hide();
+                a.text('Show Example');
+                a.preVisible = false;
+            } else {
+                a.pre.show();
+                a.text('Hide Example');
+                a.preVisible = true;
+            }
+        });
+    });
+});
diff --git a/tools/docu/templates/main.css b/tools/docu/templates/main.css
@@ -6,8 +6,8 @@
 }
 
 .header {
-	background: #900;
-	border-bottom: 3px solid #600;
+	background: #048;
+	border-bottom: 3px solid #006;
 	margin: 0;
 	color: #FFF;
 	padding: 10px;
@@ -141,6 +141,14 @@ div.parameters p, div.return p {
 	margin-left: -1px;
 }
 
+#warning {
+    color: red ;
+    background: rgb(255, 218, 0);
+	border: 1px solid red;
+	margin: 20px 10px 20px 10px;
+	padding: 5px 10px;
+}
+
 h2.fixed {
 	background: #CCC;
 	color: #000;
@@ -169,18 +177,18 @@ div.scroll {
 }
 
 a {
-	background: #EFEEE4;
-	color: #900;
+	background: #eef;
+	color: #039;
 	text-decoration: none;
 }
 
 a:hover {
 	color: #FFF;
-	background: #900;
+	background: #039;
 }
 
 #namespaces a.current, #types a.current {
-	background: #900;
+	background: #039;
 	color: #FFF;
 	text-decoration: none;
 }
@@ -207,6 +215,19 @@ blockquote {
 	font-size: 90%;
 }
 
-#index p {
-  padding: 10px;
+.example {
+	margin: 10px 0;
 }
+
+.example pre {
+	background: #DDD;
+	color: #000;
+	font-size: 14px;
+	font-family: Monaco, Consolas, Courier New, Monospace;
+	padding: 4px 10px;
+	border: 3px solid #AAA;
+}
+
+code {
+	font-family: Monaco, Consolas, Courier New, Monospace;
+}
