Fix Doxygen warnings due to documenting overloaded functions together.

Apparently we can't make @param statements apply just to some overloads, so
document them separately now.

See #15346.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74704 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2013-08-24 14:33:28 +00:00
parent 9e9574fe45
commit 8516f4fc7a
3 changed files with 44 additions and 21 deletions

View File

@@ -1300,14 +1300,34 @@ public:
*/
virtual bool GetStyle(long position, wxTextAttr& style);
//@{
/**
This function finds the character at the specified position expressed
in pixels.
Finds the position of the character at the specified point.
The two overloads of this method allow to find either the position of
the character, as an index into the text control contents, or its row
and column.
If the return code is not @c wxTE_HT_UNKNOWN the row and column of the
character closest to this position are returned, otherwise the output
parameters are not modified.
Please note that this function is currently only implemented in wxUniv,
wxMSW and wxGTK2 ports and always returns @c wxTE_HT_UNKNOWN in the
other ports.
@beginWxPerlOnly
In wxPerl this function takes only the @a pt argument and
returns a 3-element list (result, col, row).
@endWxPerlOnly
@param pt
The position of the point to check, in window device coordinates.
@param pos
Receives the position of the character at the given position. May
be @NULL.
@see PositionToXY(), XYToPosition()
*/
wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
/**
Finds the row and column of the character at the specified point.
If the return code is not @c wxTE_HT_UNKNOWN the row and column of the
character closest to this position are returned, otherwise the output
@@ -1330,17 +1350,12 @@ public:
@param row
Receives the row of the character at the given position. May be
@NULL.
@param pos
Receives the position of the character at the given position. May
be @NULL.
@see PositionToXY(), XYToPosition()
*/
wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
wxTextCoord *col,
wxTextCoord *row) const;
//@}
/**
Returns @true if the text has been modified by user.