diff options
Diffstat (limited to 'src/CallTip.h')
| -rw-r--r-- | src/CallTip.h | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/src/CallTip.h b/src/CallTip.h index c30c8f3b8..b38a4840a 100644 --- a/src/CallTip.h +++ b/src/CallTip.h @@ -1,11 +1,15 @@ // Scintilla source code edit control -// CallTip.h - interface to the call tip control +/** @file CallTip.h + ** Interface to the call tip control. + **/ // Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org> // The License.txt file describes the conditions under which this software may be distributed. #ifndef CALLTIP_H #define CALLTIP_H +/** + */ class CallTip { int startHighlight; int endHighlight; @@ -14,6 +18,7 @@ class CallTip { // Private so CallTip objects can not be copied CallTip(const CallTip &) {} CallTip &operator=(const CallTip &) { return *this; } + public: Window wCallTip; Window wDraw; @@ -28,19 +33,19 @@ public: CallTip(); ~CallTip(); - // Claim or accept palette entries for the colours required to paint a calltip + /// Claim or accept palette entries for the colours required to paint a calltip. void RefreshColourPalette(Palette &pal, bool want); void PaintCT(Surface *surfaceWindow); - // Setup the calltip and return a rectangle of the area required + /// Setup the calltip and return a rectangle of the area required. PRectangle CallTipStart(int pos, Point pt, const char *defn, const char *faceName, int size); void CallTipCancel(); - // Set a range of characters to be displayed in a highlight style. - // Commonly used to highlight the current parameter. + /// Set a range of characters to be displayed in a highlight style. + /// Commonly used to highlight the current parameter. void SetHighlight(int start, int end); }; |