Skip to content

Commit f25698e

Browse files
author
Sergey Koshcheyev
committed
Use NDoc 2 alpha to generate documentation on .NET 2.0, including HTML Help 2 format.
SVN: trunk@2627
1 parent a0b4693 commit f25698e

File tree

2 files changed

+69
-129
lines changed

2 files changed

+69
-129
lines changed

‎doc/NHibernate.ndoc.in

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
2+
<project SchemaVersion="2.0">
3+
<assemblies>
4+
<assembly location="${bin.dir}/NHibernate.dll" documentation="${bin.dir}/NHibernate.xml" />
5+
<assembly location="${bin.dir}/NHibernate.Tasks.dll" documentation="${bin.dir}/NHibernate.Tasks.xml" />
6+
<assembly location="${bin.dir}/Iesi.Collections.dll" documentation="${bin.dir}/Iesi.Collections.xml" />
7+
<assembly location="${bin.dir}/NHibernate.Caches.MemCache.dll" documentation="${bin.dir}/NHibernate.Caches.MemCache.xml" />
8+
<assembly location="${bin.dir}/NHibernate.Caches.Prevalence.dll" documentation="${bin.dir}/NHibernate.Caches.Prevalence.xml" />
9+
<assembly location="${bin.dir}/NHibernate.Caches.SysCache.dll" documentation="${bin.dir}/NHibernate.Caches.SysCache.xml" />
10+
<assembly location="${bin.dir}/NHibernate.JetDriver.dll" documentation="${bin.dir}/NHibernate.JetDriver.xml" />
11+
<assembly location="${bin.dir}/NHibernate.Mapping.Attributes.dll" documentation="${bin.dir}/NHibernate.Mapping.Attributes.xml" />
12+
<assembly location="${bin.dir}/NHibernate.UserTypes.Oracle.dll" documentation="${bin.dir}/NHibernate.UserTypes.Oracle.xml" />
13+
<assembly location="${bin.dir}/NHibernate.Tool.hbm2net.dll" documentation="${bin.dir}/NHibernate.Tool.hbm2net.xml" />
14+
<assembly location="${bin.dir}/NHibernate.UserTypes.SqlTypes.dll" documentation="${bin.dir}/NHibernate.UserTypes.SqlTypes.xml" />
15+
<assembly location="${bin.dir}/Nullables.dll" documentation="${bin.dir}/Nullables.xml" />
16+
<assembly location="${bin.dir}/Nullables.NHibernate.dll" documentation="${bin.dir}/Nullables.NHibernate.xml" />
17+
</assemblies>
18+
<referencePaths>
19+
<referencePath path="${bin.dir}/nant" />
20+
</referencePaths>
21+
<documenters>
22+
<documenter name="MSDN-Help2">
23+
<property name="CollectionNamespace" value="NHibernate.${project.version.short}" />
24+
<property name="GenerateCollectionFiles" value="True" />
25+
<property name="PlugInNamespace" value="ms.vsipcc.v80" />
26+
<property name="AllLinksWithinVSHelpCollection" value="True" />
27+
<property name="OutputDirectory" value="${doc.help2.out.dir}" />
28+
<property name="HtmlHelpName" value="NHibernate.API" />
29+
<property name="Title" value="NHibernate ${project.version} API Reference" />
30+
<property name="Version" value="${project.version.numeric}" />
31+
<property name="CopyrightText" value="NHibernate" />
32+
<property name="CopyrightHref" value="http://www.nhibernate.org" />
33+
<property name="FeedbackEmailAddress" value="[email protected]" />
34+
<property name="CleanIntermediates" value="True" />
35+
<property name="BuildSeparateIndexFile" value="True" />
36+
</documenter>
37+
<documenter name="MSDN-CHM">
38+
<property name="OutputDirectory" value="${doc.chm.out.dir}" />
39+
<property name="HtmlHelpName" value="NHibernate.API" />
40+
<property name="Title" value="NHibernate ${project.version} API Reference" />
41+
<property name="Version" value="${project.version.numeric}" />
42+
<property name="CopyrightText" value="NHibernate" />
43+
<property name="CopyrightHref" value="http://www.nhibernate.org" />
44+
<property name="FeedbackEmailAddress" value="[email protected]" />
45+
<property name="CleanIntermediates" value="True" />
46+
</documenter>
47+
</documenters>
48+
</project>

‎doc/documentation.build

