add @onlyfor tags to remove further ifacecheck warnings

[wxWidgets.git] / interface / dirdlg.h

diff --git a/interface/dirdlg.h b/interface/dirdlg.h
index 58050c57a2639a13178c7884ef42713da942226a..cb7b4eba1cb1e65c52483604d81a8e44d9520252 100644 (file)
--- a/interface/dirdlg.h
+++ b/interface/dirdlg.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dirdlg.h
-// Purpose:     documentation for wxDirDialog class
+// Purpose:     interface of wxDirDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -29,8 +29,7 @@
     @library{wxcore}
     @category{cmndlg}
 
-    @seealso
-    @ref overview_wxdirdialogoverview "wxDirDialog overview", wxFileDialog
+    @see @ref overview_wxdirdialogoverview "wxDirDialog overview", wxFileDialog
 */
 class wxDirDialog : public wxDialog
 {
@@ -38,27 +37,21 @@ public:
     /**
         Constructor. Use ShowModal() to show
         the dialog.
-        
+
         @param parent
-        Parent window.
-        
+            Parent window.
         @param message
-        Message to show on the dialog.
-        
+            Message to show on the dialog.
         @param defaultPath
-        The default path, or the empty string.
-        
+            The default path, or the empty string.
         @param style
-        The dialog style. See wxDirDialog
-        
+            The dialog style. See wxDirDialog
         @param pos
-        Dialog position. Ignored under Windows.
-        
+            Dialog position. Ignored under Windows.
         @param size
-        Dialog size. Ignored under Windows.
-        
+            Dialog size. Ignored under Windows.
         @param name
-        The dialog name, not used.
+            The dialog name, not used.
     */
     wxDirDialog(wxWindow* parent,
                 const wxString& message = "Choose a directory",
@@ -76,12 +69,12 @@ public:
     /**
         Returns the message that will be displayed on the dialog.
     */
-    wxString GetMessage();
+    wxString GetMessage() const;
 
     /**
         Returns the default or user-selected path.
     */
-    wxString GetPath();
+    wxString GetPath() const;
 
     /**
         Sets the message that will be displayed on the dialog.
@@ -101,28 +94,37 @@ public:
 };
 
 
+
 // ============================================================================
 // Global functions/macros
 // ============================================================================
 
+/** @ingroup group_funcmacro_dialog */
+//@{
+
 /**
-    Pops up a directory selector dialog. The arguments have the same meaning as
-    those of wxDirDialog::wxDirDialog(). The message is displayed at the top,
-    and the default_path, if specified, is set as the initial selection.
+    Pops up a directory selector dialog. The arguments have the same meaning
+    as those of wxDirDialog::wxDirDialog(). The message is displayed at the
+    top, and the default_path, if specified, is set as the initial selection.
 
     The application must check for an empty return value (if the user pressed
     Cancel). For example:
+
     @code
     const wxString& dir = wxDirSelector("Choose a folder");
     if ( !dir.empty() )
     {
-      ...
+        ...
     }
     @endcode
+
+    @header{wx/dirdlg.h}
 */
 wxString wxDirSelector(const wxString& message = wxDirSelectorPromptStr,
                        const wxString& default_path = "",
                        long style = 0,
                        const wxPoint& pos = wxDefaultPosition,
-                       wxWindow * parent = @NULL);
+                       wxWindow* parent = NULL);
+
+//@}