Skip to content

Commit b058c8e

Browse files
committed
Overhaul client documentation
- Introduce additional TOC level and simplify asciidoc structure - Use MsBuildWorkspace to get the ASTs of each document of interest. This will allow us to query the Semantic Model to obtain richer information for doc generation - Refactor source code walking Simplified walking into a base walker implementation that can be modified by a derived walker to perform different actions on syntax nodes e.g. usage tests apply conventions for Fluent, Object Initializer API examples with JSON output. - Process attribute entries found within document bodies to generate and include asciidoc elements within the document. - Generate XML documentation file from the compilation of the Elasticsearch.Net and NEST projects. Could refactor current implementation further to extract all comments using Roslyn without taking a dependency on NuDoq. - Update the naming of query usage tests to be consistent; these are used as headers in the table of contents - Introduce sections for - Getting started with NEST - Getting started with Elasticsearch.Net - Configuration options from XML docs for ConnectionSettings - Modifying serialization - Using Client certificates - Writing Analyzers - Testing Analyzers - Writing queries - Improve Writing bool queries - Logging - Debugging Part of elastic#2248 (cherry-picked from commit 6268353)
1 parent 4701749 commit b058c8e

File tree

418 files changed

+23307
-9527
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

418 files changed

+23307
-9527
lines changed

build/scripts/Building.fsx

+3-3
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ module Build =
5353
)
5454

5555
let private compileDesktop() =
56-
Tooling.MsBuild.Rebuild DotNetFramework.Net45.Identifier
57-
Tooling.MsBuild.Rebuild DotNetFramework.Net46.Identifier
56+
Tooling.MsBuild.Rebuild DotNetFramework.Net45
57+
Tooling.MsBuild.Rebuild DotNetFramework.Net46
5858

5959
let private gitLink() =
6060
DotNetProject.AllPublishable
@@ -70,7 +70,7 @@ module Build =
7070

7171
let Compile() =
7272
match quickBuild with
73-
| true -> Tooling.MsBuild.Build DotNetFramework.Net45.Identifier
73+
| true -> Tooling.MsBuild.Build DotNetFramework.Net45
7474
| false ->
7575
compileDesktop()
7676
compileCore()

build/scripts/Tooling.fsx

+17-9
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,16 @@ module Tooling =
158158
let DotNet = new DotNetTooling("dotnet.exe")
159159

160160
type MsBuildTooling() =
161-
162-
member this.Build (framework:Projects.DotNetFrameworkIdentifier) =
163-
let solution = Paths.Source "Elasticsearch.sln";
161+
// Exclude DocGenerator from .NET 4.5 build as it depends on a Roslyn library
162+
// that is built against .NET 4.5.2
163+
let solutionForFramework framework =
164+
match framework with
165+
| Net45 -> Paths.Source "Elasticsearch.Net45.sln"
166+
| _ -> Paths.Source "Elasticsearch.sln"
167+
168+
member this.Build (framework:Projects.DotNetFramework) =
169+
let solution = solutionForFramework framework
170+
let identifier = framework.Identifier
164171
let setParams defaults =
165172
{ defaults with
166173
Verbosity = Some(Quiet)
@@ -169,14 +176,15 @@ module Tooling =
169176
[
170177
"Optimize", "True"
171178
"Configuration", "Release"
172-
"TargetFrameworkVersion", framework.MSBuild
173-
"DefineConstants", framework.DefineConstants
179+
"TargetFrameworkVersion", identifier.MSBuild
180+
"DefineConstants", identifier.DefineConstants
174181
]
175182
}
176183
build setParams solution
177184

178-
member this.Rebuild (framework:Projects.DotNetFrameworkIdentifier) =
179-
let solution = Paths.Source "Elasticsearch.sln";
185+
member this.Rebuild (framework:Projects.DotNetFramework) =
186+
let solution = solutionForFramework framework
187+
let identifier = framework.Identifier
180188
let setParams defaults =
181189
{ defaults with
182190
Verbosity = Some(Quiet)
@@ -186,8 +194,8 @@ module Tooling =
186194
"OutputPathBaseDir", Path.GetFullPath "build\\output"
187195
"Optimize", "True"
188196
"Configuration", "Release"
189-
"TargetFrameworkVersion", framework.MSBuild
190-
"DefineConstants", framework.DefineConstants
197+
"TargetFrameworkVersion", identifier.MSBuild
198+
"DefineConstants", identifier.DefineConstants
191199
]
192200
}
193201

0 commit comments

Comments
 (0)