Mention wxGCDC

[wxWidgets.git] / interface / aboutdlg.h

diff --git a/interface/aboutdlg.h b/interface/aboutdlg.h
index 75b2c01e810a0d3c11b0994976890be2ab4ff063..1688a5a45caa8ba400bf967356d074623578296c 100644 (file)
--- a/interface/aboutdlg.h
+++ b/interface/aboutdlg.h
@@ -11,7 +11,7 @@
     @wxheader{aboutdlg.h}
 
     wxAboutDialogInfo contains information shown in the standard @e About
-    dialog displayed by the wxAboutBox function.
+    dialog displayed by the wxAboutBox() function.
 
     This class contains the general information about the program, such as its
     name, version, copyright and so on, as well as lists of the program developers,
@@ -28,15 +28,13 @@
     wxAboutDialogInfo has any fields not supported by the native version. Currently
     GTK+ version supports all the possible fields natively but MSW and Mac versions
     don't support URLs, licence text nor custom icons in the about dialog and if
-    either of those is used, wxAboutBox will automatically
-    use the generic version so you should avoid specifying these fields to achieve
-    more native look and feel.
+    either of those is used, wxAboutBox() will automatically use the generic version
+    so you should avoid specifying these fields to achieve more native look and feel.
 
     @library{wxadv}
-    @category{FIXME}
+    @category{misc}
 
-    @seealso
-    wxAboutDialogInfo::SetArtists
+    @see wxAboutDialogInfo::SetArtists
 */
 class wxAboutDialogInfo
 {
@@ -49,39 +47,39 @@ public:
 
     /**
         Adds an artist name to be shown in the program credits.
-        
+
         @see SetArtists()
     */
     void AddArtist(const wxString& artist);
 
     /**
         Adds a developer name to be shown in the program credits.
-        
+
         @see SetDevelopers()
     */
     void AddDeveloper(const wxString& developer);
 
     /**
         Adds a documentation writer name to be shown in the program credits.
-        
+
         @see SetDocWriters()
     */
     void AddDocWriter(const wxString& docwriter);
 
     /**
         Adds a translator name to be shown in the program credits. Notice that if no
-        translator names are specified explicitely, wxAboutBox will try to use the
+        translator names are specified explicitely, wxAboutBox() will try to use the
         translation of the string @c translator-credits from the currently used message
         catalog -- this can be used to show just the name of the translator of the
         program in the current language.
-        
+
         @see SetTranslators()
     */
     void AddTranslator(const wxString& translator);
 
     /**
         Sets the the list of artists to be shown in the program credits.
-        
+
         @see AddArtist()
     */
     void SetArtists(const wxArrayString& artists);
@@ -101,14 +99,14 @@ public:
 
     /**
         Set the list of developers of the program.
-        
+
         @see AddDeveloper()
     */
     void SetDevelopers(const wxArrayString& developers);
 
     /**
         Set the list of documentation writers.
-        
+
         @see AddDocWriter()
     */
     void SetDocWriters(const wxArrayString& docwriters);
@@ -173,6 +171,9 @@ public:
 // Global functions/macros
 // ============================================================================
 
+/** @ingroup group_funcmacro_dialog */
+//@{
+
 /**
     This function shows the standard about dialog containing the information
     specified in @a info. If the current platform has a native about dialog
@@ -189,30 +190,35 @@ public:
         info.SetName(_("My Program"));
         info.SetVersion(_("1.2.3 Beta"));
         info.SetDescription(_("This program does something great."));
-        info.SetCopyright(_T("(C) 2007 Me my@email.addre.ss"));
+        info.SetCopyright(_T("(C) 2007 Me <my@email.addre.ss>"));
 
         wxAboutBox(info);
     }
     @endcode
 
-    Please see the @ref page_utils_samples_dialogs for more examples of
-    using this function and wxAboutDialogInfo for the description of the
-    information which can be shown in the about dialog.
+    Please see the @ref page_samples_dialogs for more examples of using this
+    function and wxAboutDialogInfo for the description of the information which
+    can be shown in the about dialog.
+
+    @header{wx/aboutdlg.h}
 */
 void wxAboutBox(const wxAboutDialogInfo& info);
 
 /**
-    This function does the same thing as wxAboutBox except that it always uses
+    This function does the same thing as wxAboutBox() except that it always uses
     the generic wxWidgets version of the dialog instead of the native one.
 
     This is mainly useful if you need to customize the dialog by e.g. adding
     custom controls to it (customizing the native dialog is not currently
     supported).
 
-    See the @ref page_utils_samples_dialogs for an example of about dialog
+    See the @ref page_samples_dialogs for an example of about dialog
     customization.
 
     @see wxAboutDialogInfo
+
+    @header{wx/aboutdlg.h}
 */
 void wxGenericAboutBox(const wxAboutDialogInfo& info);
 
+//@}