Lines changed: 21 additions & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
<target name="init" depends="common.init">
1313
<property name="doc.out.dir" value="${build.dir}/doc" />
14+
<property name="doc.help2.out.dir" value="${doc.out.dir}/help2" />
15+
<property name="doc.chm.out.dir" value="${doc.out.dir}" />
1416
<property name="doc.tmp.dir" value="${path::get-full-path(doc.out.dir)}/temp" />
1517
</target>
1618

@@ -19,6 +21,7 @@
1921
<target name="clean" depends="init">
2022
<nant target="clean" buildfile="reference/reference.build" />
2123
<delete dir="${doc.out.dir}" />
24+
<delete file="NHibernate.ndoc" />
2225
</target>
2326

2427
<target name="manual" depends="init">
@@ -30,137 +33,26 @@
3033
</nant>
3134
</target>
3235

33-
<target name="api" depends="init" description="Generates the API documentation (in MSDN style and VS.NET 2003 if available)">
34-
<!-- Force .NET 1.1 configuration because NDoc fails with .NET 2.0 assemblies -->
35-
<property name="current.framework.saved" value="${nant.settings.currentframework}" />
36-
<call target="set-net-1.1-framework-configuration" />
37-
38-
<ndoc>
39-
<assemblies basedir="${bin.dir}">
40-
<include name="Iesi.Collections.dll" />
41-
<include name="NHibernate*.dll" />
42-
<include name="Nullables*.dll" />
43-
44-
<exclude name="*Test*" />
45-
<exclude name="NHibernate.DomainModel.dll" />
46-
<exclude name="NHibernate.Examples.dll" />
47-
</assemblies>
48-
<summaries>
49-
<include name="src/NHibernate/NamespaceSummary.xml" />
50-
<include name="src/Iesi.Collections/NamespaceSummary.xml" />
51-
</summaries>
52-
<documenters>
53-
<documenter name="MSDN">
54-
<property name="OutputDirectory" value="${doc.tmp.dir}" />
55-
<property name="HtmlHelpName" value="NHibernate.API" />
56-
<property name="IncludeFavorites" value="False" />
57-
<property name="Title" value="NHibernate Class Library - v.${project.version}" />
58-
<property name="SplitTOCs" value="False" />
59-
<property name="DefaulTOC" value="" />
60-
<property name="IncludeHierarchy" value="False" />
61-
<property name="ShowVisualBasic" value="False" />
62-
<property name="RootPageContainsNamespaces" value="False" />
63-
<property name="SortTOCByNamespace" value="True" />
64-
<property name="OutputTarget" value="HtmlHelp" />
65-
<property name="HeaderHtml" value="" />
66-
<property name="FooterHtml" value="" />
67-
<property name="FilesToInclude" value="" />
68-
<property name="LinkToSdkDocVersion" value="${link.sdkdoc.version}" />
69-
<property name="ShowMissingSummaries" value="${build.debug}" />
70-
<property name="ShowMissingRemarks" value="${build.debug}" />
71-
<property name="ShowMissingParams" value="${build.debug}" />
72-
<property name="ShowMissingReturns" value="${build.debug}" />
73-
<property name="ShowMissingValues" value="${build.debug}" />
74-
<property name="DocumentInternals" value="False" />
75-
<property name="DocumentProtected" value="True" />
76-
<property name="DocumentPrivates" value="False" />
77-
<property name="DocumentProtectedInternalAsProtected" value="False" />
78-
<property name="DocumentEmptyNamespaces" value="False" />
79-
<property name="IncludeAssemblyVersion" value="False" />
80-
<property name="CopyrightText" value="NHibernate is licensed under GNU LGPL." />
81-
<property name="CopyrightHref" value="http://www.nhibernate.org/" />
82-
<property name="FeedbackEmailAddress" value="[email protected]" />
83-
<property name="ReferencesPath" value="" />
84-
<property name="SkipNamespacesWithoutSummaries" value="False" />
85-
<property name="UseNamespaceDocSummaries" value="False" />
86-
<property name="AutoPropertyBackerSummaries" value="False" />
87-
<property name="AutoDocumentConstructors" value="True" />
88-
<property name="DocumentAttributes" value="True" />
89-
<property name="ShowTypeIdInAttributes" value="False" />
90-
<property name="DocumentedAttributes" value="" />
91-
<property name="GetExternalSummaries" value="True" />
92-
<property name="EditorBrowsableFilter" value="Off" />
93-
<property name="UseNDocXmlFile" value="" />
94-
</documenter>
95-
</documenters>
96-
</ndoc>
97-
<copy todir="${doc.out.dir}">
98-
<fileset basedir="${doc.tmp.dir}">
99-
<include name="*.chm" />
100-
</fileset>
36+
<target name="ndoc-project" depends="init">
37+
<copy file="NHibernate.ndoc.in" tofile="NHibernate.ndoc" overwrite="true">
38+
<filterchain>
39+
<expandproperties />
40+
</filterchain>
10141
</copy>
42+
</target>
10243

