update doc
[tiramisu.git] / doc / option.txt
index 90dea0a..47053b8 100644 (file)
@@ -9,7 +9,7 @@ Description of Options
 ----------------------
 
 All the constructors take a ``name`` and a ``doc`` argument as first
-arguments to give the option or option group a name and to document it.
+arguments to give to the option or option description a name and a description document.
 Most constructors take a ``default`` argument that specifies the default
 value of the option. If this argument is not supplied the default value
 is assumed to be ``None``.
@@ -17,7 +17,7 @@ is assumed to be ``None``.
 The `Option` base class
 -------------------------
 
-It's the abstract base class for almost all options (except the symblink).
+It's the abstract base class for almost all options (except the symlink).
 
 .. _optioninit:
 
@@ -28,22 +28,41 @@ It's the abstract base class for almost all options (except the symblink).
 All option types
 ------------------
 
+BoolOption
+~~~~~~~~~~
+
 .. autoclass:: BoolOption
     :private-members:
 
+IntOption
+~~~~~~~~~
+
 .. autoclass:: IntOption
     :private-members:
 
+FloatOption
+~~~~~~~~~~~
+
 .. autoclass:: FloatOption
     :private-members:
 
+StrOption
+~~~~~~~~~
+
 .. autoclass:: StrOption
     :private-members:
 
+UnicodeOption
+~~~~~~~~~~~~~
 
-.. autoclass:: SymLinkOption
+.. autoclass:: UnicodeOption
+    :private-members:
 
-    .. automethod:: __init__
+SymLinkOption
+~~~~~~~~~~~~~
+
+.. autoclass:: SymLinkOption
+    :private-members:
 
 
 ``SymLinkOption`` redirects to another configuration option in the
@@ -52,19 +71,41 @@ configuration, that is :
 - retrieves the value of the target,
 - can set the value of the target too
 
+IPOption
+~~~~~~~~
 
 .. autoclass:: IPOption
+    :private-members:
+
+PortOption
+~~~~~~~~~~
+
+.. autoclass:: PortOption
+    :private-members:
+
+NetmaskOption
+~~~~~~~~~~~~~
 
 .. autoclass:: NetmaskOption
+    :private-members:
+
+NetworkOption
+~~~~~~~~~~~~~
 
 .. autoclass:: NetworkOption
+    :private-members:
+
+DomainnameOption
+~~~~~~~~~~~~~~~~
 
 .. autoclass:: DomainnameOption
+    :private-members:
 
+ChoiceOption
+~~~~~~~~~~~~
 
 .. autoclass:: ChoiceOption
-
-    .. automethod:: __init__
+    :private-members:
 
 
 .. _optdescr: