X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fquassel.h;h=9492ec6b5892f4b8b6848f33af6a627669b688e8;hp=cb29f3f1f0cb98ec3ebce8ff87bfa7d92ac661d5;hb=cd37744f0a2cd8ffe027892ddce5c7d6f4848ab0;hpb=176fd53453c51debbb963dee303e8853577aaac4

diff --git a/src/common/quassel.h b/src/common/quassel.h
index cb29f3f1..9492ec6b 100644
--- 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);