First attempt to document raw bitmap access

[wxWidgets.git] / interface / sysopt.h

diff --git a/interface/sysopt.h b/interface/sysopt.h
index 63c9d68d0f984eaacad8866d48ed99f13bb19cfa..1c8286536aad34a06881a661105ebd4f406cde61 100644 (file)
--- a/interface/sysopt.h
+++ b/interface/sysopt.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        sysopt.h
-// Purpose:     documentation for wxSystemOptions class
+// Purpose:     interface of wxSystemOptions
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -20,8 +20,7 @@
     @library{wxbase}
     @category{misc}
 
-    @seealso
-    wxSystemOptions::SetOption, wxSystemOptions::GetOptionInt,
+    @see wxSystemOptions::SetOption, wxSystemOptions::GetOptionInt,
     wxSystemOptions::HasOption
 */
 class wxSystemOptions : public wxObject
@@ -36,29 +35,29 @@ public:
     /**
         Gets an option. The function is case-insensitive to @e name.
         Returns empty string if the option hasn't been set.
-        
+
         @see SetOption(), GetOptionInt(),
              HasOption()
     */
-    wxString GetOption(const wxString& name);
+    wxString GetOption(const wxString& name) const;
 
     /**
         Gets an option as an integer. The function is case-insensitive to @e name.
         If the option hasn't been set, this function returns 0.
-        
+
         @see SetOption(), GetOption(),
              HasOption()
     */
-    int GetOptionInt(const wxString& name);
+    int GetOptionInt(const wxString& name) const;
 
     /**
         Returns @true if the given option is present. The function is
         case-insensitive to @e name.
-        
+
         @see SetOption(), GetOption(),
              GetOptionInt()
     */
-    bool HasOption(const wxString& name);
+    bool HasOption(const wxString& name) const;
 
     /**
         Returns @true if the option with the given @a name had been set to 0
@@ -66,7 +65,7 @@ public:
         @c GetOptionInt(name) == 0 as this would also be @true if the option
         hadn't been set at all.
     */
-    bool IsFalse(const wxString& name);
+    bool IsFalse(const wxString& name) const;
 
     //@{
     /**
@@ -76,3 +75,4 @@ public:
     void SetOption(const wxString& name, int value);
     //@}
 };
+