Skip to content

Commit af423a0

Browse files
committed
Merge r4631
SVN: trunk@4632
1 parent 9448a6a commit af423a0

File tree

4 files changed

+56
-14
lines changed

4 files changed

+56
-14
lines changed

default.build

+6-1
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,11 @@
156156
description="Builds the Help Documentation">
157157
<nant buildfile="doc/documentation.build" target="manual" />
158158
</target>
159+
160+
<target name="api" depends="init binaries"
161+
description="Builds the API Documentation">
162+
<nant buildfile="doc/documentation.build" target="api" />
163+
</target>
159164

160165
<target name="build-all-frameworks" depends="init">
161166
<!-- Save the current framework -->
@@ -299,7 +304,7 @@
299304
<nant buildfile="src/NHibernate.Setup/NHibernate.Setup.build" target="msi" />
300305
</target>
301306

302-
<target name="package" depends="init set-release-project-configuration test binaries manual sources-zip binaries-zip"
307+
<target name="package" depends="init binaries manual sources-zip binaries-zip"
303308
description="Creates files for the File Release System on SourceForge">
304309

305310
<property name="dist.output.dir" value="${project::get-base-directory()}/build/" />

doc/NHibernate.shfbproj.template

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="3.5">
2+
<PropertyGroup>
3+
<!-- The configuration and platform will be used to determine which
4+
assemblies to include from solution and project documentation
5+
sources -->
6+
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
7+
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
8+
<SchemaVersion>2.0</SchemaVersion>
9+
<ProjectGuid>{91f431cd-23fb-4ed4-a690-0344073c65f0}</ProjectGuid>
10+
<SHFBSchemaVersion>1.8.0.0</SHFBSchemaVersion>
11+
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual
12+
Studio adds them anyway -->
13+
<AssemblyName>Documentation</AssemblyName>
14+
<RootNamespace>Documentation</RootNamespace>
15+
<Name>Documentation</Name>
16+
<!-- SHFB properties -->
17+
<OutputPath>${doc.out.dir}</OutputPath>
18+
<HtmlHelpName>NHibernateAPI</HtmlHelpName>
19+
<HelpFileFormat>HtmlHelp1x</HelpFileFormat>
20+
<CopyrightText>NHibernate</CopyrightText>
21+
<CopyrightHref>www.nhforge.org</CopyrightHref>
22+
<FeedbackEMailAddress>http://groups.google.com/group/nhibernate-development</FeedbackEMailAddress>
23+
<FeedbackEMailLinkText>nhibernate team</FeedbackEMailLinkText>
24+
<HelpTitle>NHibernate API Reference</HelpTitle>
25+
<IndentHtml>False</IndentHtml>
26+
<HelpFileVersion>${project.version.numeric}</HelpFileVersion>
27+
<DocumentationSources>
28+
<DocumentationSource sourceFile="${bin.dir}/Iesi.Collections.dll" />
29+
<DocumentationSource sourceFile="${bin.dir}/Iesi.Collections.xml" />
30+
<DocumentationSource sourceFile="${bin.dir}/NHibernate.dll" />
31+
<DocumentationSource sourceFile="${bin.dir}/Nhibernate.xml" />
32+
</DocumentationSources>
33+
</PropertyGroup>
34+
<!-- There are no properties for these two groups but they need to appear in
35+
order for Visual Studio to perform the build. -->
36+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
37+
</PropertyGroup>
38+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
39+
</PropertyGroup>
40+
<!-- Import the SHFB build targets -->
41+
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
42+
</Project>

doc/documentation.build

+7-12
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
>
88

99
<property name="root.dir" value=".." />
10-
<include buildfile="${root.dir}/build-common/common.xml"/>
1110
<include buildfile="${root.dir}/build-common/common-project.xml" />
1211

1312
<target name="init" depends="common.init">
@@ -22,7 +21,7 @@
2221
<target name="clean" depends="init">
2322
<nant target="clean" buildfile="reference/reference.build" />
2423
<delete dir="${doc.out.dir}" />
25-
<delete file="NHibernate.ndoc" />
24+
<delete file="NHibernate.shfbproj" />
2625
</target>
2726

2827
<target name="manual" depends="init">
@@ -34,15 +33,15 @@
3433
</nant>
3534
</target>
3635

37-
<target name="ndoc-project" depends="init">
38-
<copy file="NHibernate.ndoc.in" tofile="NHibernate.ndoc" overwrite="true">
36+
<target name="apidocbuilder-project" depends="init">
37+
<copy file="NHibernate.shfbproj.template" tofile="NHibernate.shfbproj" overwrite="true">
3938
<filterchain>
4039
<expandproperties />
4140
</filterchain>
4241
</copy>
4342
</target>
4443

45-
<target name="api" depends="init common.find-ndoc ndoc-project" description="Generates the API documentation (in MSDN style and VS.NET 2003 if available)">
44+
<target name="api" depends="init apidocbuilder-project" description="Generates the API documentation (in MSDN style and VS.NET 2005 if available)">
4645
<uptodate property="api.uptodate">
4746
<sourcefiles>
4847
<include name="${bin.dir}/*.dll" />
@@ -57,13 +56,9 @@
5756
<echo if="${api.uptodate}">API documentation is up to date, skipping generation step.</echo>
5857

5958
<if test="${not api.uptodate}">
60-
<exec program="${ndoc-console}">
61-
<arg line="-documenter=MSDN-Help2" />
62-
<arg line="-project=NHibernate.ndoc" />
63-
</exec>
64-
<exec program="${ndoc-console}">
65-
<arg line="-documenter=MSDN-CHM" />
66-
<arg line="-project=NHibernate.ndoc" />
59+
<property name="apidocbuilder.exe" value="${directory::get-parent-directory(environment::get-folder-path('System'))}\Microsoft.NET\Framework\v3.5\MSBuild.exe" />
60+
<exec program="${apidocbuilder.exe}">
61+
<arg line="NHibernate.shfbproj" />
6762
</exec>
6863
</if>
6964
</target>

doc/reference/reference.build

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<property name="lang" value="en" />
1313

1414
<property name="output.dir" value="${build.dir}/doc" />
15-
<property name="output.html.basename" value="NHibernate.Documentation" />
15+
<property name="output.html.basename" value="NHibernate.Reference" />
1616
<property name="output.help2.dir" value="${output.dir}/help2" />
1717

1818
<property name="build.html.dir" value="${output.dir}" />

0 commit comments

Comments
 (0)