More interface header reviews by Azriel Fasten, and added skeleton docs for wxBookCtr...

[wxWidgets.git] / interface / aboutdlg.h

diff --git a/interface/aboutdlg.h b/interface/aboutdlg.h
index 680f112cc5bff871ead2aee7bdb5a9fb4c503342..1688a5a45caa8ba400bf967356d074623578296c 100644 (file)
--- a/interface/aboutdlg.h
+++ b/interface/aboutdlg.h
@@ -47,21 +47,21 @@ 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);
@@ -72,14 +72,14 @@ public:
         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);
@@ -99,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);
@@ -171,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
@@ -187,15 +190,17 @@ 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);
 
@@ -207,10 +212,13 @@ void wxAboutBox(const wxAboutDialogInfo& info);
     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);
 
+//@}