Skip to content
This repository has been archived by the owner on Apr 27, 2024. It is now read-only.

Commit

Permalink
Update README with instructions on how to generate API documentation.
Browse files Browse the repository at this point in the history
Fix reference path to NUnit for documentation generation task.
Fixes [AMQNET-302]. (See https://issues.apache.org/activemq/browse/AMQNET-302)
  • Loading branch information
Jim Gomes committed Jan 6, 2011
1 parent e237327 commit 7bfbd0a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
14 changes: 13 additions & 1 deletion README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,21 @@ To run the unit tests you need to run an Apache ActiveMQ Broker first then run:

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
Expand Down
2 changes: 1 addition & 1 deletion nant-common.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down

0 comments on commit 7bfbd0a

Please sign in to comment.