Changeset 1245

Show
Ignore:
Timestamp:
09/05/06 03:23:37 (2 years ago)
Author:
cboos
Message:

DoxygenPlugin:

Some configuration settings documentation update.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • doxygenplugin/0.10/doxygentrac/doxygentrac.py

    r1244 r1245  
    3939 
    4040    default_doc = Option('doxygen', 'default_documentation', '', 
    41       """Default path relative to `base_path` in which to look for 
    42       documentation files.""") 
     41      """Default documentation project, relative to `[doxygen] path`. 
     42      When no explicit path is given in a documentation request, 
     43      this path will be prepended to the request before looking 
     44      for documentation files.""") 
    4345 
    4446    title = Option('doxygen', 'title', 'Doxygen', 
     
    5759 
    5860    wiki_index = Option('doxygen', 'wiki_index', None, 
    59       """Wiki page to use as the default page for the Doxygen main page.""") 
     61      """Wiki page to use as the default page for the Doxygen main page. 
     62      If set, supersedes the `[doxygen] index` option.""") 
    6063 
    6164    encoding = Option('doxygen', 'encoding', 'iso-8859-1', 
     
    412415            byte = fd.read(1) 
    413416        return result 
    414