diff options
| author | nyamatongwe <unknown> | 2001-02-24 01:07:27 +0000 |
|---|---|---|
| committer | nyamatongwe <unknown> | 2001-02-24 01:07:27 +0000 |
| commit | 730950e6a4cfe270bb33304f477148b9131d7fbd (patch) | |
| tree | 00849b12465c25919527022c1f03bd3da43da178 /src | |
| parent | 6da7f1fa2aee410a97deef5dd497d8bf0952ad03 (diff) | |
| download | scintilla-mirror-730950e6a4cfe270bb33304f477148b9131d7fbd.tar.gz | |
Updated documentation comments from Philippe.
Diffstat (limited to 'src')
| -rw-r--r-- | src/ViewStyle.cxx | 4 | ||||
| -rw-r--r-- | src/ViewStyle.h | 20 | ||||
| -rw-r--r-- | src/WindowAccessor.cxx | 6 |
3 files changed, 22 insertions, 8 deletions
diff --git a/src/ViewStyle.cxx b/src/ViewStyle.cxx index c0f672df7..c3d6b5008 100644 --- a/src/ViewStyle.cxx +++ b/src/ViewStyle.cxx @@ -1,5 +1,7 @@ // Scintilla source code edit control -// ViewStyle.cxx - store information on how the document is to be viewed +/** @file ViewStyle.cxx + ** Store information on how the document is to be viewed. + **/ // 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/ViewStyle.h b/src/ViewStyle.h index 96829c8e1..63f2940c4 100644 --- a/src/ViewStyle.h +++ b/src/ViewStyle.h @@ -1,11 +1,15 @@ // Scintilla source code edit control -// ViewStyle.h - store information on how the document is to be viewed +/** @file ViewStyle.h + ** Store information on how the document is to be viewed. + **/ // Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org> // The License.txt file describes the conditions under which this software may be distributed. #ifndef VIEWSTYLE_H #define VIEWSTYLE_H +/** + */ class MarginStyle { public: bool symbol; @@ -15,10 +19,13 @@ public: MarginStyle(); }; +/** + */ class FontNames { private: char *names[STYLE_MAX + 1]; int max; + public: FontNames(); ~FontNames(); @@ -27,6 +34,9 @@ public: }; enum WhiteSpaceVisibility {wsInvisible=0, wsVisibleAlways=1, wsVisibleAfterIndent=2}; + +/** + */ class ViewStyle { public: FontNames fontNames; @@ -45,12 +55,12 @@ public: ColourPair selbackground2; ColourPair selbar; ColourPair selbarlight; - // Margins are ordered: Line Numbers, Selection Margin, Spacing Margin - int leftMarginWidth; // Spacing margin on left of text - int rightMarginWidth; // Spacing margin on left of text + /// Margins are ordered: Line Numbers, Selection Margin, Spacing Margin enum { margins=3 }; + int leftMarginWidth; ///< Spacing margin on left of text + int rightMarginWidth; ///< Spacing margin on left of text bool symbolMargin; - int maskInLine; // Mask for markers to be put into text because there is nowhere for them to go in margin + int maskInLine; ///< Mask for markers to be put into text because there is nowhere for them to go in margin MarginStyle ms[margins]; int fixedColumnWidth; int zoomLevel; diff --git a/src/WindowAccessor.cxx b/src/WindowAccessor.cxx index 8626e44af..db2f938f3 100644 --- a/src/WindowAccessor.cxx +++ b/src/WindowAccessor.cxx @@ -1,5 +1,7 @@ -// SciTE - Scintilla based Text Editor -// Accessor.cxx - rapid easy access to contents of a Scintilla +// Scintilla source code edit control +/** @file WindowAccessor.cxx + ** Rapid easy access to contents of a Scintilla. + **/ // Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org> // The License.txt file describes the conditions under which this software may be distributed. |