removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions

View File

@@ -28,35 +28,26 @@ public:
Main constructor.
@param parent
Parent window.
Parent window.
@param id
Window identifier.
Window identifier.
@param dir
Initial folder.
Initial folder.
@param pos
Position.
Position.
@param size
Size.
Size.
@param style
Window style. Please see wxGenericDirCtrl for a list of possible styles.
Window style. Please see wxGenericDirCtrl for a list of possible styles.
@param filter
A filter string, using the same syntax as that for wxFileDialog. This may be
empty if filters
are not being used.
Example: "All files (*.*)|*.*|JPEG files (*.jpg)|*.jpg"
A filter string, using the same syntax as that for wxFileDialog. This may
be empty if filters
are not being used.
Example: "All files (*.*)|*.*|JPEG files (*.jpg)|*.jpg"
@param defaultFilter
The zero-indexed default filter setting.
The zero-indexed default filter setting.
@param name
The window name.
The window name.
*/
wxGenericDirCtrl();
wxGenericDirCtrl(wxWindow* parent, const wxWindowID id = -1,
@@ -109,7 +100,6 @@ public:
/**
Gets selected filename path only (else empty string).
This function doesn't count a directory as a selection.
*/
wxString GetFilePath();
@@ -177,8 +167,8 @@ public:
/**
@param show
If @true, hidden folders and files will be displayed by the
control. If @false, they will not be displayed.
If @true, hidden folders and files will be displayed by the
control. If @false, they will not be displayed.
*/
void ShowHidden(bool show);
};