Dolphin is now a KUniqueApplication. A lot of thanks go to Oscar Blumberg, who submit...

[dolphin.git] / src / viewproperties.h

diff --git a/src/viewproperties.h b/src/viewproperties.h
index 7e48b923bf4a660b3f7095e063895f0781a797c2..b4d9500bc66e57c1e905c59b2bcc4c564de745b7 100644 (file)
--- a/src/viewproperties.h
+++ b/src/viewproperties.h
@@ -1,6 +1,6 @@
 /***************************************************************************
- *   Copyright (C) 2006 by Peter Penz                                      *
- *   peter.penz@gmx.at                                                     *
+ *   Copyright (C) 2006 by Peter Penz (<peter.penz@gmx.at>)                *
+ *   Copyright (C) 2006 by Aaron J. Seigo (<aseigo@kde.org>)               *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
@@ -30,11 +30,12 @@
 class QFile;
 
 /**
- * @brief Maintains the view properties like 'view mode' or 'show hidden files' for a directory.
+ * @brief Maintains the view properties like 'view mode' or
+ *        'show hidden files' for a directory.
  *
- * The view properties are automatically stored inside
- * the directory as hidden file called '.dolphinview'. To read out the view properties
- * just construct an instance by passing the Url of the directory:
+ * The view properties are automatically stored as part of the file
+ * .directory inside the corresponding path. To read out the view properties
+ * just construct an instance by passing the path of the directory:
  *
  * \code
  * ViewProperties props(KUrl("/home/peter/Documents"));
@@ -42,8 +43,12 @@ class QFile;
  * const bool showHiddenFiles = props.isShowHiddenFilesEnabled();
  * \endcode
  *
- * When modifying a view property, the '.dolphinview' file is automatically updated
+ * When modifying a view property, the '.directory' file is automatically updated
  * inside the destructor.
+ *
+ * If no .directory file is available or the global view mode is turned on
+ * (see GeneralSettings::globalViewMode()), the values from the global .directory file
+ * are used for initialization.
  */
 class ViewProperties
 {