From 3d4ce29bd914b345e8b8675f0ed526cc4d8f5033 Mon Sep 17 00:00:00 2001
From: Manolo Gouy <Manolo>
Date: Tue, 12 Apr 2016 07:07:21 +0000
Subject: Add and correct a few Doxygen comments.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11586 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 src/Fl.cxx                                     | 2 ++
 src/drivers/Cocoa/Fl_Cocoa_Screen_Driver.cxx   | 5 ++---
 src/drivers/Darwin/Fl_Darwin_System_Driver.cxx | 4 ++--
 src/drivers/WinAPI/Fl_WinAPI_Screen_Driver.cxx | 5 ++---
 src/drivers/WinAPI/Fl_WinAPI_System_Driver.cxx | 4 ++--
 src/drivers/X11/Fl_X11_Screen_Driver.cxx       | 3 +--
 src/drivers/X11/Fl_X11_System_Driver.cxx       | 2 +-
 7 files changed, 12 insertions(+), 13 deletions(-)

(limited to 'src')

diff --git a/src/Fl.cxx b/src/Fl.cxx
index 316e584dd..bdd68d9f9 100644
--- a/src/Fl.cxx
+++ b/src/Fl.cxx
@@ -175,12 +175,14 @@ char const * const Fl::clipboard_image = "image";
 // Drivers
 //
 
+/** Returns a pointer to the unique Fl_Screen_Driver object of the platform */
 Fl_Screen_Driver *Fl::screen_driver()
 {
   static  Fl_Screen_Driver* screen_driver_ = Fl_Screen_Driver::newScreenDriver();
   return screen_driver_;
 }
 
+/** Returns a pointer to the unique Fl_System_Driver object of the platform */
 Fl_System_Driver *Fl::system_driver()
 {
   static  Fl_System_Driver* system_driver_ = Fl_System_Driver::newSystemDriver();
diff --git a/src/drivers/Cocoa/Fl_Cocoa_Screen_Driver.cxx b/src/drivers/Cocoa/Fl_Cocoa_Screen_Driver.cxx
index 786bbde12..6f0ebfa64 100644
--- a/src/drivers/Cocoa/Fl_Cocoa_Screen_Driver.cxx
+++ b/src/drivers/Cocoa/Fl_Cocoa_Screen_Driver.cxx
@@ -35,11 +35,10 @@ extern int fl_ready();
 
 int Fl_Cocoa_Screen_Driver::next_marked_length = 0;
 
-/**
+/*
  Creates a driver that manages all screen and display related calls.
  
- This function must be implemented once for every platform. It is called
- when the static members of the class "Fl" are created.
+ This function must be implemented once for every platform.
  */
 Fl_Screen_Driver *Fl_Screen_Driver::newScreenDriver()
 {
diff --git a/src/drivers/Darwin/Fl_Darwin_System_Driver.cxx b/src/drivers/Darwin/Fl_Darwin_System_Driver.cxx
index 806157103..ccd948cf3 100644
--- a/src/drivers/Darwin/Fl_Darwin_System_Driver.cxx
+++ b/src/drivers/Darwin/Fl_Darwin_System_Driver.cxx
@@ -51,8 +51,8 @@ const char* fl_local_meta  = "⌘\\"; // U+2318 (place of interest sign)
 const char* fl_local_shift = "⇧\\"; // U+21E7 (upwards white arrow)
 
 
-/**
- Creates a driver that manages all screen and display related calls.
+/*
+ Creates a driver that manages all system related calls.
  
  This function must be implemented once for every platform.
  */
diff --git a/src/drivers/WinAPI/Fl_WinAPI_Screen_Driver.cxx b/src/drivers/WinAPI/Fl_WinAPI_Screen_Driver.cxx
index bf49eebd8..86aa78a32 100644
--- a/src/drivers/WinAPI/Fl_WinAPI_Screen_Driver.cxx
+++ b/src/drivers/WinAPI/Fl_WinAPI_Screen_Driver.cxx
@@ -44,11 +44,10 @@ extern const char *fl_bg2;
 #endif // !HMONITOR_DECLARED && _WIN32_WINNT < 0x0500
 
 
-/**
+/*
  Creates a driver that manages all screen and display related calls.
 
- This function must be implemented once for every platform. It is called
- when the static members of the class "Fl" are created.
+ This function must be implemented once for every platform.
  */
 Fl_Screen_Driver *Fl_Screen_Driver::newScreenDriver()
 {
diff --git a/src/drivers/WinAPI/Fl_WinAPI_System_Driver.cxx b/src/drivers/WinAPI/Fl_WinAPI_System_Driver.cxx
index a1c1bb74e..fcac9cb6b 100644
--- a/src/drivers/WinAPI/Fl_WinAPI_System_Driver.cxx
+++ b/src/drivers/WinAPI/Fl_WinAPI_System_Driver.cxx
@@ -69,8 +69,8 @@ extern "C" {
                  int (*compar)(struct dirent **, struct dirent **));
 }
 
-/**
- Creates a driver that manages all screen and display related calls.
+/*
+ Creates a driver that manages all system related calls.
  
  This function must be implemented once for every platform.
  */
diff --git a/src/drivers/X11/Fl_X11_Screen_Driver.cxx b/src/drivers/X11/Fl_X11_Screen_Driver.cxx
index 9e7c68af4..7dccf0052 100644
--- a/src/drivers/X11/Fl_X11_Screen_Driver.cxx
+++ b/src/drivers/X11/Fl_X11_Screen_Driver.cxx
@@ -110,8 +110,7 @@ static double missed_timeout_by;
 /**
  Creates a driver that manages all screen and display related calls.
  
- This function must be implemented once for every platform. It is called
- when the static members of the class "Fl" are created.
+ This function must be implemented once for every platform.
  */
 Fl_Screen_Driver *Fl_Screen_Driver::newScreenDriver()
 {
diff --git a/src/drivers/X11/Fl_X11_System_Driver.cxx b/src/drivers/X11/Fl_X11_System_Driver.cxx
index 08f3f1e14..fb923f22f 100644
--- a/src/drivers/X11/Fl_X11_System_Driver.cxx
+++ b/src/drivers/X11/Fl_X11_System_Driver.cxx
@@ -66,7 +66,7 @@ const char* fl_local_meta  = "Meta";
 const char* fl_local_shift = "Shift";
 
 /**
- Creates a driver that manages all screen and display related calls.
+ Creates a driver that manages all system related calls.
  
  This function must be implemented once for every platform.
  */
-- 
cgit v1.2.3