argument_parser: doxygen gives me a lot of warnings

[marehr]

I get a ton of warnings building our documentation.

Apparently, short_id seems to be the issue.

https://github.com/seqan/seqan3/blob/7fbbefe94b542499ad58bd9293092fe9b84b2a9e/include/seqan3/argument_parser/argument_parser.hpp#L270-L279

I think this is caused by this:

Note that unlike standard Markdown, doxygen leaves the following untouched.

A cool' word in anice' sentence.

In other words; a single quote cancels the special treatment of a code span wrapped in a pair of backtick characters. This extra restriction was added for backward compatibility reasons.

https://www.stack.nl/~dimitri/doxygen/manual/markdown.html#mddox_code_spans

complete warning log:

warning: Tag `CLANG_ASSISTED_PARSING' at line 1020 of file `Doxyfile' belongs to an option that was not enabled at compile time.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled.
warning: Tag `CLANG_OPTIONS' at line 1028 of file `Doxyfile' belongs to an option that was not enabled at compile time.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled.
seqan3/include/seqan3/argument_parser/argument_parser.hpp:280: warning: The following parameters of seqan3::argument_parser::add_flag(bool &value, char const short_id, std::string const &long_id, std::string const &desc, option_spec const &spec=option_spec::DEFAULT) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/argument_parser.hpp:251: warning: The following parameters of seqan3::argument_parser::add_option(option_type &value, char const short_id, std::string const &long_id, std::string const &desc, option_spec const &spec=option_spec::DEFAULT, validator_type validator=validator_type{}) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/detail/format_help.hpp:123: warning: The following parameters of seqan3::detail::format_help::add_flag(bool &, char const short_id, std::string const &long_id, std::string const &desc, option_spec const &spec) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/detail/format_help.hpp:101: warning: The following parameters of seqan3::detail::format_help::add_option(option_type &value, char const short_id, std::string const &long_id, std::string const &desc, option_spec const &spec, validator_type &&validator) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/detail/format_html.hpp:99: warning: The following parameters of seqan3::detail::format_html::add_flag(bool &, char const short_id, std::string const &long_id, std::string const &desc, option_spec const &spec) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/detail/format_html.hpp:77: warning: The following parameters of seqan3::detail::format_html::add_option(option_type &value, char const short_id, std::string const &long_id, std::string const &desc, option_spec const &spec, validator_type &&validator) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/detail/format_man.hpp:97: warning: The following parameters of seqan3::detail::format_man::add_flag(bool &, char const short_id, std::string const &long_id, std::string const &desc, option_spec const &spec) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/detail/format_man.hpp:75: warning: The following parameters of seqan3::detail::format_man::add_option(option_t &value, char const short_id, std::string const &long_id, std::string const &desc, option_spec const &spec, validator_type &&validator) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/detail/format_parse.hpp:138: warning: The following parameters of seqan3::detail::format_parse::add_flag(bool &value, char const short_id, std::string const &long_id, std::string const &, option_spec const &) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/detail/format_parse.hpp:117: warning: The following parameters of seqan3::detail::format_parse::add_option(option_type &value, char const short_id, std::string const &long_id, std::string const &, option_spec const &spec, validator_type &&validator) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/detail/format_parse.hpp:649: warning: The following parameters of seqan3::detail::format_parse::get_flag(bool &value, char const short_id, std::string const &long_id) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/detail/format_parse.hpp:606: warning: The following parameters of seqan3::detail::format_parse::get_option(option_type &value, char const short_id, std::string const &long_id, option_spec const &spec, validator_type &&validator) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/detail/format_help.hpp:123: warning: The following parameters of seqan3::detail::format_help::add_flag(bool &, char const short_id, std::string const &long_id, std::string const &desc, option_spec const &spec) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/detail/format_help.hpp:101: warning: The following parameters of seqan3::detail::format_help::add_option(option_type &value, char const short_id, std::string const &long_id, std::string const &desc, option_spec const &spec, validator_type &&validator) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/detail/format_help.hpp:743: warning: The following parameters of seqan3::detail::format_version::add_flag(bool &value, char const short_id, std::string const &long_id, std::string const &desc, option_spec const &spec) are not documented:
  parameter 'long_id'
seqan3/include/seqan3/argument_parser/detail/format_help.hpp:719: warning: The following parameters of seqan3::detail::format_version::add_option(option_type &value, char const short_id, std::string const &long_id, std::string const &desc, option_spec const &spec, validator_type &&validator) are not documented:
  parameter 'long_id'

cc: @smehringer

[rrahn]

Please check your doxygen config. Nightly and CI doesn’t show any issues. So something must be wrong either in the Jenkins Pipeline or in your build

[marehr]

I have the config like in the wiki. I could remove the warning when removing the backticks in

`'i'`

[marehr]

I have doxygen version 1.8.14

[smehringer]

I don't get the warnings on my machine with doxygen 1.8.13. Shall I simply remove the backticks?

[marehr]

Would be nice :)