The build tool will now also create the documentation for the created package with the help of doxygen

Author: basicx-StrgV

.nuke/build.schema.json

@@ -10,6 +10,10 @@
           "type": "boolean",
           "description": "Indicates to continue a previously failed build attempt"
         },
+        "DoxygenBin": {
+          "type": "string",
+          "description": "The path of the doxygen bin directory (Default: C:\\Program Files\\doxygen\\bin)"
+        },
         "Help": {
           "type": "boolean",
           "description": "Shows the help text for this build assembly"
@@ -35,6 +39,10 @@
             "VSCode"
           ]
         },
+        "NoDocs": {
+          "type": "boolean",
+          "description": "Sets that no docs should be created"
+        },
         "NoLogo": {
           "type": "boolean",
           "description": "Disables displaying the NUKE logo"
@@ -65,6 +73,7 @@
             "type": "string",
             "enum": [
               "Compile",
+              "Docs",
               "Info",
               "Pack",
               "Restore"
@@ -82,6 +91,7 @@
             "type": "string",
             "enum": [
               "Compile",
+              "Docs",
               "Info",
               "Pack",
               "Restore"

src/build/Build.cs

@@ -1,8 +1,9 @@
+using System.IO;
+using Serilog;
 using Nuke.Common;
 using Nuke.Common.IO;
 using Nuke.Common.ProjectModel;
 using Nuke.Common.Tools.DotNet;
-using Serilog;
 
 namespace BuildTool
 {
@@ -13,13 +14,21 @@ class Build : NukeBuild
         [Parameter("Version of the package")]
         public readonly string Version = "0.0.0";
 
+        [Parameter("The path of the doxygen bin directory (Default: C:\\Program Files\\doxygen\\bin)")]
+        public readonly string DoxygenBin = "C:\\Program Files\\doxygen\\bin";
+
+        [Parameter("Sets that no docs should be created")]
+        public readonly bool NoDocs = false;
+
         [Solution]
         public readonly Solution Solution;
 
         // Allways set config to release, because build is intended for creating ready to ship packages
         private readonly Configuration _configuration = Configuration.Release;
 
         private static AbsolutePath _packages => RootDirectory / "nuget" / "packages";
+        private static AbsolutePath _doxygenWorkingDir => RootDirectory / "doxygen";
+        private static AbsolutePath _doxyfile => _doxygenWorkingDir / "Doxyfile";
 
         Target Info => _ => _
             .Unlisted()
@@ -54,6 +63,7 @@ class Build : NukeBuild
         Target Pack => _ => _
             .DependsOn(Info)
             .DependsOn(Compile)
+            .Triggers(Docs)
             .Executes(() =>
             {
                 DotNetTasks.DotNetPack(s => s
@@ -64,7 +74,43 @@ class Build : NukeBuild
                     .SetVersion(Version)
                     .SetFileVersion(Version)
                     .SetAssemblyVersion(Version)
-                    .SetProperty("PackageReleaseNotes", "https://github.com/basicx-StrgV/WGet.NET/releases/tag/" + Version));
+                    .SetProperty("PackageReleaseNotes", $"https://github.com/basicx-StrgV/WGet.NET/releases/tag/{Version}"));
             });
+
+        Target Docs => _ => _
+        .OnlyWhenDynamic(() => !NoDocs)
+        .Executes(() =>
+        {
+            if (!Directory.Exists(DoxygenBin))
+            {
+                Assert.Fail($"The doxygen bin directory does not exist ({DoxygenBin})");
+            }
+
+            if (!Directory.Exists(_doxygenWorkingDir))
+            {
+                Assert.Fail($"The doxygen process working directory does not exist ({_doxygenWorkingDir})");
+            }
+
+            string doxygenExe = DoxygenBin + Path.DirectorySeparatorChar + "doxygen.exe";
+
+            if (!File.Exists(doxygenExe))
+            {
+                Assert.Fail($"The doxygen executable does not exist ({doxygenExe})");
+            }
+
+            if (!File.Exists(_doxyfile))
+            {
+                Assert.Fail($"The doxyfile does not exist ({_doxyfile})");
+            }
+
+            DoxygenHandler doxygen = new DoxygenHandler(_doxyfile, doxygenExe, _doxygenWorkingDir);
+
+            bool result = doxygen.GenerateDocs(Version);
+
+            if (!result)
+            {
+                Assert.Fail("Failed to generate docs");
+            }
+        });
     }
 }

src/build/DoxygenHandler.cs

@@ -0,0 +1,107 @@
+using Serilog;
+using System;
+using System.IO;
+using System.Diagnostics;
+
+namespace BuildTool
+{
+    public class DoxygenHandler
+    {
+        private readonly string _doxyfile;
+        private readonly string _doxygen;
+        private readonly string _workingDir;
+
+        public DoxygenHandler(string doxyfile, string doxygen, string workingDir)
+        {
+            _doxyfile = doxyfile;
+            _doxygen = doxygen;
+            _workingDir = workingDir;
+        }
+
+        public bool GenerateDocs(string projectVersion)
+        {
+            try
+            {
+                Log.Information("Updating doxyfile");
+
+                if (!UpdateDoxyfile(projectVersion))
+                {
+                    Log.Error("Failed to update the doxyfile");
+                    return false;
+                }
+
+                Log.Information("Executing doxygen");
+
+                int exitCode = ExecuteDoxygen();
+
+                if (exitCode != 0)
+                {
+                    Log.Error("The doxygen process failed with the exit code \"{exitCode}\"", exitCode);
+                    return false;
+                }
+            }
+            catch (Exception e)
+            {
+                Log.Error("Exception thrown on docs generation: {ex}", e);
+                return false;
+            }
+
+            return true;
+        }
+
+        private bool UpdateDoxyfile(string projectVersion)
+        {
+            string[] doxyfileContent = File.ReadAllLines(_doxyfile);
+
+            for (int i = 0; i < doxyfileContent.Length; i++)
+            {
+                if (doxyfileContent[i].Trim().StartsWith("PROJECT_NUMBER"))
+                {
+                    doxyfileContent[i] = $"PROJECT_NUMBER = {projectVersion}";
+
+                    File.WriteAllLines(_doxyfile, doxyfileContent);
+
+                    return true;
+                }
+            }
+
+            return false;
+        }
+
+        private int ExecuteDoxygen()
+        {
+            ProcessStartInfo startInfo = new ProcessStartInfo()
+            {
+                FileName = _doxygen,
+                Arguments = $"\"{_doxyfile}\"",
+                WorkingDirectory = _workingDir,
+                CreateNoWindow = true,
+                WindowStyle = ProcessWindowStyle.Hidden,
+                UseShellExecute = false,
+                RedirectStandardOutput = true,
+            };
+
+            Process doxygenProc = new Process();
+            doxygenProc.StartInfo = startInfo;
+
+            doxygenProc.Start();
+
+            using (StreamReader output = doxygenProc.StandardOutput)
+            {
+                // Log the doxygen output
+                Log.Information(output.ReadLine());
+            }
+
+            // Wait for process exit with a timeout of 10 min
+            doxygenProc.WaitForExit(600000);
+
+            if (!doxygenProc.HasExited)
+            {
+                // Kill the process if it has not exited at this point
+                doxygenProc.Kill();
+            }
+
+            return doxygenProc.ExitCode;
+        }
+    }
+}

src/build/_build.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>net6.0</TargetFramework>
-    <RootNamespace></RootNamespace>
+    <RootNamespace>BuildTool</RootNamespace>
     <NoWarn>CS0649;CS0169;CA1050;CA1822;CA2211;IDE1006</NoWarn>
     <NukeRootDirectory>..\..</NukeRootDirectory>
     <NukeScriptDirectory>..</NukeScriptDirectory>