Changeset 8226 in orxonox.OLD for branches/gui/src/lib/util/directory.h

Timestamp:

Jun 8, 2006, 10:49:15 AM (19 years ago)

Author:

bensch

Message:

gui: doxy-tags

File:

• branches/gui/src/lib/util/directory.h (modified) (1 diff)

branches/gui/src/lib/util/directory.h

@@ -40 +40 @@
   bool create();
 
+  /** @returns if the Directory was opened */
+  bool isOpen() const { return this->_opened; }
+  /** @returns the FileCount (count of files contained in this directory) */
+  unsigned int fileCount() const { return _fileNames.size(); };
   /** @returns the FileNames contained inside of the Directory */
   const std::vector<std::string>& fileNames() const { return this->_fileNames; };
+  /** @returns the i'th FileName @param fileNumber the fileNumber (must not bigger than fileCount()) */
   const std::string& operator[](unsigned int fileNumber) const { return this->_fileNames[fileNumber]; };
-  unsigned int fileCount() const { return _fileNames.size(); };
-
+  /** @returns a formated string containing the FileName, prepended with the directory-Name */
   std::string fileNameInDir(unsigned int fileNumber) const { return this->name() + "/" + _fileNames[fileNumber]; };
-
+  /** @returns a File pointing to the File @param fileNumber the fileNumber (must not bigger than fileCount()) */
   File getFile(unsigned int fileNumber) const { return File(fileNameInDir(fileNumber)); };
 
 private:
-  bool                        _opened;
-  std::vector<std::string>    _fileNames;
+  bool                        _opened;          //!< If the directory was opened.
+  std::vector<std::string>    _fileNames;       //!< The List of Files contained in the directory. (will be filled when open was called.)
 };