Added the function and macro group pages for Doxygen.

[wxWidgets.git] / interface / font.h

diff --git a/interface/font.h b/interface/font.h
index b2dd00387ae13d539ed96068a03a66b34a66b2bc..b76182cefec0e48ea6f2a3c3ddc16661026cce5d 100644 (file)
--- a/interface/font.h
+++ b/interface/font.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        font.h
-// Purpose:     documentation for wxFont class
+// Purpose:     interface of wxFont
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -8,6 +8,7 @@
 
 /**
     @class wxFont
+    @ingroup group_class_gdi
     @wxheader{font.h}
 
     A font is an object which determines the appearance of text. Fonts are
@@ -29,19 +30,10 @@
     @category{gdi}
 
     @stdobjects
-    Objects:
-    wxNullFont
-    Pointers:
-    wxNORMAL_FONT
+    ::Objects:, ::wxNullFont, ::Pointers:, ::wxNORMAL_FONT, ::wxSMALL_FONT,
+    ::wxITALIC_FONT, ::wxSWISS_FONT,
 
-    wxSMALL_FONT
-
-    wxITALIC_FONT
-
-    wxSWISS_FONT
-
-    @seealso
-    @ref overview_wxfontoverview, wxDC::SetFont, wxDC::DrawText,
+    @see @ref overview_wxfontoverview, wxDC::SetFont, wxDC::DrawText,
     wxDC::GetTextExtent, wxFontDialog, wxSystemSettings
 */
 class wxFont : public wxGDIObject
@@ -303,7 +295,7 @@ public:
         
         @see SetFaceName()
     */
-    wxString GetFaceName();
+    wxString GetFaceName() const;
 
     /**
         Gets the font family. See SetFamily() for a list of valid
@@ -311,7 +303,7 @@ public:
         
         @see SetFamily()
     */
-    wxFontFamily GetFamily();
+    wxFontFamily GetFamily() const;
 
     /**
         Returns the platform-dependent string completely describing this font.
@@ -322,7 +314,7 @@ public:
         
         @see SetNativeFontInfo(),GetNativeFontInfoUserDesc()
     */
-    wxString GetNativeFontInfoDesc();
+    wxString GetNativeFontInfoDesc() const;
 
     /**
         Returns a user-friendly string for this font object. Returned string is always
@@ -339,7 +331,7 @@ public:
         
         @see SetPointSize()
     */
-    int GetPointSize();
+    int GetPointSize() const;
 
     /**
         Gets the font style. See wxFont() for a list of valid
@@ -347,14 +339,14 @@ public:
         
         @see SetStyle()
     */
-    int GetStyle();
+    int GetStyle() const;
 
     /**
         Returns @true if the font is underlined, @false otherwise.
         
         @see SetUnderlined()
     */
-    bool GetUnderlined();
+    bool GetUnderlined() const;
 
     /**
         Gets the font weight. See wxFont() for a list of valid
@@ -362,18 +354,18 @@ public:
         
         @see SetWeight()
     */
-    wxFontWeight GetWeight();
+    wxFontWeight GetWeight() const;
 
     /**
         Returns @true if the font is a fixed width (or monospaced) font,
         @false if it is a proportional one or font is invalid.
     */
-    bool IsFixedWidth();
+    bool IsFixedWidth() const;
 
     /**
         Returns @true if this object is a valid font, @false otherwise.
     */
-    bool IsOk();
+    bool IsOk() const;
 
     //@{
     /**
@@ -658,3 +650,43 @@ public:
     */
     bool operator ==(const wxFont& font);
 };
+
+
+/**
+    FIXME
+*/
+wxFont Objects:
+;
+
+/**
+    FIXME
+*/
+wxFont wxNullFont;
+
+/**
+    FIXME
+*/
+wxFont Pointers:
+;
+
+/**
+    FIXME
+*/
+wxFont wxNORMAL_FONT;
+
+/**
+    FIXME
+*/
+wxFont wxSMALL_FONT;
+
+/**
+    FIXME
+*/
+wxFont wxITALIC_FONT;
+
+/**
+    FIXME
+*/
+wxFont wxSWISS_FONT;
+
+