X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/328f5751e8a06727b137189fe04891a9f43bfc8b..ce323d38d3623d0f96a633d5e22e221fc384f566:/interface/dir.h diff --git a/interface/dir.h b/interface/dir.h index dd7ba41d20..cb9ca73917 100644 --- a/interface/dir.h +++ b/interface/dir.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dir.h -// Purpose: documentation for wxDirTraverser class +// Purpose: interface of wxDirTraverser // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -51,7 +51,7 @@ class wxDirTraverser { public: /** - This function is called for each directory. It may return @c wxSIR_STOP + This function is called for each directory. It may return @c wxDIR_STOP to abort traversing completely, @c wxDIR_IGNORE to skip this directory but continue with others or @c wxDIR_CONTINUE to enumerate all files and subdirectories in this directory. @@ -69,7 +69,7 @@ public: /** This function is called for each directory which we failed to open for - enumerating. It may return @c wxSIR_STOP to abort traversing completely, + enumerating. It may return @c wxDIR_STOP to abort traversing completely, @c wxDIR_IGNORE to skip this directory but continue with others or @c wxDIR_CONTINUE to retry opening this directory once again. The base class version always returns @c wxDIR_IGNORE. @@ -78,6 +78,7 @@ public: }; + /** @class wxDir @wxheader{dir.h} @@ -203,7 +204,7 @@ public: big, it could be far from real size of the directory. See also: wxFileName::GetHumanReadableSize, - wxGetDiskSpace + wxGetDiskSpace() */ static wxULongLong GetTotalSize(const wxString& dir, wxArrayString* filesSkipped = NULL); @@ -253,3 +254,4 @@ public: const wxString& filespec = wxEmptyString, int flags = wxDIR_DEFAULT); }; +