aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/ScintillaBase.h
diff options
context:
space:
mode:
authornyamatongwe <unknown>2001-02-24 01:07:27 +0000
committernyamatongwe <unknown>2001-02-24 01:07:27 +0000
commitbeff3c5b25efb39a764d0804dec03bee5a9ea566 (patch)
treee911b597b858d5942f7453b6bd3d7fa5e4294ee3 /src/ScintillaBase.h
parentecc12b1f7beb6a65bf03b6fb87139911ff938c19 (diff)
downloadscintilla-mirror-beff3c5b25efb39a764d0804dec03bee5a9ea566.tar.gz
Updated documentation comments from Philippe.
Diffstat (limited to 'src/ScintillaBase.h')
-rw-r--r--src/ScintillaBase.h13
1 files changed, 9 insertions, 4 deletions
diff --git a/src/ScintillaBase.h b/src/ScintillaBase.h
index 04abbd10f..758f75a4c 100644
--- a/src/ScintillaBase.h
+++ b/src/ScintillaBase.h
@@ -1,17 +1,22 @@
// Scintilla source code edit control
-// ScintillaBase.h - defines an enhanced subclass of Editor with calltips, autocomplete and context menu
+/** @file ScintillaBase.h
+ ** Defines an enhanced subclass of Editor with calltips, autocomplete and context menu.
+ **/
// Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org>
// The License.txt file describes the conditions under which this software may be distributed.
#ifndef SCINTILLABASE_H
#define SCINTILLABASE_H
+/**
+ */
class ScintillaBase : public Editor {
// Private so ScintillaBase objects can not be copied
ScintillaBase(const ScintillaBase &) : Editor() {}
ScintillaBase &operator=(const ScintillaBase &) { return *this; }
+
protected:
- // Enumeration of commands and child windows
+ /** Enumeration of commands and child windows. */
enum {
idCallTip=1,
idAutoComplete=2,
@@ -30,8 +35,8 @@ protected:
CallTip ct;
- int listType; // 0 is an autocomplete list
- SString userListSelected; // Receives listbox selected string
+ int listType; ///< 0 is an autocomplete list
+ SString userListSelected; ///< Receives listbox selected string
#ifdef SCI_LEXER
int lexLanguage;