Some modules are not at the correct place anymore.
For example, we split core + utility, and ranges. Both splits did not fix the documentation.
Please check the module for the following:
Public API is at the right \ingroup. When you go through the module, everything that shows up actually belongs to this (sub-)module.
Check the Landing Page. It should at least have a meaningful description, scan through the description, if there is one, and verify that it is up-to-date.
If you encounter an entry to appear twice. Check if the documentation may have a \relates AND an \ingroup command. They should only have one of them! If it has both, remove the \ingroup.
NEW RULE Every entity should link to it's (submodule page)! (This probably has to be adapted a lot) So if e.g. seqan3::align_cfg::method_global is in \ingroup alignment_configuration then at the same spot, one should add a \remark with a custom text or \see alignment_configuration in the end.
Example
```
/*!\brief Some brief
* \ingroup submodule_name
*
* some detailed description blah blah.
*
* \remark For a complete overview, take a look at \ref submodule_name
*/
class some_class
```
smehringer
commented
2 years ago
Description
Some modules are not at the correct place anymore.
For example, we split
core+utility, andranges. Both splits did not fix the documentation.Please check the module for the following:
\ingroup. When you go through the module, everything that shows up actually belongs to this (sub-)module.\relatesAND an\ingroupcommand. They should only have one of them! If it has both, remove the\ingroup.NEW RULE Every entity should link to it's (submodule page)! (This probably has to be adapted a lot) So if e.g. seqan3::align_cfg::method_global is in
\ingroup alignment_configurationthen at the same spot, one should add a\remarkwith a custom text or\see alignment_configurationin the end.Example
``` /*!\brief Some brief * \ingroup submodule_name * * some detailed description blah blah. * * \remark For a complete overview, take a look at \ref submodule_name */ class some_class ```Part of https://github.com/seqan/seqan3/issues/2685
Tasks
Provides seqan3:interleaved_bloom_filter.is missing a second::. (Other module pages have the same issue) - Remark: this is fixed with https://github.com/seqan/seqan3/pull/2840 (Search)