Get rid of the old path finding methods in util.cpp

[quassel.git] / src / common / quassel.h

diff --git a/src/common/quassel.h b/src/common/quassel.h
index cb29f3f..9492ec6 100644 (file)
--- a/src/common/quassel.h
+++ b/src/common/quassel.h
@@ -64,7 +64,21 @@ public:
   static inline RunMode runMode();
 
   static QString configDirPath();
+
+  //! Returns a list of data directory paths
+  /** There are several locations for applications to install their data files in. On Unix,
+  *  a common location is /usr/share; others include $PREFIX/share and additional directories
+  *  specified in the env variable XDG_DATA_DIRS.
+  *  \return A list of directory paths to look for data files in
+  */
   static QStringList dataDirPaths();
+
+  //! Searches for a data file in the possible data directories
+  /** Data files can reside in $DATA_DIR/apps/quassel, where $DATA_DIR is one of the directories
+  *  returned by \sa dataDirPaths().
+  *  \Note With KDE integration enabled, files are searched (only) in KDE's appdata dirs.
+  *  \return The full path to the data file if found; a null QString else
+  */
   static QString findDataFilePath(const QString &filename);
 
   static inline void setCliParser(AbstractCliParser *cliParser);