added a 'doc' goal which uses NDoc to create static html documentation (which doesn't render too well on FireFox and lousy on Safari but I assume it must render OK on IE :). Would be nice to get this documentation auto-deployed on the site

git-svn-id: https://svn.apache.org/repos/asf/incubator/activemq/trunk@426497 13f79535-47bb-0310-9956-ffa450edef68

activemq-dotnet/.project

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>activemq-dotnet</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+	</natures>
+</projectDescription>

activemq-dotnet/nant.build

@@ -8,7 +8,8 @@
   <property name="project.name" value="activemq-dotnet" />
   <property name="project.version" value="4.0" unless="${property::exists('project.version')}" />
   <property name="project.release.type" value="SNAPSHOT" unless="${property::exists('project.release.type')}" />
-	<property name="project.version.full" value="${project.version + if(project.release.type == 'release', '', '-' + project.release.type)}" dynamic="true" />
+  <property name="project.version.full"
+    value="${project.version + if(project.release.type == 'release', '', '-' + project.release.type)}" dynamic="true" />
 
   <!--
     specifies whether the CommonAssemblyInfo.cs file should be created.
@@ -19,13 +20,17 @@
 
   <!-- global build settings -->
   <property name="lib.dir" value="${path::combine(build.dir, 'bin/lib')}" dynamic="true" />
-    <property name="lib.family.dir" value="${path::combine(lib.dir, framework::get-family(framework::get-target-framework()))}" dynamic="true" />
+  <property name="lib.family.dir" value="${path::combine(lib.dir, framework::get-family(framework::get-target-framework()))}"
-    <property name="lib.framework.dir" value="${path::combine(lib.family.dir, version::to-string(framework::get-version(framework::get-target-framework())))}" dynamic="true" />
+    dynamic="true" />
+  <property name="lib.framework.dir"
+    value="${path::combine(lib.family.dir, version::to-string(framework::get-version(framework::get-target-framework())))}"
+    dynamic="true" />
 
   <!-- default configuration -->
   <property name="project.config" value="debug" /><!-- debug|release -->
   <property name="build.defines" value="" />
-    <property name="build.number"   value="${math::abs(math::floor(timespan::get-total-days(datetime::now() - datetime::parse('01/01/2000'))))}" />
+  <property name="build.number"
+    value="${math::abs(math::floor(timespan::get-total-days(datetime::now() - datetime::parse('01/01/2000'))))}" />
 
   <!-- platform specific properties. These are the defaults -->
   <property name="current.build.defines" value="${build.defines}" />
@@ -34,7 +39,8 @@
   <target name="debug" description="Perform a 'debug' build">
     <property name="project.config" value="debug" />
     <property name="build.debug" value="true" />
-        <property name="build.dir" value="${project::get-base-directory()}/build/${framework::get-target-framework()}.${platform::get-name()}/${project.name}-${project.version}-${project.config}" />
+    <property name="build.dir"
+      value="${project::get-base-directory()}/build/${framework::get-target-framework()}.${platform::get-name()}/${project.name}-${project.version}-${project.config}" />
   </target>
 
   <target name="release" description="Perform a 'release' build">
@@ -104,10 +110,12 @@
     <delete dir="build" if="${directory::exists('build')}" />
   </target>
 
-    <target name="create-common-assemblyinfo" if="${create.assemblyinfo}" depends="init" description="Generate CommonAssemblyInfo.cs">
+  <target name="create-common-assemblyinfo" if="${create.assemblyinfo}" depends="init"
+    description="Generate CommonAssemblyInfo.cs">
 
     <!-- ensure src/main/csharp/CommonAssemblyInfo.cs is writable if it already exists -->
-        <attrib file="src/main/csharp/CommonAssemblyInfo.cs" readonly="false" if="${file::exists('src/main/csharp/CommonAssemblyInfo.cs')}" />
+    <attrib file="src/main/csharp/CommonAssemblyInfo.cs" readonly="false"
+      if="${file::exists('src/main/csharp/CommonAssemblyInfo.cs')}" />
 
     <!-- generate the source file holding the common assembly-level attributes -->
     <asminfo output="src/main/csharp/CommonAssemblyInfo.cs" language="CSharp">
@@ -124,7 +132,8 @@
         <attribute type="AssemblyConfigurationAttribute" value="${project.release.type}" />
         <attribute type="AssemblyCompanyAttribute" value="http://activemq.org/" />
         <attribute type="AssemblyProductAttribute" value="ActiveMQ" />
-                <attribute type="AssemblyCopyrightAttribute" value="Copyright (C) 2005-${datetime::get-year(datetime::now())} Apache Software Foundation" />
+        <attribute type="AssemblyCopyrightAttribute"
+          value="Copyright (C) 2005-${datetime::get-year(datetime::now())} Apache Software Foundation" />
         <attribute type="AssemblyTrademarkAttribute" value="" />
         <attribute type="AssemblyCultureAttribute" value="" />
         <attribute type="AssemblyVersionAttribute" value="${project.version}.${build.number}.0" />
@@ -133,7 +142,8 @@
     </asminfo>
 
     <!-- ensure src/test/csharp/CommonAssemblyInfo.cs is writable if it already exists -->
-        <attrib file="src/test/csharp/CommonAssemblyInfo.cs" readonly="false" if="${file::exists('src/test/csharp/CommonAssemblyInfo.cs')}" />
+    <attrib file="src/test/csharp/CommonAssemblyInfo.cs" readonly="false"
+      if="${file::exists('src/test/csharp/CommonAssemblyInfo.cs')}" />
 
     <!-- generate the source file holding the common assembly-level attributes -->
     <asminfo output="src/test/csharp/CommonAssemblyInfo.cs" language="CSharp">
@@ -150,7 +160,8 @@
         <attribute type="AssemblyConfigurationAttribute" value="${project.release.type}" />
         <attribute type="AssemblyCompanyAttribute" value="http://activemq.org/" />
         <attribute type="AssemblyProductAttribute" value="ActiveMQ" />
-                <attribute type="AssemblyCopyrightAttribute" value="Copyright (C) 2005-${datetime::get-year(datetime::now())} Apache Software Foundation" />
+        <attribute type="AssemblyCopyrightAttribute"
+          value="Copyright (C) 2005-${datetime::get-year(datetime::now())} Apache Software Foundation" />
         <attribute type="AssemblyTrademarkAttribute" value="" />
         <attribute type="AssemblyCultureAttribute" value="" />
         <attribute type="AssemblyVersionAttribute" value="${project.version}.${build.number}.0" />
@@ -166,7 +177,8 @@
     <echo message="Build Directory is ${build.dir}" />
     <mkdir dir="${build.dir}/bin" />
 
-        <csc target="library" define="${current.build.defines}" warnaserror="false" debug="${build.debug}" output="${build.dir}/bin/${project.name}.dll" doc="${build.dir}/bin/${project.name}.xml">
+    <csc target="library" define="${current.build.defines}" warnaserror="false" debug="${build.debug}"
+      output="${build.dir}/bin/${project.name}.dll" doc="${build.dir}/bin/${project.name}.xml">
       <nowarn>
         <!-- do not report warnings for missing XML comments -->
         <warning number="1591" />
@@ -189,8 +201,47 @@
     </csc>
   </target>
   
+  <target name="doc" depends="build-main">
+    <ndoc>
+      <assemblies basedir="${build.dir}">
+        <include name="bin/${project.name}.dll" />
+      </assemblies>
+      <summaries basedir="src/main/ndoc">
+        <include name="NamespaceSummary.xml" />
+      </summaries>
+      <documenters>
+        <documenter name="MSDN">
+          <property name="OutputDirectory" value="${build.dir}/doc" />
+          <property name="HtmlHelpName" value="NMS" />
+          <property name="HtmlHelpCompilerFilename" value="hhc.exe" />
+          <property name="IncludeFavorites" value="False" />
+          <property name="Title" value="The NMS Class Library (.Net Messaging Library)" />
+          <property name="SplitTOCs" value="False" />
+          <property name="DefaulTOC" value="" />
+          <!--
+          <property name="ShowVisualBasic" value="True" />
+          <property name="ShowMissingSummaries" value="True" />
+          <property name="ShowMissingRemarks" value="True" />
+          <property name="ShowMissingParams" value="True" />
+          <property name="ShowMissingReturns" value="True" />
+          <property name="ShowMissingValues" value="True" />
+          -->
+          <property name="DocumentInternals" value="False" />
+          <property name="DocumentProtected" value="True" />
+          <property name="DocumentPrivates" value="False" />
+          <property name="DocumentEmptyNamespaces" value="False" />
+          <property name="IncludeAssemblyVersion" value="False" />
+          <property name="CopyrightText" value="" />
+          <property name="CopyrightHref" value="" />
+        </documenter>
+      </documenters>
+    </ndoc>
+  </target>
+  
+
   <target name="build-test" depends="create-common-assemblyinfo, build-main">
-		<csc target="library" define="${current.build.defines}" warnaserror="false" debug="${build.debug}" output="${build.dir}/bin/${project.name}.test.dll">
+    <csc target="library" define="${current.build.defines}" warnaserror="false" debug="${build.debug}"
+      output="${build.dir}/bin/${project.name}.test.dll">
       <nowarn>
         <!-- do not report warnings for missing XML comments -->
         <warning number="1591" />
@@ -219,14 +270,12 @@
     </csc>
   </target>
 
-    <target name="build" depends="build-test">
+  <target name="build" depends="build-test"></target>
-	</target>
 
   <target name="test" depends="build-test">
     <nunit2>
       <formatter type="Plain" />
-				<test assemblyname="${build.dir}/bin/${project.name}.test.dll">
+      <test assemblyname="${build.dir}/bin/${project.name}.test.dll"></test>
-			</test>
     </nunit2>
   </target>
 

activemq-dotnet/src/main/ndoc/NamespaceSummary.xml

@@ -0,0 +1,5 @@
+<namespaces>
+    <namespace name="NMS">
+        The <b>NMS</b> namespace defines the .Net Message System API which is an interface to messaging systems rather like JMS is for Java.
+    </namespace>
+</namespaces>