Updated documentation comments from Philippe.

1 files changed, 40 insertions, 28 deletions

diff --git a/include/Platform.h b/include/Platform.h
index 255423bb5..d2221de64 100644
--- a/include/Platform.h
+++ b/include/Platform.h
@@ -1,10 +1,10 @@
 // Scintilla source code edit control
-// Platform.h - interface to platform facilities
-// Also includes some basic utilities
-// Implemented in PlatGTK.cxx for GTK+/Linux, PlatWin.cxx for Windows, and PlatWX.cxx for wxWindows
+/** @file Platform.h
+ ** Interface to platform facilities. Also includes some basic utilities.
+ ** Implemented in PlatGTK.cxx for GTK+/Linux, PlatWin.cxx for Windows, and PlatWX.cxx for wxWindows.
+ **/
 // Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org>
 // The License.txt file describes the conditions under which this software may be distributed.
-/** @file **/
 
 #ifndef PLATFORM_H
 #define PLATFORM_H
@@ -84,9 +84,10 @@ typedef wxWindow* WindowID;
 typedef wxMenu* MenuID;
 #endif
 
-/** A geometric point class.
+/**
+ * A geometric point class.
  * Point is exactly the same as the Win32 POINT and GTK+ GdkPoint so can be used interchangeably.
- **/
+ */
 class Point {
 public:
 	int x;
@@ -100,10 +101,11 @@ public:
 	static Point FromLong(long lpoint);
 };
 
-/** A geometric rectangle class.
+/**
+ * A geometric rectangle class.
  * PRectangle is exactly the same as the Win32 RECT so can be used interchangeably.
  * PRectangles contain their top and left sides, but not their right and bottom sides.
- **/
+ */
 class PRectangle {
 public:
 	int left;
@@ -138,8 +140,9 @@ wxRect wxRectFromPRectangle(PRectangle prc);
 PRectangle PRectangleFromwxRect(wxRect rc);
 #endif
 
-/** A colour class.
- **/
+/**
+ * A colour class.
+ */
 class Colour {
 	ColourID co;
 public:
@@ -155,11 +158,12 @@ public:
 	friend class Palette;
 };
 
-/** Colour pairs hold a desired colour and the colour that the graphics engine
+/**
+ * Colour pairs hold a desired colour and the colour that the graphics engine
  * allocates to approximate the desired colour.
  * To make palette management more automatic, ColourPairs could register at
  * construction time with a palette management object.
- **/
+ */
 struct ColourPair {
 	Colour desired;
 	Colour allocated;
@@ -172,8 +176,9 @@ struct ColourPair {
 
 class Window;	// Forward declaration for Palette
 
-/** Colour palette management.
- **/
+/**
+ * Colour palette management.
+ */
 class Palette {
 	int used;
 	enum {numEntries = 100};
@@ -194,10 +199,11 @@ public:
 
 	void Release();
 	
-	/** This method either adds a colour to the list of wanted colours (want==true)
+	/**
+	 * 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 WantFind(ColourPair &cp, bool want);
 
 	void Allocate(Window &w);
@@ -205,8 +211,9 @@ public:
 	friend class Surface;
 };
 
-/** Font management.
- **/
+/**
+ * Font management.
+ */
 class Font {
 protected:
 	FontID id;
@@ -229,8 +236,9 @@ public:
 	friend class Surface;
 };
 
-/** A surface abstracts a place to draw.
- **/
+/**
+ * A surface abstracts a place to draw.
+ */
 class Surface {
 private:
 	bool unicodeMode;
@@ -313,9 +321,10 @@ public:
 	}
 };
 
-/** Class to hide the details of window manipulation.
+/**
+ * Class to hide the details of window manipulation.
  * Does not own the window which will normally have a longer life than this object.
- **/
+ */
 class Window {
 	friend class ListBox;
 protected:
@@ -350,8 +359,9 @@ public:
 #endif
 };
 
-/** Listbox management.
- **/
+/**
+ * Listbox management.
+ */
 class ListBox : public Window {
 #if PLAT_GTK
 	WindowID list;
@@ -379,8 +389,9 @@ public:
 	void Sort();
 };
 
-/** Menu management.
- **/
+/**
+ * Menu management.
+ */
 class Menu {
 	MenuID id;
 public:
@@ -391,9 +402,10 @@ public:
 	void Show(Point pt, Window &w);
 };
 
-/** Platform class used to retrieve system wide parameters such as double click speed
+/**
+ * Platform class used to retrieve system wide parameters such as double click speed
  * and chrome colour. Not a creatable object, more of a module with several functions.
- **/
+ */
 class Platform {
 	// Private so Platform objects can not be copied
 	Platform(const Platform &) {}