Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CPP documentation #78

Merged
merged 1 commit into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,7 @@ jobs:
run: |
src\3rdparty\CommonTools\Output\PlaceHolderReplacer.exe .\src\ProductInformation\Version.cs .\src\packaging\nuget\datadistributionmanager.nuspec >> .\nuget_version.txt
src\3rdparty\CommonTools\Output\PlaceHolderReplacer.exe .\src\ProductInformation\Version.cs .\src\packaging\maven\pom.xml "-SNAPSHOT"
src\3rdparty\CommonTools\Output\PlaceHolderReplacer.exe .\src\ProductInformation\Version.cs .\src\documentation\Doxyfile

- name: Store version
run: |
Expand Down Expand Up @@ -416,19 +417,19 @@ jobs:
run: C:\msys64\usr\bin\wget.exe https://www.doxygen.nl/files/doxygen-1.12.0.windows.x64.bin.zip

- name: Expand Doxygen package
run: Expand-Archive -LiteralPath '.\doxygen-1.12.0.windows.x64.bin.zip' -DestinationPath .\src\Documentation -Force
run: Expand-Archive -LiteralPath '.\doxygen-1.12.0.windows.x64.bin.zip' -DestinationPath .\src\documentation -Force

- name: Create C/C++ documentation
shell: cmd
run: |
cd src\Documentation
cd src\documentation
doxygen Doxyfile

- run: dotnet tool update -g docfx

- name: Build documentation
run: |
cd src\Documentation
cd src\documentation
docfx

- uses: nuget/[email protected]
Expand Down
4 changes: 2 additions & 2 deletions src/documentation/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = Data Distribution Manager
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 1.1.0
PROJECT_NUMBER = __VERSION_PLACEHOLDER__

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down Expand Up @@ -864,7 +864,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = ../DataDistributionManager/DataDistributionManagerEnums.h ../DataDistributionManager/DataDistributionManagerTypes.h ../DataDistributionManager/DataDistributionManager.h ../DataDistributionManager/SmartDataDistributionManager.h
INPUT = ../native/DataDistributionManager/DataDistributionManagerEnums.h ../native/DataDistributionManager/DataDistributionManagerTypes.h ../native/DataDistributionManager/DataDistributionManager.h ../native/DataDistributionManager/SmartDataDistributionManager.h

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down
Loading