Skip to content

Commit

Permalink
[DOC] Update doxygen to 1.9.3 and fix warnings (#59)
Browse files Browse the repository at this point in the history
Signed-off-by: Lydia Buntrock <[email protected]>

Co-authored-by: Enrico Seiler <[email protected]>
  • Loading branch information
Irallia and eseiler authored Feb 15, 2022
1 parent fbaf3e4 commit f702250
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci_misc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ jobs:
build_threads: 2
test_threads: 2
cmake: 3.10.3
doxygen: 1.9.2
doxygen: 1.9.3
requires_toolchain: false
requires_ccache: false
skip_build_tests: true
Expand Down
4 changes: 2 additions & 2 deletions include/sharg/argument_parser.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -160,8 +160,8 @@ class argument_parser
*
* \throws sharg::design_error if the application name contains illegal characters.
*
* The application name must only contain alpha-numeric characters, '_' or '-',
* i.e. the following regex must evaluate to true: `\"^[a-zA-Z0-9_-]+$\"`.
* The application name must only contain alpha-numeric characters, `_` or `-` ,
* i.e. the following regex must evaluate to true: `"^[a-zA-Z0-9_-]+$"` .
*
* See the [argument parser tutorial](https://docs.seqan.de/seqan/3-master-dev/tutorial_argument_parser.html)
* for more information about the version check functionality.
Expand Down
2 changes: 0 additions & 2 deletions include/sharg/validators.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,6 @@ class file_validator_base

/*!\brief Checks if the given path is readable.
* \param path The path to check.
* \returns `true` if readable, otherwise `false`.
* \throws sharg::validation_error if the path is not readable, or
* std::filesystem::filesystem_error on underlying OS API errors.
*/
Expand Down Expand Up @@ -391,7 +390,6 @@ class file_validator_base

/*!\brief Checks if the given path is writable.
* \param path The path to check.
* \returns `true` if writable, otherwise `false`.
* \throws sharg::validation_error if the file could not be opened for writing, or
* std::filesystem::filesystem_error on underlying OS API errors.
*/
Expand Down

1 comment on commit f702250

@vercel
Copy link

@vercel vercel bot commented on f702250 Feb 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.