aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authornyamatongwe <unknown>2001-02-24 01:07:27 +0000
committernyamatongwe <unknown>2001-02-24 01:07:27 +0000
commit730950e6a4cfe270bb33304f477148b9131d7fbd (patch)
tree00849b12465c25919527022c1f03bd3da43da178
parent6da7f1fa2aee410a97deef5dd497d8bf0952ad03 (diff)
downloadscintilla-mirror-730950e6a4cfe270bb33304f477148b9131d7fbd.tar.gz
Updated documentation comments from Philippe.
-rw-r--r--src/ViewStyle.cxx4
-rw-r--r--src/ViewStyle.h20
-rw-r--r--src/WindowAccessor.cxx6
-rw-r--r--win32/PlatWin.cxx20
4 files changed, 35 insertions, 15 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.
diff --git a/win32/PlatWin.cxx b/win32/PlatWin.cxx
index f15fb4be8..e20e2be55 100644
--- a/win32/PlatWin.cxx
+++ b/win32/PlatWin.cxx
@@ -1,5 +1,7 @@
// Scintilla source code edit control
-// PlatWin.cxx - implementation of platform facilities on Windows
+/** @file PlatWin.cxx
+ ** Implementation of platform facilities on Windows.
+ **/
// Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org>
// The License.txt file describes the conditions under which this software may be distributed.
@@ -67,9 +69,11 @@ void Palette::Release() {
hpal = 0;
}
-// This method either adds a colour to the list of wanted colours (want==true)
-// or retrieves the allocated colour back to the ColourPair.
-// This is one method to make it easier to keep the code for wanting and retrieving in sync.
+/**
+ * This method either adds a colour to the list of wanted colours (want==true)
+ * or retrieves the allocated colour back to the ColourPair.
+ * This is one method to make it easier to keep the code for wanting and retrieving in sync.
+ */
void Palette::WantFind(ColourPair &cp, bool want) {
if (want) {
for (int i=0; i < used; i++) {
@@ -131,9 +135,11 @@ void SetLogFont(LOGFONT &lf, const char *faceName, int characterSet, int size, b
strcpy(lf.lfFaceName, faceName);
}
-// Create a hash from the parameters for a font to allow easy checking for identity.
-// If one font is the same as another, its hash will be the same, but if the hash is the
-// same then they may still be different.
+/**
+ * Create a hash from the parameters for a font to allow easy checking for identity.
+ * If one font is the same as another, its hash will be the same, but if the hash is the
+ * same then they may still be different.
+ */
int HashFont(const char *faceName, int characterSet, int size, bool bold, bool italic) {
return
size ^