Skip to content

Commit

Permalink
fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
smehringer committed Mar 28, 2022
1 parent 2e9c603 commit d94c6ad
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
4 changes: 2 additions & 2 deletions include/seqan3/argument_parser/all.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@
*
* # The Argument Parser Class
*
* \copydetails seqan3::argument_parser
* todo copydetails sharg::argument_parser
*
* # Parsing Command Line Arguments
*
* \copydetails seqan3::argument_parser::parse
* todo copydetails sharg::argument_parser::parse
*
* # Argument Validation
*
Expand Down
2 changes: 1 addition & 1 deletion include/seqan3/argument_parser/argument_parser.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ using namespace sharg;
*/
class argument_parser : public sharg::argument_parser
{
using base_t = sharg::argument_parser;
using base_t = sharg::argument_parser; //!< The base type we inherit from.
public:
/*!\name Constructors, destructor and assignment
* \{
Expand Down
10 changes: 7 additions & 3 deletions include/seqan3/argument_parser/validators.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,11 @@ class input_file_validator : public sharg::input_file_validator
using sharg::input_file_validator::operator();
};

//!\cond
// guides are only needed because we inherit from the sharg::input_validator that does not have a template
template <typename file_t = void>
input_file_validator() -> input_file_validator<file_t>;
//!\endcond

/*!\brief A validator that checks if a given path is a valid output file.
* \ingroup argument_parser
Expand Down Expand Up @@ -175,9 +178,7 @@ class output_file_validator : public sharg::output_file_validator

/*!\brief Constructs from a given overwrite mode and a list of valid extensions.
* \param[in] mode A seqan3::output_file_open_options indicating whether the validator throws if a file already
exists.
* \param[in] extensions The valid extensions to validate for. Defaults to
* seqan3::output_file_validator::default_extensions.
* exists.
*/
explicit output_file_validator(output_file_open_options const mode)
: sharg::output_file_validator{mode, this->default_extensions()}
Expand Down Expand Up @@ -206,6 +207,8 @@ class output_file_validator : public sharg::output_file_validator
using sharg::output_file_validator::operator();
};

//!\cond
// guides are only needed because we inherit from the sharg::input_validator that does not have a template
template <typename file_t = void>
output_file_validator() -> output_file_validator<file_t>;

Expand All @@ -214,5 +217,6 @@ output_file_validator(output_file_open_options) -> output_file_validator<file_t>

template <typename file_t = void>
output_file_validator(output_file_open_options, std::vector<std::string>) -> output_file_validator<file_t>;
//!\endcond

} // namespace seqan3

0 comments on commit d94c6ad

Please sign in to comment.