2008-04-27 22:51:39 +00:00
|
|
|
The library documentation is generated using external tools which currently create:
|
|
|
|
|
|
2011-05-22 05:31:46 +00:00
|
|
|
* A HTML Website http://lib.openmetaverse.org/docs/trunk/
|
|
|
|
|
* A compiled HTML Help file http://lib.openmetaverse.org/docs/trunk/OpenMetaverse.chm
|
2008-04-27 22:51:39 +00:00
|
|
|
|
|
|
|
|
These are generated by our automated build system nightly using the inline XML code documentation.
|
|
|
|
|
|
|
|
|
|
If you want to generate these documents locally you will need to do the following:
|
|
|
|
|
|
|
|
|
|
1) Download and install the following tools:
|
2009-08-07 00:00:51 +00:00
|
|
|
The latest version of Microsoft's Sandcastle (currently the May 2008 release as of February 4, 2009) http://www.codeplex.com/Sandcastle
|
|
|
|
|
Patch to fix issues with the Sandcastle Themes: http://sandcastlestyles.codeplex.com/Release/ProjectReleases.aspx?ReleaseId=18784#DownloadId=48243
|
2008-07-29 05:29:48 +00:00
|
|
|
Sandcastle Help File Builder: http://www.codeplex.com/SHFB (You will need version 1.7.0.0 or newer)
|
2009-08-07 00:00:51 +00:00
|
|
|
Microsoft HTML Help: http://go.microsoft.com/fwlink/?linkid=14188 (Not required for Vista)
|
|
|
|
|
.NET 3.5 SP1 http://www.microsoft.com/downloads/details.aspx?FamilyID=ab99342f-5d1a-413d-8319-81da479ab0d7&DisplayLang=en
|
2008-04-27 22:51:39 +00:00
|
|
|
|
|
|
|
|
|
2009-08-07 00:00:51 +00:00
|
|
|
2) We use prebuild to configure and build this project, see the readme.txt in the projects root directory for
|
2009-01-06 20:29:51 +00:00
|
|
|
more information. To build with docs: from the project root directory run: "runprebuild.bat msbuild docs" followed
|
|
|
|
|
by compile.bat, this will generate the necessary xml documentation and assemblies, then create the html project documentation
|
2008-04-27 22:51:39 +00:00
|
|
|
|
|
|
|
|
|
2008-04-28 00:22:33 +00:00
|
|
|
Additionally if you have 7-Zip installed in the path, a zip archive will be created in the documentation tree
|
2011-05-22 05:31:46 +00:00
|
|
|
containing all the documentation in a compressed format see: http://www.7-zip.org/
|
|
|
|
|
|
|
|
|
|
To serve the documentation from a PHP enabled server copy contents of sandcastle_php folder into the directory generated by Sandcastle.
|
