[DOC] Apply 2. Review

Signed-off-by: Lydia Buntrock <lydia.buntrock@fu-berlin.de>
seqan · Feb 8, 2021 · 0328007 · 0328007
1 parent ebfc556
commit 0328007
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/include/detect_breakends/junction_detection.hpp b/include/detect_breakends/junction_detection.hpp
@@ -17,10 +17,10 @@
  *                                                           2: split_read,
  *                                                           3: read_pairs,
  *                                                           4: read_depth)
- * \param clustering_method list of Methods for clustering junctions (0: simple_clustering
- *                                                                    1: hierarchical_clustering,
- *                                                                    2: self-balancing_binary_tree,
- *                                                                    3: candidate_selection_based_on_voting)
+ * \param clustering_method method for clustering junctions (0: simple_clustering
+ *                                                           1: hierarchical_clustering,
+ *                                                           2: self-balancing_binary_tree,
+ *                                                           3: candidate_selection_based_on_voting)
  *
  * \details Detects junctions from the CIGAR strings and supplementary alignment tags of read alignment records.
  *          We sort out unmapped alignments, secondary alignments, duplicates and alignments with low mapping quality.

diff --git a/src/detect_breakends/junction_detection.cpp b/src/detect_breakends/junction_detection.cpp
@@ -224,10 +224,10 @@ void analyze_cigar(std::string chromosome,
  *                                                           2: split_read,
  *                                                           3: read_pairs,
  *                                                           4: read_depth)
- * \param clustering_method list of Methods for clustering junctions (0: simple_clustering
- *                                                                    1: hierarchical_clustering,
- *                                                                    2: self-balancing_binary_tree,
- *                                                                    3: candidate_selection_based_on_voting)
+ * \param clustering_method method for clustering junctions (0: simple_clustering
+ *                                                           1: hierarchical_clustering,
+ *                                                           2: self-balancing_binary_tree,
+ *                                                           3: candidate_selection_based_on_voting)
  * \endcond
  *
  * \details Detects junctions from the CIGAR strings and supplementary alignment tags of read alignment records.