API documentation with Sandcastle Help File Builder

[304NotModified]

Create the API documentation with Sandcastle Help File Builder (SHFB) instead of the old Sandcastle.

Should fix: #578

[sean-gilliam]

@304NotModified Do you want a shfbproj targeting each solution file (mono2, netfx35, netfx40...) or for an overall solution (e.g. netfx45)?

[304NotModified]

Good question.

A different for mono and .Net would be great. But the mono build isn't working yet

[304NotModified]

So I think first netfx45 would be a good start

[304NotModified]

3.2.1 docs are with SHFB. http://nlog-project.org/documentation/v3.2.1/html/R_Project_NLog.htm

Next step is to make the config reusable and commit to GitHub

[304NotModified]

Also nice to have: logo + more namespace descriptions

[304NotModified]

To do: fix link to wiki. example link below at
http://nlog-project.org/documentation/v3.2.1/html/T_NLog_Targets_DatabaseTarget.htm

[ie-zero]

I also spotted that the assembly version is returned as blank i.e 0.0.0.0
Assembly: NLog (in NLog.dll) Version: 0.0.0.0

[304NotModified]

Yes, good noticed

That's because in history we used a msbuild project to call shfb.

I haven't much experience with msbuild projects, but maybe we should fix it.

[ie-zero]

I have not got much experience msbuild projects but it would be useful to learn.

I would like to see your build if you do not mind in case I can help.

[304NotModified]

The information :)

The current Sandcastle Help File Builder files are at:
NLog\src\Docs\Frameworks

You can build the docs with
msbuild NLog.proj /t:rebuild /t:BuildIndividualDocumentation /p:BuildLastMajorVersion=4.0.0 /p:AssemblyFileVersion=4.1.2 /p:BuildVersion=4.1.2 /p:configuration=release /p:BuildLabelOverride=NONE

The target

  <Target Name="BuildIndividualDocumentation">
    <Exec Command='"$(WinDir)\Microsoft.NET\Framework\v3.5\MSBuild.exe" Docs\NLog.shfbproj /p:Framework="%(TargetFramework.Identity)" /p:Configuration=$(Configuration) /p:BuildLabel="$(BuildLabel)" /p:BuildVersion="$(BuildVersion)"' ContinueOnError="$(BuildAllFrameworks)" />
  </Target>

My tryout was: https://github.com/304NotModified/NLog/blob/new-SHFB/src/Docs/NLog%204.0.shfbproj

But it was missing the variables (didn't know how to build the docs firstly).

Also it's not integrated in the .proc, which is preferred after all.

[304NotModified]

This is done already