103-
<if test="${vshik.installed}">
104-
<ndoc>
105-
<assemblies basedir="${bin.dir}">
106-
<include name="NHibernate.dll" />
107-
<include name="Iesi.Collections.dll" />
108-
</assemblies>
109-
<summaries>
110-
<include name="src/NHibernate/NamespaceSummary.xml" />
111-
<include name="src/Iesi.Collections/NamespaceSummary.xml" />
112-
</summaries>
113-
<documenters>
114-
<documenter name="VS.NET 2003">
115-
<property name="OutputDirectory" value="${doc.tmp.dir}" />
116-
<property name="HtmlHelpName" value="NHibernate.API" />
117-
<property name="Title" value="NHibernate Class Library - v.${project.version}" />
118-
<property name="HeaderHtml" value="" />
119-
<property name="FooterHtml" value="" />
120-
<property name="LinkToSdkDocVersion" value="${link.sdkdoc.version}" />
121-
<property name="ShowMissingSummaries" value="${build.debug}" />
122-
<property name="ShowMissingRemarks" value="${build.debug}" />
123-
<property name="ShowMissingParams" value="${build.debug}" />
124-
<property name="ShowMissingReturns" value="${build.debug}" />
125-
<property name="ShowMissingValues" value="${build.debug}" />
126-
<property name="DocumentInternals" value="False" />
127-
<property name="DocumentProtected" value="True" />
128-
<property name="DocumentPrivates" value="False" />
129-
<property name="DocumentProtectedInternalAsProtected" value="False" />
130-
<property name="DocumentEmptyNamespaces" value="False" />
131-
<property name="CopyrightText" value="NHibernate is licensed under GNU LGPL." />
132-
<property name="CopyrightHref" value="http://www.nhibernate.org/" />
133-
<property name="FeedbackEmailAddress" value="[email protected]" />
134-
<property name="ReferencesPath" value="" />
135-
<property name="SkipNamespacesWithoutSummaries" value="False" />
136-
<property name="UseNamespaceDocSummaries" value="False" />
137-
<property name="AutoPropertyBackerSummaries" value="False" />
138-
<property name="AutoDocumentConstructors" value="True" />
139-
<property name="DocumentAttributes" value="True" />
140-
<property name="ShowTypeIdInAttributes" value="False" />
141-
<property name="DocumentedAttributes" value="" />
142-
<property name="EditorBrowsableFilter" value="Off" />
143-
<property name="UseNDocXmlFile" value="" />
144-
</documenter>
145-
</documenters>
146-
</ndoc>
147-
148-
<copy todir="${doc.out.dir}/help2">
149-
<fileset basedir="${doc.tmp.dir}">
150-
<include name="*.HxS" />
151-
</fileset>
152-
</copy>
153-
<copy todir="${doc.out.dir}/help2">
154-
<fileset basedir="reference/support/help2">
155-
<include name="*" />
156-
</fileset>
157-
</copy>
158-
</if>
159-
160-
<!-- Restore the original framework configuration -->
161-
<call target="set-${current.framework.saved}-framework-configuration" />
162-
163-
<delete dir="${doc.tmp.dir}" />
44+
<target name="api" depends="init ndoc-project" description="Generates the API documentation (in MSDN style and VS.NET 2003 if available)">
45+
<property name="ndocconsole.exe" value="C:\net\NDoc2Alpha\NDocConsole.exe" />
46+
<exec program="${ndocconsole.exe}">
47+
<arg line="-documenter=MSDN-Help2" />
48+
<arg line="-project=NHibernate.ndoc" />
49+
</exec>
50+
51+
<property name="ndocconsole.exe" value="C:\net\NDoc2Alpha\NDocConsole.exe" />
52+
<exec program="${ndocconsole.exe}">
53+
<arg line="-documenter=MSDN-CHM" />
54+
<arg line="-project=NHibernate.ndoc" />
55+
</exec>
16456
</target>
16557

16658
</project>

0 commit comments

Comments
 (0)