sphinx

Author: roman_yakovenko

docs/history/history.rest

@@ -32,7 +32,8 @@ Version 1.1
 2. Ability to extract different information from binary files ( ``.pdb``, ``.so``,
    ``.map`` ) and merge it with a declarations tree was added.
 
-3. Ability to load `GCC-XML`_ configuration from ``.ini`` like file was added
+3. Ability to load `GCC-XML`_ configuration from ``.ini`` like file was added.
+   See :func:`pygccxml.parser.config.load_gccxml_configuration` for details.
 
 4. From now on, :doc:`pygccxml <../pygccxml>` will use `Sphinx <http://sphinx.pocoo.org/>`_
    for all documentation.

pygccxml/parser/config.py

@@ -198,7 +198,8 @@ def raise_on_wrong_settings( self ):
 config_t = gccxml_configuration_t #backward computability
 
 gccxml_configuration_example = \
-"""[gccxml]
+"""
+[gccxml]
 #path to gccxml executable file - optional, if not provided, os.environ['PATH']
 #variable is used to find it
 gccxml_path=
@@ -210,24 +211,34 @@ def raise_on_wrong_settings( self ):
 #You can explicitly set what compiler it should emulate.
 #Valid options are: g++, msvc6, msvc7, msvc71, msvc8, cl.
 compiler=
-
-#GCC-XML site: http://gccxml.org/
 """
 
 def load_gccxml_configuration( configuration, **defaults ):
-    """loads GCC-XML configuration from a file
+    """
+    loads GCC-XML configuration from an `.ini` file or any other file class
+    :class:`ConfigParser.SafeConfigParser` is able to parse.
 
-    Configuration file sceleton:
+    :param configuration: configuration could be string( configuration file path )
+                          or instance of :class:`ConfigParser.SafeConfigParser` class
 
-    >>> start <<<
+    :rtype: :class:`.gccxml_configuration_t`
 
-    %s
+    Configuration file sceleton::
 
-    >>> end <<<
+       [gccxml]
+       #path to gccxml executable file - optional, if not provided, os.environ['PATH']
+       #variable is used to find it
+       gccxml_path=
+       #gccxml working directory - optional, could be set to your source code directory
+       working_directory=
+       #additional include directories, separated by ';' or ':'
+       include_paths=
+       #gccxml has a nice algorithms, which selects what C++ compiler to emulate.
+       #You can explicitly set what compiler it should emulate.
+       #Valid options are: g++, msvc6, msvc7, msvc71, msvc8, cl.
+       compiler=
 
-    configuration could be string( configuration file path ) or instance of
-    ConfigParser.SafeConfigParser class
-    """ % gccxml_configuration_example
+    """
     parser = configuration
     if isinstance( configuration, types.StringTypes ):
         from ConfigParser import SafeConfigParser