From 0e65b97f8d14edabef6c1d8782da3367501dc7fe Mon Sep 17 00:00:00 2001 From: Thomas Broust Date: Thu, 2 Oct 2014 15:51:02 +0200 Subject: [PATCH 1/3] Integrates API doc generation in main build process Former-commit-id: d33ef50245694a3a4d02ae8c9c075f731b499b67 Former-commit-id: fab2fd9e657ff2fd9cecc7a32200d1dcc3143629 --- Doxyfile.REMOVED.git-id | 1 - build/Doxyfile.REMOVED.git-id | 1 + build/build.ps1 | 11 ++++++++++- document.bat | 3 --- 4 files changed, 11 insertions(+), 5 deletions(-) delete mode 100644 Doxyfile.REMOVED.git-id create mode 100644 build/Doxyfile.REMOVED.git-id delete mode 100644 document.bat diff --git a/Doxyfile.REMOVED.git-id b/Doxyfile.REMOVED.git-id deleted file mode 100644 index 0943c7f07..000000000 --- a/Doxyfile.REMOVED.git-id +++ /dev/null @@ -1 +0,0 @@ -80e95187691410ec3979cb1f9e4ca726878215c6 \ No newline at end of file diff --git a/build/Doxyfile.REMOVED.git-id b/build/Doxyfile.REMOVED.git-id new file mode 100644 index 000000000..9e5930093 --- /dev/null +++ b/build/Doxyfile.REMOVED.git-id @@ -0,0 +1 @@ +877afa6ca55ed11d2377363369ea1c39adace2d2 \ No newline at end of file diff --git a/build/build.ps1 b/build/build.ps1 index 62cb65435..a6fd768d3 100644 --- a/build/build.ps1 +++ b/build/build.ps1 @@ -35,7 +35,7 @@ Properties { Framework "4.0x86" FormatTaskName "-------- {0} --------" -task default -depends Cleanup-Binaries, Set-VersionNumber, Build-Solution, Run-Tests, Generate-Package +task default -depends Cleanup-Binaries, Set-VersionNumber, Build-Solution, Run-Tests, Generate-APIDoc, Generate-Package # cleans up the binaries output folder task Cleanup-Binaries { @@ -148,6 +148,15 @@ task Run-Coverage -depends Build-Tests { } } +# generates the API documentation +task Generate-APIDoc -depends Build-Solution { + Write-Host "Generating API docs" + + & .\tools\docu\docu.exe .\_BuildOutput\ImageProcessor\lib\net45\ImageProcessor.dll --output=.\_BuildOutput\Help\docu + + & .\tools\doxygen\doxygen.exe .\Doxyfile +} + # generates a Nuget package task Generate-Package -depends Set-VersionNumber, Build-Solution { Write-Host "Generating Nuget packages for each project" diff --git a/document.bat b/document.bat deleted file mode 100644 index d21e6af87..000000000 --- a/document.bat +++ /dev/null @@ -1,3 +0,0 @@ -.\build\tools\docu\docu.exe .\build\_BuildOutput\ImageProcessor\lib\net45\ImageProcessor.dll --output=.\build\_BuildOutput\Help\docu - -.\build\tools\doxygen\doxygen.exe .\Doxyfile \ No newline at end of file From aa1d5b9b7db5b6be386685898e073951d1c30581 Mon Sep 17 00:00:00 2001 From: Thomas Broust Date: Thu, 2 Oct 2014 16:01:08 +0200 Subject: [PATCH 2/3] Refactors a bit the build file Former-commit-id: fd11c3ed89cb3a11123abefc8a10f04896b732d9 Former-commit-id: 4a7889463454d29e6fd3c9ef3c251dff372ac415 --- build/build.ps1 | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/build/build.ps1 b/build/build.ps1 index a6fd768d3..41b98c792 100644 --- a/build/build.ps1 +++ b/build/build.ps1 @@ -14,6 +14,10 @@ Properties { $BIN_PATH = Join-Path $BUILD_PATH "_BuildOutput" $NUGET_OUTPUT = Join-Path $BIN_PATH "NuGets" $TEST_RESULTS = Join-Path $BUILD_PATH "TestResults" + + # API documentation + $API_BIN_PATH = Join-Path $BIN_PATH "ImageProcessor\lib\net45\ImageProcessor.dll" # from what Docu builds its help output + $API_DOC_PATH = Join-Path $BIN_PATH "Help\docu" # change this to switch to Doxygen help # External binaries paths $NUGET_EXE = Join-Path $SRC_PATH ".nuget\NuGet.exe" @@ -150,11 +154,11 @@ task Run-Coverage -depends Build-Tests { # generates the API documentation task Generate-APIDoc -depends Build-Solution { - Write-Host "Generating API docs" + Write-Host "Generating API docs" - & .\tools\docu\docu.exe .\_BuildOutput\ImageProcessor\lib\net45\ImageProcessor.dll --output=.\_BuildOutput\Help\docu + & .\tools\docu\docu.exe $API_BIN_PATH --output=$API_DOC_PATH - & .\tools\doxygen\doxygen.exe .\Doxyfile + & .\tools\doxygen\doxygen.exe .\Doxyfile } # generates a Nuget package From a4937c177c995bdc7e69c18118e21fa929dad2d4 Mon Sep 17 00:00:00 2001 From: Thomas Broust Date: Thu, 2 Oct 2014 16:28:56 +0200 Subject: [PATCH 3/3] Includes the help files in the nuget package Former-commit-id: 7bf9225928ccea6c80b22534221bae9def303696 Former-commit-id: 2e0c2247b421a11aa5c5b43668470fc0402f1ce0 --- build/NuSpecs/ImageProcessor.nuspec | 1 + build/build.ps1 | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/build/NuSpecs/ImageProcessor.nuspec b/build/NuSpecs/ImageProcessor.nuspec index e598faeef..25f95dee8 100644 --- a/build/NuSpecs/ImageProcessor.nuspec +++ b/build/NuSpecs/ImageProcessor.nuspec @@ -30,5 +30,6 @@ + \ No newline at end of file diff --git a/build/build.ps1 b/build/build.ps1 index 41b98c792..0eb0efb55 100644 --- a/build/build.ps1 +++ b/build/build.ps1 @@ -16,8 +16,8 @@ Properties { $TEST_RESULTS = Join-Path $BUILD_PATH "TestResults" # API documentation - $API_BIN_PATH = Join-Path $BIN_PATH "ImageProcessor\lib\net45\ImageProcessor.dll" # from what Docu builds its help output - $API_DOC_PATH = Join-Path $BIN_PATH "Help\docu" # change this to switch to Doxygen help + $API_BIN_PATH = Join-Path $BIN_PATH "ImageProcessor\lib\net45\ImageProcessor.dll" # from which DLL Docu builds its help output + $API_DOC_PATH = Join-Path $BIN_PATH "Help\docu" # External binaries paths $NUGET_EXE = Join-Path $SRC_PATH ".nuget\NuGet.exe" @@ -39,7 +39,7 @@ Properties { Framework "4.0x86" FormatTaskName "-------- {0} --------" -task default -depends Cleanup-Binaries, Set-VersionNumber, Build-Solution, Run-Tests, Generate-APIDoc, Generate-Package +task default -depends Cleanup-Binaries, Set-VersionNumber, Build-Solution, Run-Tests, Generate-APIDoc, Generate-Nuget # cleans up the binaries output folder task Cleanup-Binaries { @@ -162,7 +162,7 @@ task Generate-APIDoc -depends Build-Solution { } # generates a Nuget package -task Generate-Package -depends Set-VersionNumber, Build-Solution { +task Generate-Nuget -depends Set-VersionNumber, Build-Solution, Generate-APIDoc { Write-Host "Generating Nuget packages for each project" # Nuget doesn't create the output dir automatically...