Merge pull request #3297 from bska/fix-copy-paste-doc
Fix Copy-Pasted Function Documentation
This commit is contained in:
commit
680246b1ca
@ -166,12 +166,12 @@ public:
|
|||||||
|
|
||||||
/// Retrive result set's segments for single MS well.
|
/// Retrive result set's segments for single MS well.
|
||||||
///
|
///
|
||||||
/// \param[in] well Named MS well. Should usually be one of the
|
/// \param[in] well Well number. Should be between zero and \code
|
||||||
/// items in the return value from \code wells() \endcode.
|
/// numWells() - 1 \endcode inclusive.
|
||||||
///
|
///
|
||||||
/// \return range of \c well's segments matching the input request.
|
/// \return range of \c well's segments matching the input request.
|
||||||
/// Empty unless \p well is one of the return values from \code
|
/// Empty unless \p well is between zero and \code numWells() - 1
|
||||||
/// wells() \endcode.
|
/// \endcode inclusive.
|
||||||
WellSegmentRange segments(const std::size_t well) const;
|
WellSegmentRange segments(const std::size_t well) const;
|
||||||
|
|
||||||
friend class SegmentMatcher;
|
friend class SegmentMatcher;
|
||||||
|
Loading…
Reference in New Issue
Block a user