Author: jgomes
Date: Thu Jan 6 19:35:21 2011
New Revision: 1056027
URL: http://svn.apache.org/viewvc?rev=1056027&view=rev
Log:
Update README with instructions on how to generate API documentation.
Fix reference path to NUnit for documentation generation task.
Fixes [AMQNET-302]. (See https://issues.apache.org/activemq/browse/AMQNET-302)
Modified:
activemq/activemq-dotnet/Apache.NMS.ActiveMQ/trunk/README.txt
activemq/activemq-dotnet/Apache.NMS.ActiveMQ/trunk/nant-common.xml
activemq/activemq-dotnet/Apache.NMS.EMS/trunk/README.txt
activemq/activemq-dotnet/Apache.NMS.EMS/trunk/nant-common.xml
activemq/activemq-dotnet/Apache.NMS.MSMQ/trunk/README.txt
activemq/activemq-dotnet/Apache.NMS.MSMQ/trunk/nant-common.xml
activemq/activemq-dotnet/Apache.NMS.Stomp/trunk/README.txt
activemq/activemq-dotnet/Apache.NMS.Stomp/trunk/nant-common.xml
activemq/activemq-dotnet/Apache.NMS.WCF/trunk/README.txt
activemq/activemq-dotnet/Apache.NMS.WCF/trunk/nant-common.xml
activemq/activemq-dotnet/Apache.NMS/branches/1.5.x/nant-common.xml
activemq/activemq-dotnet/Apache.NMS/tags/1.5.0/nant-common.xml
activemq/activemq-dotnet/Apache.NMS/trunk/README.txt
activemq/activemq-dotnet/Apache.NMS/trunk/nant-common.xml
Modified: activemq/activemq-dotnet/Apache.NMS.ActiveMQ/trunk/README.txt
URL:
http://svn.apache.org/viewvc/activemq/activemq-dotnet/Apache.NMS.ActiveMQ/trunk/README.txt?rev=1056027&r1=1056026&r2=1056027&view=diff
==============================================================================
--- activemq/activemq-dotnet/Apache.NMS.ActiveMQ/trunk/README.txt (original)
+++ activemq/activemq-dotnet/Apache.NMS.ActiveMQ/trunk/README.txt Thu Jan 6
19:35:21 2011
@@ -19,9 +19,21 @@ To run the unit tests you need to run an
nant test
+The NMS documentation can be generated into three different formats using
+Microsoft's Sandcastle open source product. The Sandcastle Styles project
+was used to enhance the output generated from the current release of
Sandcastle.
+
+The Sandcastle project is located here:
+
+http://sandcastle.codeplex.com/
+
+The Sandcastle Styles project is located here:
+
+http://sandcastlestyles.codeplex.com/
+
To generate the documentation, run:
- nant doc
+ nant sandcastle-all
=======================================================================
Building With Visual Studio 2008
Modified: activemq/activemq-dotnet/Apache.NMS.ActiveMQ/trunk/nant-common.xml
URL:
http://svn.apache.org/viewvc/activemq/activemq-dotnet/Apache.NMS.ActiveMQ/trunk/nant-common.xml?rev=1056027&r1=1056026&r2=1056027&view=diff
==============================================================================
--- activemq/activemq-dotnet/Apache.NMS.ActiveMQ/trunk/nant-common.xml
(original)
+++ activemq/activemq-dotnet/Apache.NMS.ActiveMQ/trunk/nant-common.xml Thu Jan
6 19:35:21 2011
@@ -545,7 +545,7 @@
<property name="sandcastle.style" value="vs2005"
unless="${property::exists('sandcastle.style')}" />
<property name="documentation.dir" value="${build.bin.dir}" />
<property name="bin.intern.dir" value="${build.bin.dir}" />
- <property name="bin.extern.dir"
value="${basedir}\vendor\NUnit\net-2.0" />
+ <property name="bin.extern.dir" value="${basedir}\lib\NUnit\net-2.0" />
<property name="sandcastle.dir"
value="${environment::get-variable('DXROOT')}" />
<property name="sandcastle.workingdir"
value="${build.dir}\doc\${sandcastle.style}" />
<property name="sandcastle.output.dir"
value="${sandcastle.workingdir}\Output" />
Modified: activemq/activemq-dotnet/Apache.NMS.EMS/trunk/README.txt
URL:
http://svn.apache.org/viewvc/activemq/activemq-dotnet/Apache.NMS.EMS/trunk/README.txt?rev=1056027&r1=1056026&r2=1056027&view=diff
==============================================================================
--- activemq/activemq-dotnet/Apache.NMS.EMS/trunk/README.txt (original)
+++ activemq/activemq-dotnet/Apache.NMS.EMS/trunk/README.txt Thu Jan 6
19:35:21 2011
@@ -15,9 +15,21 @@ To build the code using NAnt, run:
nant
+The NMS documentation can be generated into three different formats using
+Microsoft's Sandcastle open source product. The Sandcastle Styles project
+was used to enhance the output generated from the current release of
Sandcastle.
+
+The Sandcastle project is located here:
+
+http://sandcastle.codeplex.com/
+
+The Sandcastle Styles project is located here:
+
+http://sandcastlestyles.codeplex.com/
+
To generate the documentation, run:
- nant doc
+ nant sandcastle-all
=======================================================================
Building With Visual Studio 2008
Modified: activemq/activemq-dotnet/Apache.NMS.EMS/trunk/nant-common.xml
URL:
http://svn.apache.org/viewvc/activemq/activemq-dotnet/Apache.NMS.EMS/trunk/nant-common.xml?rev=1056027&r1=1056026&r2=1056027&view=diff
==============================================================================
--- activemq/activemq-dotnet/Apache.NMS.EMS/trunk/nant-common.xml (original)
+++ activemq/activemq-dotnet/Apache.NMS.EMS/trunk/nant-common.xml Thu Jan 6
19:35:21 2011
@@ -545,7 +545,7 @@
<property name="sandcastle.style" value="vs2005"
unless="${property::exists('sandcastle.style')}" />
<property name="documentation.dir" value="${build.bin.dir}" />
<property name="bin.intern.dir" value="${build.bin.dir}" />
- <property name="bin.extern.dir"
value="${basedir}\vendor\NUnit\net-2.0" />
+ <property name="bin.extern.dir" value="${basedir}\lib\NUnit\net-2.0" />
<property name="sandcastle.dir"
value="${environment::get-variable('DXROOT')}" />
<property name="sandcastle.workingdir"
value="${build.dir}\doc\${sandcastle.style}" />
<property name="sandcastle.output.dir"
value="${sandcastle.workingdir}\Output" />
Modified: activemq/activemq-dotnet/Apache.NMS.MSMQ/trunk/README.txt
URL:
http://svn.apache.org/viewvc/activemq/activemq-dotnet/Apache.NMS.MSMQ/trunk/README.txt?rev=1056027&r1=1056026&r2=1056027&view=diff
==============================================================================
--- activemq/activemq-dotnet/Apache.NMS.MSMQ/trunk/README.txt (original)
+++ activemq/activemq-dotnet/Apache.NMS.MSMQ/trunk/README.txt Thu Jan 6
19:35:21 2011
@@ -19,9 +19,21 @@ To run the unit tests you need to run an
nant test
+The NMS documentation can be generated into three different formats using
+Microsoft's Sandcastle open source product. The Sandcastle Styles project
+was used to enhance the output generated from the current release of
Sandcastle.
+
+The Sandcastle project is located here:
+
+http://sandcastle.codeplex.com/
+
+The Sandcastle Styles project is located here:
+
+http://sandcastlestyles.codeplex.com/
+
To generate the documentation, run:
- nant doc
+ nant sandcastle-all
=======================================================================
Building With Visual Studio 2008
Modified: activemq/activemq-dotnet/Apache.NMS.MSMQ/trunk/nant-common.xml
URL:
http://svn.apache.org/viewvc/activemq/activemq-dotnet/Apache.NMS.MSMQ/trunk/nant-common.xml?rev=1056027&r1=1056026&r2=1056027&view=diff
==============================================================================
--- activemq/activemq-dotnet/Apache.NMS.MSMQ/trunk/nant-common.xml (original)
+++ activemq/activemq-dotnet/Apache.NMS.MSMQ/trunk/nant-common.xml Thu Jan 6
19:35:21 2011
@@ -545,7 +545,7 @@
<property name="sandcastle.style" value="vs2005"
unless="${property::exists('sandcastle.style')}" />
<property name="documentation.dir" value="${build.bin.dir}" />
<property name="bin.intern.dir" value="${build.bin.dir}" />
- <property name="bin.extern.dir"
value="${basedir}\vendor\NUnit\net-2.0" />
+ <property name="bin.extern.dir" value="${basedir}\lib\NUnit\net-2.0" />
<property name="sandcastle.dir"
value="${environment::get-variable('DXROOT')}" />
<property name="sandcastle.workingdir"
value="${build.dir}\doc\${sandcastle.style}" />
<property name="sandcastle.output.dir"
value="${sandcastle.workingdir}\Output" />
Modified: activemq/activemq-dotnet/Apache.NMS.Stomp/trunk/README.txt
URL:
http://svn.apache.org/viewvc/activemq/activemq-dotnet/Apache.NMS.Stomp/trunk/README.txt?rev=1056027&r1=1056026&r2=1056027&view=diff
==============================================================================
--- activemq/activemq-dotnet/Apache.NMS.Stomp/trunk/README.txt (original)
+++ activemq/activemq-dotnet/Apache.NMS.Stomp/trunk/README.txt Thu Jan 6
19:35:21 2011
@@ -19,9 +19,21 @@ To run the unit tests you need to run an
nant test
+The NMS documentation can be generated into three different formats using
+Microsoft's Sandcastle open source product. The Sandcastle Styles project
+was used to enhance the output generated from the current release of
Sandcastle.
+
+The Sandcastle project is located here:
+
+http://sandcastle.codeplex.com/
+
+The Sandcastle Styles project is located here:
+
+http://sandcastlestyles.codeplex.com/
+
To generate the documentation, run:
- nant doc
+ nant sandcastle-all
=======================================================================
Building With Visual Studio 2008
Modified: activemq/activemq-dotnet/Apache.NMS.Stomp/trunk/nant-common.xml
URL:
http://svn.apache.org/viewvc/activemq/activemq-dotnet/Apache.NMS.Stomp/trunk/nant-common.xml?rev=1056027&r1=1056026&r2=1056027&view=diff
==============================================================================
--- activemq/activemq-dotnet/Apache.NMS.Stomp/trunk/nant-common.xml (original)
+++ activemq/activemq-dotnet/Apache.NMS.Stomp/trunk/nant-common.xml Thu Jan 6
19:35:21 2011
@@ -545,7 +545,7 @@
<property name="sandcastle.style" value="vs2005"
unless="${property::exists('sandcastle.style')}" />
<property name="documentation.dir" value="${build.bin.dir}" />
<property name="bin.intern.dir" value="${build.bin.dir}" />
- <property name="bin.extern.dir"
value="${basedir}\vendor\NUnit\net-2.0" />
+ <property name="bin.extern.dir" value="${basedir}\lib\NUnit\net-2.0" />
<property name="sandcastle.dir"
value="${environment::get-variable('DXROOT')}" />
<property name="sandcastle.workingdir"
value="${build.dir}\doc\${sandcastle.style}" />
<property name="sandcastle.output.dir"
value="${sandcastle.workingdir}\Output" />
Modified: activemq/activemq-dotnet/Apache.NMS.WCF/trunk/README.txt
URL:
http://svn.apache.org/viewvc/activemq/activemq-dotnet/Apache.NMS.WCF/trunk/README.txt?rev=1056027&r1=1056026&r2=1056027&view=diff
==============================================================================
--- activemq/activemq-dotnet/Apache.NMS.WCF/trunk/README.txt (original)
+++ activemq/activemq-dotnet/Apache.NMS.WCF/trunk/README.txt Thu Jan 6
19:35:21 2011
@@ -19,9 +19,21 @@ To run the unit tests you need to run an
nant test
+The NMS documentation can be generated into three different formats using
+Microsoft's Sandcastle open source product. The Sandcastle Styles project
+was used to enhance the output generated from the current release of
Sandcastle.
+
+The Sandcastle project is located here:
+
+http://sandcastle.codeplex.com/
+
+The Sandcastle Styles project is located here:
+
+http://sandcastlestyles.codeplex.com/
+
To generate the documentation, run:
- nant doc
+ nant sandcastle-all
=======================================================================
Building With Visual Studio 2008
Modified: activemq/activemq-dotnet/Apache.NMS.WCF/trunk/nant-common.xml
URL:
http://svn.apache.org/viewvc/activemq/activemq-dotnet/Apache.NMS.WCF/trunk/nant-common.xml?rev=1056027&r1=1056026&r2=1056027&view=diff
==============================================================================
--- activemq/activemq-dotnet/Apache.NMS.WCF/trunk/nant-common.xml (original)
+++ activemq/activemq-dotnet/Apache.NMS.WCF/trunk/nant-common.xml Thu Jan 6
19:35:21 2011
@@ -545,7 +545,7 @@
<property name="sandcastle.style" value="vs2005"
unless="${property::exists('sandcastle.style')}" />
<property name="documentation.dir" value="${build.bin.dir}" />
<property name="bin.intern.dir" value="${build.bin.dir}" />
- <property name="bin.extern.dir"
value="${basedir}\vendor\NUnit\net-2.0" />
+ <property name="bin.extern.dir" value="${basedir}\lib\NUnit\net-2.0" />
<property name="sandcastle.dir"
value="${environment::get-variable('DXROOT')}" />
<property name="sandcastle.workingdir"
value="${build.dir}\doc\${sandcastle.style}" />
<property name="sandcastle.output.dir"
value="${sandcastle.workingdir}\Output" />
Modified: activemq/activemq-dotnet/Apache.NMS/branches/1.5.x/nant-common.xml
URL:
http://svn.apache.org/viewvc/activemq/activemq-dotnet/Apache.NMS/branches/1.5.x/nant-common.xml?rev=1056027&r1=1056026&r2=1056027&view=diff
==============================================================================
--- activemq/activemq-dotnet/Apache.NMS/branches/1.5.x/nant-common.xml
(original)
+++ activemq/activemq-dotnet/Apache.NMS/branches/1.5.x/nant-common.xml Thu Jan
6 19:35:21 2011
@@ -545,7 +545,7 @@
<property name="sandcastle.style" value="vs2005"
unless="${property::exists('sandcastle.style')}" />
<property name="documentation.dir" value="${build.bin.dir}" />
<property name="bin.intern.dir" value="${build.bin.dir}" />
- <property name="bin.extern.dir"
value="${basedir}\vendor\NUnit\net-2.0" />
+ <property name="bin.extern.dir" value="${basedir}\lib\NUnit\net-2.0" />
<property name="sandcastle.dir"
value="${environment::get-variable('DXROOT')}" />
<property name="sandcastle.workingdir"
value="${build.dir}\doc\${sandcastle.style}" />
<property name="sandcastle.output.dir"
value="${sandcastle.workingdir}\Output" />
Modified: activemq/activemq-dotnet/Apache.NMS/tags/1.5.0/nant-common.xml
URL:
http://svn.apache.org/viewvc/activemq/activemq-dotnet/Apache.NMS/tags/1.5.0/nant-common.xml?rev=1056027&r1=1056026&r2=1056027&view=diff
==============================================================================
--- activemq/activemq-dotnet/Apache.NMS/tags/1.5.0/nant-common.xml (original)
+++ activemq/activemq-dotnet/Apache.NMS/tags/1.5.0/nant-common.xml Thu Jan 6
19:35:21 2011
@@ -545,7 +545,7 @@
<property name="sandcastle.style" value="vs2005"
unless="${property::exists('sandcastle.style')}" />
<property name="documentation.dir" value="${build.bin.dir}" />
<property name="bin.intern.dir" value="${build.bin.dir}" />
- <property name="bin.extern.dir"
value="${basedir}\vendor\NUnit\net-2.0" />
+ <property name="bin.extern.dir" value="${basedir}\lib\NUnit\net-2.0" />
<property name="sandcastle.dir"
value="${environment::get-variable('DXROOT')}" />
<property name="sandcastle.workingdir"
value="${build.dir}\doc\${sandcastle.style}" />
<property name="sandcastle.output.dir"
value="${sandcastle.workingdir}\Output" />
Modified: activemq/activemq-dotnet/Apache.NMS/trunk/README.txt
URL:
http://svn.apache.org/viewvc/activemq/activemq-dotnet/Apache.NMS/trunk/README.txt?rev=1056027&r1=1056026&r2=1056027&view=diff
==============================================================================
--- activemq/activemq-dotnet/Apache.NMS/trunk/README.txt (original)
+++ activemq/activemq-dotnet/Apache.NMS/trunk/README.txt Thu Jan 6 19:35:21
2011
@@ -15,9 +15,21 @@ To build the code using NAnt, run:
nant
+The NMS documentation can be generated into three different formats using
+Microsoft's Sandcastle open source product. The Sandcastle Styles project
+was used to enhance the output generated from the current release of
Sandcastle.
+
+The Sandcastle project is located here:
+
+http://sandcastle.codeplex.com/
+
+The Sandcastle Styles project is located here:
+
+http://sandcastlestyles.codeplex.com/
+
To generate the documentation, run:
- nant doc
+ nant sandcastle-all
=======================================================================
Building With Visual Studio 2008
Modified: activemq/activemq-dotnet/Apache.NMS/trunk/nant-common.xml
URL:
http://svn.apache.org/viewvc/activemq/activemq-dotnet/Apache.NMS/trunk/nant-common.xml?rev=1056027&r1=1056026&r2=1056027&view=diff
==============================================================================
--- activemq/activemq-dotnet/Apache.NMS/trunk/nant-common.xml (original)
+++ activemq/activemq-dotnet/Apache.NMS/trunk/nant-common.xml Thu Jan 6
19:35:21 2011
@@ -545,7 +545,7 @@
<property name="sandcastle.style" value="vs2005"
unless="${property::exists('sandcastle.style')}" />
<property name="documentation.dir" value="${build.bin.dir}" />
<property name="bin.intern.dir" value="${build.bin.dir}" />
- <property name="bin.extern.dir"
value="${basedir}\vendor\NUnit\net-2.0" />
+ <property name="bin.extern.dir" value="${basedir}\lib\NUnit\net-2.0" />
<property name="sandcastle.dir"
value="${environment::get-variable('DXROOT')}" />
<property name="sandcastle.workingdir"
value="${build.dir}\doc\${sandcastle.style}" />
<property name="sandcastle.output.dir"
value="${sandcastle.workingdir}\Output" />