search

seqan / seqan3

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

[FIX] Documentation #3231

Closed eseiler closed 5 months ago

eseiler commented 5 months ago

For doxygen to work, the first line must be #... in the md files.

Even if we get the header line with grep -m1 "#" ${doc_howto_filepath} instead of head -n 1 ${doc_howto_filepath}, doxygen still needs the file to start with #, i.e., not the license header.

Luckily, the SPDX identifier doesn't have to be on the first line :)

To avoid this issue in the future, seqan3-doxygen-layout.cmake now throws a fatal error if the regex did not match.

The second commit removes \if DEV \implements ... \endif:

vercel[bot] commented 5 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
seqan3 ✅ Ready (Inspect) Visit Preview Jan 30, 2024 5:38pm
codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (45897e6) 98.17% compared to head (c79a603) 98.17%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #3231 +/- ## ======================================= Coverage 98.17% 98.17% ======================================= Files 269 269 Lines 11854 11854 ======================================= Hits 11638 11638 Misses 216 216 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.