[DOC] Fix alignment_result doc

seqan · Nov 2, 2023 · 4fdf506 · 4fdf506
1 parent 999c0bf
commit 4fdf506
Showing 1 changed file with 34 additions and 6 deletions.
diff --git a/include/seqan3/alignment/pairwise/alignment_result.hpp b/include/seqan3/alignment/pairwise/alignment_result.hpp
@@ -233,7 +233,15 @@ class alignment_result
     }
 
     /*!\brief Returns the end position of the first sequence of the alignment.
-     * \return The calculated alignment end of sequence 1 (inclusive).
+     * \return The calculated alignment end of sequence 1 (exclusive).
+     * \details
+     *
+     * \if DEV
+     * The return type (default: `size_t`) is deduced from
+     * seqan3::detail::alignment_result_value_type::end_positions_t::first.
+     * \else
+     * The return type is `size_t`.
+     * \endif
      *
      * \note This function is only available if the end position of the first sequence was requested via the
      * alignment configuration (see seqan3::align_cfg::output_end_position).
@@ -247,7 +255,15 @@ class alignment_result
     }
 
     /*!\brief Returns the end position of the second sequence of the alignment.
-     * \return A pair of positions in the respective sequences, where the calculated alignment ends (inclusive).
+     * \return The calculated alignment end of sequence 2 (exclusive).
+     * \details
+     *
+     * \if DEV
+     * The return type (default: `size_t`) is deduced from
+     * seqan3::detail::alignment_result_value_type::end_positions_t::second.
+     * \else
+     * The return type is `size_t`.
+     * \endif
      *
      * \note This function is only available if the end position of the second sequence was requested via the
      * alignment configuration (see seqan3::align_cfg::output_end_position).
@@ -261,10 +277,16 @@ class alignment_result
     }
 
     /*!\brief Returns the begin position of the first sequence of the alignment.
-     * \return  A pair of positions in the respective sequences, where the calculated alignment starts.
-     *
+     * \return The calculated alignment begin of sequence 1 (inclusive).
      * \details
      *
+     * \if DEV
+     * The return type (default: `size_t`) is deduced from
+     * seqan3::detail::alignment_result_value_type::begin_positions_t::first.
+     * \else
+     * The return type is `size_t`.
+     * \endif
+     *
      * Guaranteed to be smaller than or equal to `sequence1_end_position()`.
      *
      * \note This function is only available if the begin position of the first sequence was requested via the
@@ -279,10 +301,16 @@ class alignment_result
     }
 
     /*!\brief Returns the begin position of the second sequence of the alignment.
-     * \return  A pair of positions in the respective sequences, where the calculated alignment starts.
-     *
+     * \return The calculated alignment begin of sequence 2 (inclusive).
      * \details
      *
+     * \if DEV
+     * The return type (default: `size_t`) is deduced from
+     * seqan3::detail::alignment_result_value_type::begin_positions_t::second.
+     * \else
+     * The return type is `size_t`.
+     * \endif
+     *
      * Guaranteed to be smaller than or equal to `sequence2_end_position()`.
      *
      * \note This function is only available if the begin position of the second sequence was requested via the