search

seqan / seqan3

The modern C++ library for sequence analysis. Contains version 3 of the library and API docs.
https://www.seqan.de
Other
405 stars 81 forks source link

Doxygen warnings #108

Closed h-2 closed 6 years ago

h-2 commented 6 years ago

We really need to get rid of the warnings so that we a have clean state once and for all.

This is the list of files and responsible people:

@h-2:

@rrahn:

@sarahet:

@marehr:

@mariehoffmann:

These files should be excluded from doxygen for now:

marehr commented 6 years ago

127, #133, #139 fixed almost all documentation issues

@h-2 There is only one missing and I don't know what you wanted to express https://github.com/seqan/seqan3/blob/410d4d4dd0ba0bbc48391f38f575bd9e1e0e0cb2/include/seqan3/range/container/concatenated_sequences.hpp#L1308-L1320

/home/marehr/develope/seqan3/include/seqan3/range/container/concatenated_sequences.hpp:1312:
warning: unable to resolve reference to `serialisation' for \ref command
h-2 commented 6 years ago

@h-2 There is only one missing and I don't know what you wanted to express

Just remove the \ref and add (TODO link) behind it :wink:

rrahn commented 6 years ago

I kept the ref but added a page in the all.hpp of the IO module. There we can add at some point some description for the serialisation in seqan using cereal. (see #187 for the corresponding issue) Now we also have CI for the dev/user docu.