Changeset 8565

Timestamp:

10/03/09 05:07:38 (2 years ago)

Author:

Sewi

Message:

Added some documentation

File:

• trunk/Padre/lib/Padre/Config.pm (modified) (2 diffs)

trunk/Padre/lib/Padre/Config.pm

@@ -829 +829 @@
 =head1 DESCRIPTION
 
+This module not only stores the complete Padre configuration, it also holds
+the functions for loading and saving the configuration.
+
+The Padre configuration lives in two places:
+
+ - A user-editable text file usually called config.yml
+
+ - A SQlite - database which shouldn't be edited by the
+   user.
+
 =head2 Generic usage
 
@@ -868 +878 @@
 Those settings are accessed with C<Padre::Config::Project>.
 
+=head1 ADDING CONFIGURATION OPTIONS
+
+Add a "setting()" - call to the correct section of this file.
+
+The setting() call initially creates the option and defines some
+metadata like the type of the option, it's living place and the
+default value which should be used until the user configures
+a own value.
+
 =back