diff options
author | nyamatongwe <unknown> | 2001-02-24 01:07:27 +0000 |
---|---|---|
committer | nyamatongwe <unknown> | 2001-02-24 01:07:27 +0000 |
commit | beff3c5b25efb39a764d0804dec03bee5a9ea566 (patch) | |
tree | e911b597b858d5942f7453b6bd3d7fa5e4294ee3 | |
parent | ecc12b1f7beb6a65bf03b6fb87139911ff938c19 (diff) | |
download | scintilla-mirror-beff3c5b25efb39a764d0804dec03bee5a9ea566.tar.gz |
Updated documentation comments from Philippe.
-rw-r--r-- | src/ScintillaBase.cxx | 4 | ||||
-rw-r--r-- | src/ScintillaBase.h | 13 | ||||
-rw-r--r-- | src/Style.cxx | 4 | ||||
-rw-r--r-- | src/Style.h | 6 | ||||
-rw-r--r-- | src/UniConversion.cxx | 5 |
5 files changed, 24 insertions, 8 deletions
diff --git a/src/ScintillaBase.cxx b/src/ScintillaBase.cxx index eb769923c..648bd03ac 100644 --- a/src/ScintillaBase.cxx +++ b/src/ScintillaBase.cxx @@ -1,5 +1,7 @@ // Scintilla source code edit control -// ScintillaBase.cxx - an enhanced subclass of Editor with calltips, autocomplete and context menu +/** @file ScintillaBase.cxx + ** 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. 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; diff --git a/src/Style.cxx b/src/Style.cxx index 9224d76b2..4ea1f8776 100644 --- a/src/Style.cxx +++ b/src/Style.cxx @@ -1,5 +1,7 @@ // Scintilla source code edit control -// Style.cxx - defines the font and colour style for a class of text +/** @file Style.cxx + ** Defines the font and colour style for a class of text. + **/ // Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org> // The License.txt file describes the conditions under which this software may be distributed. diff --git a/src/Style.h b/src/Style.h index cde2df177..cc66df7aa 100644 --- a/src/Style.h +++ b/src/Style.h @@ -1,11 +1,15 @@ // Scintilla source code edit control -// Style.h - defines the font and colour style for a class of text +/** @file Style.h + ** Defines the font and colour style for a class of text. + **/ // Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org> // The License.txt file describes the conditions under which this software may be distributed. #ifndef STYLE_H #define STYLE_H +/** + */ class Style { public: ColourPair fore; diff --git a/src/UniConversion.cxx b/src/UniConversion.cxx index 755beac1a..c3f960c62 100644 --- a/src/UniConversion.cxx +++ b/src/UniConversion.cxx @@ -1,4 +1,7 @@ -// UniConversion.h - functions to handle UFT-8 and UCS-2 strings +// Scintilla source code edit control +/** @file UniConversion.cxx + ** Functions to handle UFT-8 and UCS-2 strings. + **/ // Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org> // The License.txt file describes the conditions under which this software may be distributed. |