-
-
Notifications
You must be signed in to change notification settings - Fork 281
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
Fix doxygen errors #3962
Merged
Merged
Fix doxygen errors #3962
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
2f4614c
Fix doxygen errors
byrnHDF e771dfb
Add doxygen action uses step
byrnHDF 579ed75
Add line space before snippet use
byrnHDF b6562a2
Try adding sections
byrnHDF b5582d4
Use html div around snippet
byrnHDF 3228d26
Allow preset name to be an argument to cmake-ctest.yml
byrnHDF 208a01c
Correct grammer
byrnHDF File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,6 +8,10 @@ on: | |
| description: "The common base name of the source tarballs" | ||
| required: true | ||
| type: string | ||
| preset_name: | ||
| description: "The common base name of the preset configuration name to control the build" | ||
| required: true | ||
| type: string | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
@@ -24,6 +28,11 @@ jobs: | |
| - name: Install Dependencies (Windows) | ||
| run: choco install ninja | ||
|
|
||
| - name: Install Dependencies | ||
| uses: ssciwr/doxygen-install@v1 | ||
| with: | ||
| version: "1.10.0" | ||
|
|
||
| - name: Enable Developer Command Prompt | ||
| uses: ilammy/[email protected] | ||
|
|
||
|
|
@@ -59,7 +68,7 @@ jobs: | |
| - name: Run ctest (Windows) | ||
| run: | | ||
| cd "${{ runner.workspace }}/hdf5/hdfsrc" | ||
| cmake --workflow --preset=ci-StdShar-MSVC --fresh | ||
| cmake --workflow --preset=${{ inputs.preset_name }}-MSVC --fresh | ||
| shell: bash | ||
|
|
||
| - name: Publish binary (Windows) | ||
|
|
@@ -70,7 +79,7 @@ jobs: | |
| Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/COPYING -Destination ${{ runner.workspace }}/build/hdf5/ | ||
| Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 -Destination ${{ runner.workspace }}/build/hdf5/ | ||
| Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/README.md -Destination ${{ runner.workspace }}/build/hdf5/ | ||
| Copy-Item -Path ${{ runner.workspace }}/hdf5/build/ci-StdShar-MSVC/* -Destination ${{ runner.workspace }}/build/hdf5/ -Include *.zip | ||
| Copy-Item -Path ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-MSVC/* -Destination ${{ runner.workspace }}/build/hdf5/ -Include *.zip | ||
| cd "${{ runner.workspace }}/build" | ||
| 7z a -tzip ${{ steps.set-file-base.outputs.FILE_BASE }}-win-vs2022_cl.zip hdf5 | ||
| shell: pwsh | ||
|
|
@@ -96,7 +105,12 @@ jobs: | |
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Install CMake Dependencies (Linux) | ||
| run: sudo apt-get install ninja-build doxygen graphviz | ||
| run: sudo apt-get install ninja-build graphviz | ||
|
|
||
| - name: Install Dependencies | ||
| uses: ssciwr/doxygen-install@v1 | ||
| with: | ||
| version: "1.10.0" | ||
|
|
||
| - name: Set file base name (Linux) | ||
| id: set-file-base | ||
|
|
@@ -122,7 +136,7 @@ jobs: | |
| - name: Run ctest (Linux) | ||
| run: | | ||
| cd "${{ runner.workspace }}/hdf5/hdfsrc" | ||
| cmake --workflow --preset=ci-StdShar-GNUC --fresh | ||
| cmake --workflow --preset=${{ inputs.preset_name }}-GNUC --fresh | ||
| shell: bash | ||
|
|
||
| - name: Publish binary (Linux) | ||
|
|
@@ -133,7 +147,7 @@ jobs: | |
| cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/hdfsrc/README.md ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/build/ci-StdShar-GNUC/*.tar.gz ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC/*.tar.gz ${{ runner.workspace }}/build/hdf5 | ||
| cd "${{ runner.workspace }}/build" | ||
| tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-ubuntu-2204_gcc.tar.gz hdf5 | ||
| shell: bash | ||
|
|
@@ -156,7 +170,7 @@ jobs: | |
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: docs-doxygen | ||
| path: ${{ runner.workspace }}/hdf5/build/ci-StdShar-GNUC/hdf5lib_docs/html | ||
| path: ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC/hdf5lib_docs/html | ||
| if-no-files-found: error # 'warn' or 'ignore' are also available, defaults to `warn` | ||
|
|
||
| build_and_test_mac: | ||
|
|
@@ -166,7 +180,12 @@ jobs: | |
| runs-on: macos-11 | ||
| steps: | ||
| - name: Install Dependencies (MacOS) | ||
| run: brew install ninja doxygen | ||
| run: brew install ninja | ||
|
|
||
| - name: Install Dependencies | ||
| uses: ssciwr/doxygen-install@v1 | ||
| with: | ||
| version: "1.10.0" | ||
|
|
||
| - name: Set file base name (MacOS) | ||
| id: set-file-base | ||
|
|
@@ -201,7 +220,7 @@ jobs: | |
| id: run-ctest | ||
| run: | | ||
| cd "${{ runner.workspace }}/hdf5/hdfsrc" | ||
| cmake --workflow --preset=ci-StdShar-Clang --fresh | ||
| cmake --workflow --preset=${{ inputs.preset_name }}-Clang --fresh | ||
| shell: bash | ||
|
|
||
| - name: Publish binary (MacOS) | ||
|
|
@@ -212,7 +231,7 @@ jobs: | |
| cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/hdfsrc/README.md ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/build/ci-StdShar-Clang/*.tar.gz ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Clang/*.tar.gz ${{ runner.workspace }}/build/hdf5 | ||
| cd "${{ runner.workspace }}/build" | ||
| tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-osx12.tar.gz hdf5 | ||
| shell: bash | ||
|
|
@@ -265,7 +284,7 @@ jobs: | |
| - name: Run ctest (Linux S3) | ||
| run: | | ||
| cd "${{ runner.workspace }}/hdf5/hdfsrc" | ||
| cmake --workflow --preset=ci-StdShar-GNUC-S3 --fresh | ||
| cmake --workflow --preset=${{ inputs.preset_name }}-GNUC-S3 --fresh | ||
| shell: bash | ||
|
|
||
| - name: Publish binary (Linux S3) | ||
|
|
@@ -276,7 +295,7 @@ jobs: | |
| cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/hdfsrc/README.md ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/build/ci-StdShar-GNUC-S3/*.tar.gz ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC-S3/*.tar.gz ${{ runner.workspace }}/build/hdf5 | ||
| cd "${{ runner.workspace }}/build" | ||
| tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-ubuntu-2204_gcc_s3.tar.gz hdf5 | ||
| shell: bash | ||
|
|
@@ -350,7 +369,7 @@ jobs: | |
| CXX: ${{ steps.setup-fortran.outputs.cxx }} | ||
| run: | | ||
| cd "${{ runner.workspace }}/hdf5/hdfsrc" | ||
| cmake --workflow --preset=ci-StdShar-Intel --fresh | ||
| cmake --workflow --preset=${{ inputs.preset_name }}-Intel --fresh | ||
| shell: pwsh | ||
|
|
||
| - name: Publish binary (Windows_intel) | ||
|
|
@@ -361,7 +380,7 @@ jobs: | |
| Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/COPYING -Destination ${{ runner.workspace }}/build/hdf5/ | ||
| Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 -Destination ${{ runner.workspace }}/build/hdf5/ | ||
| Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/README.md -Destination ${{ runner.workspace }}/build/hdf5/ | ||
| Copy-Item -Path ${{ runner.workspace }}/hdf5/build/ci-StdShar-Intel/* -Destination ${{ runner.workspace }}/build/hdf5/ -Include *.zip | ||
| Copy-Item -Path ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Intel/* -Destination ${{ runner.workspace }}/build/hdf5/ -Include *.zip | ||
| cd "${{ runner.workspace }}/build" | ||
| 7z a -tzip ${{ steps.set-file-base.outputs.FILE_BASE }}-win-vs2022_intel.zip hdf5 | ||
| shell: pwsh | ||
|
|
@@ -424,7 +443,7 @@ jobs: | |
| CXX: ${{ steps.setup-fortran.outputs.cxx }} | ||
| run: | | ||
| cd "${{ runner.workspace }}/hdf5/hdfsrc" | ||
| cmake --workflow --preset=ci-StdShar-Intel --fresh | ||
| cmake --workflow --preset=${{ inputs.preset_name }}-Intel --fresh | ||
| shell: bash | ||
|
|
||
| - name: Publish binary (Linux_intel) | ||
|
|
@@ -435,7 +454,7 @@ jobs: | |
| cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/hdfsrc/README.md ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/build/ci-StdShar-Intel/*.tar.gz ${{ runner.workspace }}/build/hdf5 | ||
| cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Intel/*.tar.gz ${{ runner.workspace }}/build/hdf5 | ||
| cd "${{ runner.workspace }}/build" | ||
| tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-ubuntu-2204_intel.tar.gz hdf5 | ||
| shell: bash | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,41 @@ | ||
| /** \page predefined_datatypes_tables HDF5 Predefined Datatypes | ||
| * | ||
| * \section sec_predefined_datatypes_tables HDF5 Predefined Datatypes | ||
| * | ||
| * The following datatypes are predefined in HDF5. | ||
| * | ||
| * <div> | ||
| * \snippet{doc} tables/predefinedDatatypes.dox predefined_ieee_datatypes_table | ||
| * </div> | ||
| * | ||
| * <div> | ||
| * \snippet{doc} tables/predefinedDatatypes.dox predefined_std_datatypes_table | ||
| * | ||
| * </div> | ||
| * | ||
| * <div> | ||
| * \snippet{doc} tables/predefinedDatatypes.dox predefined_unix_datatypes_table | ||
| * | ||
| * </div> | ||
| * | ||
| * <div> | ||
| * \snippet{doc} tables/predefinedDatatypes.dox predefined_string_datatypes_table | ||
| * | ||
| * </div> | ||
| * | ||
| * <div> | ||
| * \snippet{doc} tables/predefinedDatatypes.dox predefined_intel_datatypes_table | ||
| * | ||
| * </div> | ||
| * | ||
| * <div> | ||
| * \snippet{doc} tables/predefinedDatatypes.dox predefined_dec_datatypes_table | ||
| * | ||
| * </div> | ||
| * | ||
| * <div> | ||
| * \snippet{doc} tables/predefinedDatatypes.dox predefined_mips_datatypes_table | ||
| * | ||
| * </div> | ||
| * | ||
| * <div> | ||
| * \snippet{doc} tables/predefinedDatatypes.dox predefined_native_datatypes_table | ||
| * | ||
| * </div> | ||
| * | ||
| * <div> | ||
| * \snippet{doc} tables/predefinedDatatypes.dox predefined_c9x_datatypes_table | ||
| * </div> | ||
| */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to not -> not to