First attempt to document raw bitmap access

[wxWidgets.git] / interface / fontdlg.h

diff --git a/interface/fontdlg.h b/interface/fontdlg.h
index 76ba6f6a26faab52f5f1398cd56b628703049ce5..4a5ea24021eecf3065ae67b417724ab51cd6a0ef 100644 (file)
--- a/interface/fontdlg.h
+++ b/interface/fontdlg.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        fontdlg.h
-// Purpose:     documentation for wxFontDialog class
+// Purpose:     interface of wxFontDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,29 +9,28 @@
 /**
     @class wxFontDialog
     @wxheader{fontdlg.h}
-    
+
     This class represents the font chooser dialog.
-    
+
     @library{wxcore}
     @category{cmndlg}
-    
-    @seealso
-    Overview, wxFontData, wxGetFontFromUser
+
+    @see Overview(), wxFontData, wxGetFontFromUser()
 */
 class wxFontDialog : public wxDialog
 {
 public:
     //@{
     /**
-        Constructor. Pass a parent window, and optionally the 
+        Constructor. Pass a parent window, and optionally the
         @ref overview_wxfontdata "font data" object to be used to initialize the dialog
-        controls. If the default constructor is used, 
+        controls. If the default constructor is used,
         Create() must be called before the dialog can be
         shown.
     */
     wxFontDialog();
-        wxFontDialog(wxWindow* parent);
-        wxFontDialog(wxWindow* parent, const wxFontData& data);
+    wxFontDialog(wxWindow* parent);
+    wxFontDialog(wxWindow* parent, const wxFontData& data);
     //@}
 
     //@{
@@ -41,7 +40,7 @@ public:
         occurred.
     */
     bool Create(wxWindow* parent);
-        bool Create(wxWindow* parent, const wxFontData& data);
+    bool Create(wxWindow* parent, const wxFontData& data);
     //@}
 
     //@{
@@ -50,13 +49,12 @@ public:
         dialog.
     */
     const wxFontData GetFontData();
-        wxFontData GetFontData();
+    const wxFontData&  GetFontData();
     //@}
 
     /**
-        Shows the dialog, returning @c wxID_OK if the user pressed Ok, and 
+        Shows the dialog, returning @c wxID_OK if the user pressed Ok, and
         @c wxID_CANCEL otherwise.
-        
         If the user cancels the dialog (ShowModal returns @c wxID_CANCEL), no font
         will be created. If the user presses OK, a new wxFont will be created and
         stored in the font dialog's wxFontData structure.
@@ -65,25 +63,31 @@ public:
 };
 
 
+
 // ============================================================================
 // Global functions/macros
 // ============================================================================
 
+/** @ingroup group_funcmacro_dialog */
+//@{
+
 /**
     Shows the font selection dialog and returns the font selected by user or
-    invalid font (use @ref wxFont::isok wxFont:IsOk to test whether a font
-    is valid) if the dialog was cancelled.
-    
-    @param parent 
-    The parent window for the font selection dialog
-    
-    @param fontInit 
-    If given, this will be the font initially selected in the dialog.
-    
-    @param caption 
-    If given, this will be used for the dialog caption.
+    invalid font (use wxFont::IsOk() to test whether a font is valid) if the
+    dialog was cancelled.
+
+    @param parent
+        The parent window for the font selection dialog.
+    @param fontInit
+        If given, this will be the font initially selected in the dialog.
+    @param caption
+        If given, this will be used for the dialog caption.
+
+    @header{wx/fontdlg.h}
 */
-wxFont wxGetFontFromUser(wxWindow * parent,
+wxFont wxGetFontFromUser(wxWindow* parent,
                          const wxFont& fontInit,
                          const wxString& caption = wxEmptyString);
 
+//@}
+