Merge pull request #3297 from bska/fix-copy-paste-doc

Fix Copy-Pasted Function Documentation
This commit is contained in:
Arne Morten Kvarving 2022-12-20 17:05:59 +01:00 committed by GitHub
commit 680246b1ca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -166,12 +166,12 @@ public:
/// Retrive result set's segments for single MS well.
///
/// \param[in] well Named MS well. Should usually be one of the
/// items in the return value from \code wells() \endcode.
/// \param[in] well Well number. Should be between zero and \code
/// numWells() - 1 \endcode inclusive.
///
/// \return range of \c well's segments matching the input request.
/// Empty unless \p well is one of the return values from \code
/// wells() \endcode.
/// Empty unless \p well is between zero and \code numWells() - 1
/// \endcode inclusive.
WellSegmentRange segments(const std::size_t well) const;
friend class SegmentMatcher;