]> git.saurik.com Git - wxWidgets.git/commitdiff
minor additions and clarifications
authorFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Mon, 19 Apr 2010 18:54:26 +0000 (18:54 +0000)
committerFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Mon, 19 Apr 2010 18:54:26 +0000 (18:54 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64053 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/dir.h
interface/wx/volume.h

index 2a435bf818c3ed2a69339b7612f482226e598bb6..1b9ba583135fc1b0f51042109ec4ed835b8ed568 100644 (file)
@@ -104,6 +104,8 @@ enum wxDirFlags
     wxDIR_HIDDEN    = 0x0004,   ///< Includes hidden files.
     wxDIR_DOTDOT    = 0x0008,   ///< Includes "." and "..".
 
+    //! Combination of the @c wxDIR_FILES, @c wxDIR_DIRS, @c wxDIR_HIDDEN flags
+    //! defined above.
     wxDIR_DEFAULT   = wxDIR_FILES | wxDIR_DIRS | wxDIR_HIDDEN
 };
 
@@ -195,6 +197,10 @@ public:
         would be unchanged and should include ::wxDIR_DIRS flag to recurse into
         subdirectories (both flags are included in the value by default).
         See ::wxDirFlags for the list of the possible flags.
+        
+        @return Returns the total number of files found while traversing
+                the directory @a dirname (i.e. the number of entries appended
+                to the @a files array).
 
         @see Traverse()
     */
@@ -277,7 +283,7 @@ public:
         given.
         See ::wxDirFlags for the list of the possible flags.
 
-        For each found directory, @ref wxDirTraverser::OnDir() "sink.OnDir()"
+        For each directory found, @ref wxDirTraverser::OnDir() "sink.OnDir()"
         is called and @ref wxDirTraverser::OnFile() "sink.OnFile()" is called
         for every file. Depending on the return value, the enumeration may
         continue or stop.
index 13e140eaf920914a6166ff631e96f91e3a2e4f02..47ce02394d1bfe1d7f491730fd5f20aabfa7260d 100644 (file)
@@ -70,13 +70,13 @@ public:
     /**
         Default ctor. Use Create() later.
     */
-    wxFSVolumeBase();
+    wxFSVolume();
 
     /**
         Create the volume object with the given @a name (which should be one of
         those returned by GetVolumes()).
     */
-    wxFSVolumeBase(const wxString& name);
+    wxFSVolume(const wxString& name);
 
     /**
         Create the volume object with the given @a name (which should be one of
@@ -90,6 +90,7 @@ public:
         Only the volumes with @e flags such that the expression
         @code (flags & flagsSet) == flagsSet && !(flags & flagsUnset) @endcode
         is @true, are returned. By default, all mounted ones are returned.
+        See ::wxFSVolumeFlags enumeration values for a list of valid flags.
 
         This operation may take a while and, even if this function is
         synchronous, it can be stopped using CancelSearch().
@@ -114,7 +115,7 @@ public:
     wxFSVolumeKind GetKind() const;
 
     /**
-        Returns the flags of this volume. See wxFSVolumeFlags.
+        Returns the flags of this volume. See ::wxFSVolumeFlags enumeration values.
     */
     int GetFlags() const;