Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC,INFRA] Doxygen groups #3200

Merged
merged 1 commit into from
Oct 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ namespace seqan3
/*!\interface seqan3::aligned_sequence <>
* \extends seqan3::sequence
* \brief The generic concept for an aligned sequence.
* \ingroup aligned_sequence
* \ingroup alignment_aligned_sequence
*
* This concept describes the requirements a sequence must fulfil in order to represent a sequence in an alignment.
*
Expand All @@ -111,7 +111,7 @@ concept aligned_sequence = sequence<t> && std::equality_comparable_with<std::ran
* \extends seqan3::aligned_sequence
* \extends std::ranges::forward_range
* \brief The generic concept for an aligned sequence that is writable.
* \ingroup aligned_sequence
* \ingroup alignment_aligned_sequence
*
* This concept describes the requirements a sequence must fulfill in order to be used inside of the alignment algorithm
* to store the final alignment.
Expand Down
24 changes: 24 additions & 0 deletions include/seqan3/std/new
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,30 @@

#ifndef __cpp_lib_hardware_interference_size

/*!\defgroup std std
* \brief A subset of the C++20 standard library made available in pre-C++20 contexts.
*
* \details
*
* This module provides many parts of the C++20 standard library (and some parts of the C++17 standard library
* not available in GCC). They are only defined if not found in the compiler's standard library and are called exactly
* like the originals so they can be used interchangeably.
*
* \attention All of this sub-module is subject to change!
*
* In particular:
*
* * We do not provide all C++20 library features, only those that are used by SeqAn.
* * All of these might change or be removed once C++20 is published.
* * The documentation of this module will likely be removed entirely in favour of links to
* https://en.cppreference.com
*
* It is best you consider every entity in this module as:
*
* \noapi
*
*/

/*!\defgroup std_new new
* \ingroup std
* \brief The [\<new\> header](https://en.cppreference.com/w/cpp/header/new) from C++17's standard library.
Expand Down
1 change: 1 addition & 0 deletions test/documentation/doc_dev/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ message (STATUS "Configuring devel doc.")

set (SEQAN3_DOXYGEN_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}")
set (SEQAN3_DOXYGEN_EXCLUDE_SYMBOLS "")
set (SEQAN3_DOXYGEN_EXCLUDE_PATTERNS "")
set (SEQAN3_DOXYGEN_PREDEFINED_NDEBUG "")
set (SEQAN3_DOXYGEN_ENABLED_SECTIONS "DEV")
set (SEQAN3_SHOW_DEV_DOCS "YES")
Expand Down
3 changes: 2 additions & 1 deletion test/documentation/doc_usr/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
message (STATUS "Configuring user doc.")

set (SEQAN3_DOXYGEN_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}")
set (SEQAN3_DOXYGEN_EXCLUDE_SYMBOLS "")
set (SEQAN3_DOXYGEN_EXCLUDE_SYMBOLS "seqan3::detail seqan3::simd")
set (SEQAN3_DOXYGEN_EXCLUDE_PATTERNS "*/utility/parallel/*.hpp */utility/simd/*.hpp */alignment/pairwise/policy/*.hpp")
set (SEQAN3_DOXYGEN_PREDEFINED_NDEBUG "-NDEBUG") #/""
set (SEQAN3_DOXYGEN_ENABLED_SECTIONS "") #/"DEV"
set (SEQAN3_SHOW_DEV_DOCS "NO") #/"YES"
Expand Down
2 changes: 1 addition & 1 deletion test/documentation/seqan3_doxygen_cfg.in
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS = */doc/*.cpp \
*/contrib/std/*.hpp \
*/utility/simd/*.hpp
${SEQAN3_DOXYGEN_EXCLUDE_PATTERNS}
EXCLUDE_SYMBOLS = seqan3::contrib \
${SEQAN3_DOXYGEN_EXCLUDE_SYMBOLS}
EXAMPLE_PATH = ${SEQAN3_DOXYGEN_SOURCE_DIR}
Expand Down