# [Xen-changelog] [xen-unstable] docs: drop doxygen stuff

• To: xen-changelog@xxxxxxxxxxxxxxxxxxx
• From: Xen patchbot-unstable <patchbot@xxxxxxx>
• Date: Mon, 04 Feb 2013 15:44:30 +0000
• Delivery-date: Mon, 04 Feb 2013 15:44:41 +0000
• List-id: "Change log for Mercurial $$receive only$$" <xen-changelog.lists.xen.org>

# HG changeset patch
# User Ian Campbell <ian.campbell@xxxxxxxxxx>
# Date 1359104616 0
# Node ID b25eaeba53f58dabea70b9ef03f7765bc78e08b9
# Parent  7fea8bf25c4c97f647cbba4970bbd621cf09431c
docs: drop doxygen stuff

In the 300+ page PDF this produces I couldn't see anything which
wasn't the autogenerated doxygen boilerplate stuff.

Signed-off-by: Ian Campbell <ian.campbell@xxxxxxxxxx>
Acked-by: Roger Pau Monné <roger.pau@xxxxxxxxxx>
Committed-by: Ian Campbell <ian.campbell@xxxxxxxxxx>
---

diff -r 7fea8bf25c4c -r b25eaeba53f5 docs/Docs.mk
--- a/docs/Docs.mk      Fri Jan 25 09:02:13 2013 +0000
+++ b/docs/Docs.mk      Fri Jan 25 09:03:36 2013 +0000
@@ -1,6 +1,5 @@
FIG2DEV                := fig2dev
LATEX2HTML     := latex2html
-DOXYGEN                := doxygen
POD2MAN                := pod2man
POD2HTML       := pod2html
POD2TEXT       := pod2text
diff -r 7fea8bf25c4c -r b25eaeba53f5 docs/Doxyfile
--- a/docs/Doxyfile     Fri Jan 25 09:02:13 2013 +0000
+++ /dev/null   Thu Jan 01 00:00:00 1970 +0000
@@ -1,1218 +0,0 @@
-# Doxyfile 1.4.2
-
-# This file describes the settings to be used by the documentation system
-# doxygen (www.doxygen.org) for a project
-#
-# All text after a hash (#) is considered a comment and will be ignored
-# The format is:
-#       TAG = value [value, ...]
-# For lists items can also be appended using:
-#       TAG += value [value, ...]
-# Values that contain spaces should be placed between quotes (" ")
-
-#---------------------------------------------------------------------------
-# Project related configuration options
-#---------------------------------------------------------------------------
-
-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
-# by quotes) that should identify the project.
-
-PROJECT_NAME           = Xen Python Tools
-
-# The PROJECT_NUMBER tag can be used to enter a project or revision number.
-# This could be handy for archiving the generated documentation or
-# if some version control system is used.
-
-PROJECT_NUMBER         =
-
-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
-# base path where the generated documentation will be put.
-# If a relative path is entered, it will be relative to the location
-# where doxygen was started. If left blank the current directory will be used.
-
-OUTPUT_DIRECTORY       = api/tools/python
-
-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
-# 4096 sub-directories (in 2 levels) under the output directory of each output
-# format and will distribute the generated files over these directories.
-# Enabling this option can be useful when feeding doxygen a huge amount of
-# source files, where putting all generated files in the same directory would
-# otherwise cause performance problems for the file system.
-
-CREATE_SUBDIRS         = NO
-
-# The OUTPUT_LANGUAGE tag is used to specify the language in which all
-# documentation generated by doxygen is written. Doxygen will use this
-# information to generate all constant output in the proper language.
-# The default language is English, other supported languages are:
-# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
-# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
-# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
-# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
-# Swedish, and Ukrainian.
-
-OUTPUT_LANGUAGE        = English
-
-# This tag can be used to specify the encoding used in the generated output.
-# The encoding is not always determined by the language that is chosen,
-# but also whether or not the output is meant for Windows or non-Windows
users.
-# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
-# forces the Windows encoding (this is the default for the Windows binary),
-# whereas setting the tag to NO uses a Unix-style encoding (the default for
-# all platforms other than Windows).
-
-USE_WINDOWS_ENCODING   = NO
-
-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
-# include brief member descriptions after the members that are listed in
-# the file and class documentation (similar to JavaDoc).
-# Set to NO to disable this.
-
-BRIEF_MEMBER_DESC      = YES
-
-# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
-# the brief description of a member or function before the detailed
description.
-# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
-# brief descriptions will be completely suppressed.
-
-REPEAT_BRIEF           = YES
-
-# This tag implements a quasi-intelligent brief description abbreviator
-# that is used to form the text in various listings. Each string
-# in this list, if found as the leading text of the brief description, will be
-# stripped from the text and the result after processing the whole list, is
-# used as the annotated text. Otherwise, the brief description is used as-is.
-# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The$name class" "The $name widget" -# "The$name file" "is" "provides" "specifies" "contains"
-# "represents" "a" "an" "the"
-
-ABBREVIATE_BRIEF       =
-
-# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
-# Doxygen will generate a detailed section even if there is only a brief
-# description.
-
-ALWAYS_DETAILED_SEC    = NO
-
-# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
-# inherited members of a class in the documentation of that class as if those
-# members were ordinary class members. Constructors, destructors and
assignment
-# operators of the base classes will not be shown.
-
-INLINE_INHERITED_MEMB  = NO
-
-# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
-# path before files name in the file list and in the header files. If set
-# to NO the shortest path that makes the file name unique will be used.
-
-FULL_PATH_NAMES        = YES
-
-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
-# can be used to strip a user-defined part of the path. Stripping is
-# only done if one of the specified strings matches the left-hand part of
-# the path. The tag can be used to show relative paths in the file list.
-# If left blank the directory from which doxygen is run is used as the
-# path to strip.
-
-STRIP_FROM_PATH        =
-
-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
-# the path mentioned in the documentation of a class, which tells
-# the reader which header file to include in order to use a class.
-# If left blank only the name of the header file containing the class
-# definition is used. Otherwise one should specify the include paths that
-# are normally passed to the compiler using the -I flag.
-
-STRIP_FROM_INC_PATH    =
-
-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
-# (but less readable) file names. This can be useful is your file systems
-# doesn't support long names like on DOS, Mac, or CD-ROM.
-
-SHORT_NAMES            = NO
-
-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
-# will interpret the first line (until the first dot) of a JavaDoc-style
-# comment as the brief description. If set to NO, the JavaDoc
-# comments will behave just like the Qt-style comments (thus requiring an
-# explicit @brief command for a brief description.
-
-
-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
-# treat a multi-line C++ special comment block (i.e. a block of //! or ///
-# comments) as a brief description. This used to be the default behaviour.
-# The new default is to treat a multi-line C++ comment block as a detailed
-# description. Set this tag to YES if you prefer the old behaviour instead.
-
-MULTILINE_CPP_IS_BRIEF = NO
-
-# If the DETAILS_AT_TOP tag is set to YES then Doxygen
-# will output the detailed description near the top, like JavaDoc.
-# If set to NO, the detailed description appears after the member
-# documentation.
-
-DETAILS_AT_TOP         = YES
-
-# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
-# member inherits the documentation from any documented member that it
-# re-implements.
-
-INHERIT_DOCS           = YES
-
-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
-# tag is set to YES, then doxygen will reuse the documentation of the first
-# member in the group (if any) for the other members of the group. By default
-# all members of a group must be documented explicitly.
-
-DISTRIBUTE_GROUP_DOC   = NO
-
-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
-# a new page for each member. If set to NO, the documentation of a member will
-# be part of the file/class/namespace that contains it.
-
-SEPARATE_MEMBER_PAGES  = NO
-
-# The TAB_SIZE tag can be used to set the number of spaces in a tab.
-# Doxygen uses this value to replace tabs by spaces in code fragments.
-
-TAB_SIZE               = 8
-
-# This tag can be used to specify a number of aliases that acts
-# as commands in the documentation. An alias has the form "name=value".
-# For example adding "sideeffect=\par Side Effects:\n" will allow you to
-# put the command \sideeffect (or @sideeffect) in the documentation, which
-# will result in a user-defined paragraph with heading "Side Effects:".
-# You can put \n's in the value part of an alias to insert newlines.
-
-ALIASES                =
-
-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
-# sources only. Doxygen will then generate output that is more tailored for C.
-# For instance, some of the names that are used will be different. The list
-# of all members will be omitted, etc.
-
-OPTIMIZE_OUTPUT_FOR_C  = NO
-
-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
sources
-# only. Doxygen will then generate output that is more tailored for Java.
-# For instance, namespaces will be presented as packages, qualified scopes
-# will look different, etc.
-
-OPTIMIZE_OUTPUT_JAVA   = YES
-
-# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
-# the same type (for instance a group of public functions) to be put as a
-# subgroup of that type (e.g. under the Public Functions section). Set it to
-# NO to prevent subgrouping. Alternatively, this can be done per class using
-# the \nosubgrouping command.
-
-SUBGROUPING            = YES
-
-#---------------------------------------------------------------------------
-# Build related configuration options
-#---------------------------------------------------------------------------
-
-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
-# documentation are documented, even if no documentation was available.
-# Private class members and static file members will be hidden unless
-# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
-
-EXTRACT_ALL            = YES
-
-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
-# will be included in the documentation.
-
-EXTRACT_PRIVATE        = YES
-
-# If the EXTRACT_STATIC tag is set to YES all static members of a file
-# will be included in the documentation.
-
-EXTRACT_STATIC         = YES
-
-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
-# defined locally in source files will be included in the documentation.
-# If set to NO only classes defined in header files are included.
-
-EXTRACT_LOCAL_CLASSES  = YES
-
-# This flag is only useful for Objective-C code. When set to YES local
-# methods, which are defined in the implementation section but not in
-# the interface are included in the documentation.
-# If set to NO (the default) only methods in the interface are included.
-
-EXTRACT_LOCAL_METHODS  = NO
-
-# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
-# undocumented members of documented classes, files or namespaces.
-# If set to NO (the default) these members will be included in the
-# various overviews, but no documentation section is generated.
-# This option has no effect if EXTRACT_ALL is enabled.
-
-HIDE_UNDOC_MEMBERS     = NO
-
-# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
-# undocumented classes that are normally visible in the class hierarchy.
-# If set to NO (the default) these classes will be included in the various
-# overviews. This option has no effect if EXTRACT_ALL is enabled.
-
-HIDE_UNDOC_CLASSES     = NO
-
-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
-# friend (class|struct|union) declarations.
-# If set to NO (the default) these declarations will be included in the
-# documentation.
-
-HIDE_FRIEND_COMPOUNDS  = NO
-
-# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
-# documentation blocks found inside the body of a function.
-# If set to NO (the default) these blocks will be appended to the
-# function's detailed documentation block.
-
-HIDE_IN_BODY_DOCS      = NO
-
-# The INTERNAL_DOCS tag determines if documentation
-# that is typed after a \internal command is included. If the tag is set
-# to NO (the default) then the documentation will be excluded.
-# Set it to YES to include the internal documentation.
-
-INTERNAL_DOCS          = NO
-
-# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
-# file names in lower-case letters. If set to YES upper-case letters are also
-# allowed. This is useful if you have classes or files whose names only differ
-# in case and if your file system supports case sensitive file names. Windows
-# and Mac users are advised to set this option to NO.
-
-CASE_SENSE_NAMES       = YES
-
-# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
-# will show members with their full class and namespace scopes in the
-# documentation. If set to YES the scope will be hidden.
-
-HIDE_SCOPE_NAMES       = NO
-
-# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
-# will put a list of the files that are included by a file in the
documentation
-# of that file.
-
-SHOW_INCLUDE_FILES     = YES
-
-# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
-# is inserted in the documentation for inline members.
-
-INLINE_INFO            = YES
-
-# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
-# will sort the (detailed) documentation of file and class members
-# alphabetically by member name. If set to NO the members will appear in
-# declaration order.
-
-SORT_MEMBER_DOCS       = YES
-
-# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
-# brief documentation of file, namespace and class members alphabetically
-# by member name. If set to NO (the default) the members will appear in
-# declaration order.
-
-SORT_BRIEF_DOCS        = NO
-
-# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
-# sorted by fully-qualified names, including namespaces. If set to
-# NO (the default), the class list will be sorted only by class name,
-# not including the namespace part.
-# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
-# Note: This option applies only to the class list, not to the
-# alphabetical list.
-
-SORT_BY_SCOPE_NAME     = NO
-
-# The GENERATE_TODOLIST tag can be used to enable (YES) or
-# disable (NO) the todo list. This list is created by putting \todo
-# commands in the documentation.
-
-GENERATE_TODOLIST      = YES
-
-# The GENERATE_TESTLIST tag can be used to enable (YES) or
-# disable (NO) the test list. This list is created by putting \test
-# commands in the documentation.
-
-GENERATE_TESTLIST      = YES
-
-# The GENERATE_BUGLIST tag can be used to enable (YES) or
-# disable (NO) the bug list. This list is created by putting \bug
-# commands in the documentation.
-
-GENERATE_BUGLIST       = YES
-
-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
-# disable (NO) the deprecated list. This list is created by putting
-# \deprecated commands in the documentation.
-
-GENERATE_DEPRECATEDLIST= YES
-
-# The ENABLED_SECTIONS tag can be used to enable conditional
-# documentation sections, marked by \if sectionname ... \endif.
-
-ENABLED_SECTIONS       =
-
-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
-# the initial value of a variable or define consists of for it to appear in
-# the documentation. If the initializer consists of more lines than specified
-# here it will be hidden. Use a value of 0 to hide initializers completely.
-# The appearance of the initializer of individual variables and defines in the
-# documentation can be controlled using \showinitializer or \hideinitializer
-# command in the documentation regardless of this setting.
-
-MAX_INITIALIZER_LINES  = 30
-
-# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
-# at the bottom of the documentation of classes and structs. If set to YES the
-# list will mention the files that were used to generate the documentation.
-
-SHOW_USED_FILES        = YES
-
-# If the sources in your project are distributed over multiple directories
-# then setting the SHOW_DIRECTORIES tag to YES will show the directory
hierarchy
-# in the documentation.
-
-SHOW_DIRECTORIES       = YES
-
-# The FILE_VERSION_FILTER tag can be used to specify a program or script that
-# doxygen should invoke to get the current version for each file (typically
from the
-# version control system). Doxygen will invoke the program by executing (via
-# popen()) the command <command> <input-file>, where <command> is the value of
-# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
-# provided by doxygen. Whatever the progam writes to standard output
-# is used as the file version. See the manual for examples.
-
-FILE_VERSION_FILTER    =
-
-#---------------------------------------------------------------------------
-# configuration options related to warning and progress messages
-#---------------------------------------------------------------------------
-
-# The QUIET tag can be used to turn on/off the messages that are generated
-# by doxygen. Possible values are YES and NO. If left blank NO is used.
-
-QUIET                  = YES
-
-# The WARNINGS tag can be used to turn on/off the warning messages that are
-# generated by doxygen. Possible values are YES and NO. If left blank
-# NO is used.
-
-WARNINGS               = YES
-
-# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
-# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
-# automatically be disabled.
-
-WARN_IF_UNDOCUMENTED   = YES
-
-# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
-# potential errors in the documentation, such as not documenting some
-# parameters in a documented function, or documenting parameters that
-# don't exist or using markup commands wrongly.
-
-WARN_IF_DOC_ERROR      = YES
-
-# This WARN_NO_PARAMDOC option can be abled to get warnings for
-# functions that are documented, but have no documentation for their
parameters
-# or return value. If set to NO (the default) doxygen will only warn about
-# wrong or incomplete parameter documentation, but not about the absence of
-# documentation.
-
-WARN_NO_PARAMDOC       = NO
-
-# The WARN_FORMAT tag determines the format of the warning messages that
-# doxygen can produce. The string should contain the $file,$line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -#$version, which will be replaced by the version of the file (if it could
-# be obtained via FILE_VERSION_FILTER)
-
-WARN_FORMAT            = "$file:$line: text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. - -INPUT = ../tools/python/xen/ - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm - -FILE_PATTERNS = *.py *.c - -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded -# from the input. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. - -EXCLUDE_PATTERNS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command <filter> <input-file>, where <filter> -# is the value of the INPUT_FILTER tag, and <input-file> is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be -# ignored. - -INPUT_FILTER = "sh ./Doxyfilter ../tools/python" - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER -# is applied to all files. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). - -FILTER_SOURCE_FILES = YES - -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES (the default) -# then for each documented function all documented -# functions referencing it will be listed. - -REFERENCED_BY_RELATION = YES - -# If the REFERENCES_RELATION tag is set to YES (the default) -# then for each documented function all documented entities -# called/used by that function will be listed. - -REFERENCES_RELATION = YES - -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. - -ALPHABETICAL_INDEX = NO - -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank html' will be used as the default path. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# stylesheet in the HTML output directory as well, or it will be erased! - -HTML_STYLESHEET = - -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = YES - -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be -# written to the html output directory. - -CHM_FILE = - -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. - -HHC_LOCATION = - -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). - -GENERATE_CHI = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. - -TOC_EXPAND = NO - -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. - -DISABLE_INDEX = NO - -# This tag can be used to set the number of enum values (range [1..20]) -# that doxygen will group on one line in the generated HTML documentation. - -ENUM_VALUES_PER_LINE = 4 - -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. - -GENERATE_TREEVIEW = NO - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. - -TREEVIEW_WIDTH = 250 - -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- - -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will -# generate Latex output. - -GENERATE_LATEX = YES - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank latex' will be used as the default path. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. If left blank latex' will be used as the default command name. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank makeindex' will be used as the -# default command name. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_LATEX = NO - -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, a4wide, letter, legal and -# executive. If left blank a4wide will be used. - -PAPER_TYPE = a4 - -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX -# packages that should be included in the LaTeX output. - -EXTRA_PACKAGES = - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a -# standard header. Notice: only use this tag if you know what you are doing! - -LATEX_HEADER = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references -# This makes the output suitable for online browsing using a pdf viewer. - -PDF_HYPERLINKS = YES - -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a -# higher quality PDF documentation. - -USE_PDFLATEX = YES - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. -# This option is also used when generating formulas in HTML. - -LATEX_BATCHMODE = NO - -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) -# in the output. - -LATEX_HIDE_INDICES = NO - -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with -# other RTF readers or editors. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank rtf' will be used as the default path. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. -# Note: wordpad (write) and others do not support links. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide -# replacements, missing definitions are set to their default value. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an rtf document. -# Syntax is similar to doxygen's config file. - -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will -# generate man pages - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank man' will be used as the default path. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to -# the generated man pages (default is the subroutine's section .3) - -MAN_EXTENSION = .3 - -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command -# would be unable to find the correct page. The default is NO. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of -# the code including all documentation. - -GENERATE_XML = NO - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank xml' will be used as the default path. - -XML_OUTPUT = xml - -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that -# enabling this will significantly increase the size of the XML output. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental -# and incomplete at the moment. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the -# moment. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able -# to generate PDF and DVI output from the Perl module output. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller -# and Perl will parse it just the same. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same -# Makefile don't overwrite each other's variables. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include -# files. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled -# way by setting EXPAND_ONLY_PREDEF to YES. - -MACRO_EXPANSION = NO - -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the -# PREDEFINED and EXPAND_AS_PREDEFINED tags. - -EXPAND_ONLY_PREDEF = NO - -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files -# in the INCLUDE_PATH (see below) will be search if a #include is found. - -SEARCH_INCLUDES = YES - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by -# the preprocessor. - -INCLUDE_PATH = - -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will -# be used. - -INCLUDE_FILE_PATTERNS = - -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator -# instead of the = operator. - -PREDEFINED = - -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. -# Use the PREDEFINED tag if you want to use a different macro definition. - -EXPAND_AS_DEFINED = - -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all function-like macros that are alone -# on a line, have an all uppercase name, and do not end with a semicolon. Such -# function macros are typically used for boiler-plate code, and will confuse -# the parser if not removed. - -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen -# is run, you must also specify the path to the tagfile here. - -TAGFILES = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create -# a tag file that is based on the input files it reads. - -GENERATE_TAGFILE = - -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes -# will be listed. - -ALLEXTERNALS = NO - -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will -# be listed. - -EXTERNAL_GROUPS = YES - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of which perl'). - -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option is superseded by the HAVE_DOT option below. This is only a -# fallback. It is recommended to install and use dot, since it yields more -# powerful graphs. - -CLASS_DIAGRAMS = YES - -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented -# or is not a class. - -HIDE_UNDOC_RELATIONS = YES - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section -# have no effect if this option is set to NO (the default) - -HAVE_DOT = NO - -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the -# the CLASS_DIAGRAMS tag to NO. - -CLASS_GRAPH = YES - -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and -# class references variables) of the class with other documented classes. - -COLLABORATION_GRAPH = YES - -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for groups, showing the direct groups dependencies - -GROUP_GRAPHS = YES - -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. - -UML_LOOK = NO - -# If set to YES, the inheritance and collaboration graphs will show the -# relations between templates and their instances. - -TEMPLATE_RELATIONS = NO - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with -# other documented files. - -INCLUDE_GRAPH = YES - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or -# indirectly include this file. - -INCLUDED_BY_GRAPH = YES - -# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will -# generate a call dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. - -CALL_GRAPH = NO - -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen -# will graphical hierarchy of all classes instead of a textual one. - -GRAPHICAL_HIERARCHY = YES - -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories -# in a graphical way. The dependency relations are determined by the #include -# relations between the files in the directories. - -DIRECTORY_GRAPH = YES - -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are png, jpg, or gif -# If left blank png will be used. - -DOT_IMAGE_FORMAT = png - -# The tag DOT_PATH can be used to specify the path where the dot tool can be -# found. If left blank, it is assumed the dot tool can be found in the path. - -DOT_PATH = - -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the -# \dotfile command). - -DOTFILE_DIRS = - -# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width -# (in pixels) of the graphs generated by dot. If a graph becomes larger than -# this value, doxygen will try to truncate the graph, so that it fits within -# the specified constraint. Beware that most browsers cannot cope with very -# large images. - -MAX_DOT_GRAPH_WIDTH = 1024 - -# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height -# (in pixels) of the graphs generated by dot. If a graph becomes larger than -# this value, doxygen will try to truncate the graph, so that it fits within -# the specified constraint. Beware that most browsers cannot cope with very -# large images. - -MAX_DOT_GRAPH_HEIGHT = 1024 - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that a graph may be further truncated if the graph's -# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH -# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), -# the graph is not depth-constrained. - -MAX_DOT_GRAPH_DEPTH = 0 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, which results in a white background. -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). - -DOT_TRANSPARENT = NO - -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) -# support this, this feature is disabled by default. - -DOT_MULTI_TARGETS = NO - -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and -# arrows in the dot generated graphs. - -GENERATE_LEGEND = YES - -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate -# the various graphs. - -DOT_CLEANUP = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to the search engine -#--------------------------------------------------------------------------- - -# The SEARCHENGINE tag specifies whether or not a search engine should be -# used. If set to NO the values of all tags below this one will be ignored. - -SEARCHENGINE = NO diff -r 7fea8bf25c4c -r b25eaeba53f5 docs/Doxyfilter --- a/docs/Doxyfilter Fri Jan 25 09:02:13 2013 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,16 +0,0 @@ -#!/bin/sh - -# -# Doxyfilter <source-root> <filename> -# - -dir=(dirname "$0") - -PYFILTER="$dir/pythfilter.py"
-
-if [ "${2/.py/}" != "$2" ]
-then
-    python "$PYFILTER" -r "$1" -f "$2" -else - cat "$2"
-fi
diff -r 7fea8bf25c4c -r b25eaeba53f5 docs/Makefile
--- a/docs/Makefile     Fri Jan 25 09:02:13 2013 +0000
+++ b/docs/Makefile     Fri Jan 25 09:03:36 2013 +0000
@@ -27,9 +27,6 @@ all: build
.PHONY: build
build: html txt man-pages figs

-.PHONY: dev-docs
-dev-docs: python-dev-docs
-
.PHONY: html
html: $(DOC_HTML) html/index.html @@ -45,15 +42,6 @@ figs: set -x;$(MAKE) -C figs ; else                   \
echo "fig2dev (transfig) not installed; skipping figs."; fi

-.PHONY: python-dev-docs
-python-dev-docs:
-       @mkdir -v -p api/tools/python
-       @set -e ; if which $(DOXYGEN) 1>/dev/null 2>/dev/null; then \ - echo "Running doxygen to generate Python tools APIs ... "; \ -$(DOXYGEN) Doxyfile;                                       \
-       $(MAKE) -C api/tools/python/latex ; else \ - echo "Doxygen not installed; skipping python-dev-docs."; fi - .PHONY: man-pages man-pages: @if which$(POD2MAN) 1>/dev/null 2>/dev/null; then \
@@ -76,7 +64,6 @@ clean:
rm -rf .word_count *.aux *.dvi *.bbl *.blg *.glo *.idx *~
rm -rf *.ilg *.log *.ind *.toc *.bak core
rm -rf html txt
-       rm -rf api
rm -rf man5
rm -rf man1

diff -r 7fea8bf25c4c -r b25eaeba53f5 docs/html.sty
--- a/docs/html.sty     Fri Jan 25 09:02:13 2013 +0000
+++ /dev/null   Thu Jan 01 00:00:00 1970 +0000
@@ -1,887 +0,0 @@
-%
-% $Id: html.sty,v 1.23 1998/02/26 10:32:24 latex2html Exp$
-% LaTeX2HTML Version 96.2 : html.sty
-%
-% This file contains definitions of LaTeX commands which are
-% processed in a special way by the translator.
-% For example, there are commands for embedding external hypertext links,
-% for cross-references between documents or for including raw HTML.
-% This file includes the comments.sty file v2.0 by Victor Eijkhout
-% In most cases these commands do nothing when processed by LaTeX.
-%
-% Place this file in a directory accessible to LaTeX (i.e., somewhere
-% in the TEXINPUTS path.)
-%
-% NOTE: This file works with LaTeX 2.09 or (the newer) LaTeX2e.
-%       If you only have LaTeX 2.09, some complex LaTeX2HTML features
-%       like support for segmented documents are not available.
-
-% Changes:
-% See the change log at end of file.
-
-
-% (suggested by Lee Shombert <las@xxxxxxxxxxxxxxxxxxxxxx>
-\makeatletter
-
-\providecommand{\latextohtml}{\LaTeX2\texttt{HTML}}
-
-
-%
-% This can be used to provide links to arbitrary documents.
-% The first argumment should be the text that is going to be
-% highlighted and the second argument a URL.
-% document and as a footnote in the dvi or ps files.
-%
-
-
-% This is an alternative definition of the command above which
-% will ignore the URL in the dvi or ps files.
-
-
-% This command takes as argument a URL pointing to an image.
-% The image will be embedded in the HTML document but will
-% be ignored in the dvi and ps files.
-%
-
-
-%%% CROSS-REFERENCES BETWEEN (LOCAL OR REMOTE) DOCUMENTS
-%
-% This can be used to refer to symbolic labels in other Latex
-% documents that have already been processed by the translator.
-% The arguments should be:
-% #1 : the URL to the directory containing the external document
-% #2 : the path to the labels.pl file of the external document.
-% If the external document lives on a remote machine then labels.pl
-% must be copied on the local machine.
-%
-%e.g. \externallabels{http://cbl.leeds.ac.uk/nikos/WWW/doc/tex2html/latex2html}
-%                    {/usr/cblelca/nikos/tmp/labels.pl}
-% The arguments are ignored in the dvi and ps files.
-%
-\newcommand{\externallabels}[2]{}
-
-
-% This complements the \externallabels command above. The argument
-% should be a label defined in another latex document and will be
-% ignored in the dvi and ps files.
-%
-\newcommand{\externalref}[1]{}
-
-
-% Suggested by  Uffe Engberg (http://www.brics.dk/~engberg/)
-% This allows the same effect for citations in external bibliographies.
-% An  \externallabels  command must be given, locating a labels.pl file
-% which defines the location and keys used in the external .html file.
-%
-\newcommand{\externalcite}{\nocite}
-
-
-%%% HTMLRULE
-% This command adds a horizontal rule and is valid even within
-% a figure caption.
-% Here we introduce a stub for compatibility.
-\newcommand{\htmlrule}{\protect\HTMLrule}
-\newcommand{\HTMLrule}{\@ifstar\htmlrulestar\htmlrulestar}
-\newcommand{\htmlrulestar}[1]{}
-
-% This command adds information within the <BODY> ... </BODY> tag
-%
-\newcommand{\bodytext}[1]{}
-\newcommand{\htmlbody}{}
-
-
-%%% HYPERREF
-% Suggested by Eric M. Carol <eric@xxxxxxxxxxxxxxxxxxxxx>
-% Similar to \ref but accepts conditional text.
-% The first argument is HTML text which will become hyperized''
-% (underlined).
-% The second and third arguments are text which will appear only in the paper
-% version (DVI file), enclosing the fourth argument which is a reference to a
label.
-%
-%e.g. \hyperref{using the tracer}{using the tracer (see Section}{)}{trace}
-% where there is a corresponding \label{trace}
-%
-\newcommand{\hyperref}{\hyperrefx[ref]}
-\def\hyperrefx[#1]{{\def\next{#1}%
- \def\tmp{ref}\ifx\next\tmp\aftergroup\hyperrefref
- \else\def\tmp{pageref}\ifx\next\tmp\aftergroup\hyperpageref
- \else\def\tmp{page}\ifx\next\tmp\aftergroup\hyperpageref
- \else\def\tmp{noref}\ifx\next\tmp\aftergroup\hypernoref
- \else\def\tmp{no}\ifx\next\tmp\aftergroup\hypernoref
- \else\typeout{*** unknown option \next\space to  hyperref ***}%
- \fi\fi\fi\fi\fi}}
-\newcommand{\hyperrefref}[4]{#2\ref{#4}#3}
-\newcommand{\hyperpageref}[4]{#2\pageref{#4}#3}
-\newcommand{\hypernoref}[3]{#2}
-
-
-%%% HYPERCITE --- added by RRM
-% Suggested by Stephen Simpson <simpson@xxxxxxxxxxxx>
-% effects the same ideas as in  \hyperref, but for citations.
-% It does not allow an optional argument to the \cite, in LaTeX.
-%
-%   \hypercite{<html-text>}{<LaTeX-text>}{<opt-text>}{<key>}
-%
-% uses the pre/post-texts in LaTeX, with a  \cite{<key>}
-%
-%   \hypercite[ext]{<html-text>}{<LaTeX-text>}{<key>}
-%
-% uses the pre/post-texts in LaTeX, with a  \nocite{<key>}
-% the actual reference comes from an \externallabels  file.
-%
-\newcommand{\hypercite}{\hypercitex[int]}
-\def\hypercitex[#1]{{\def\next{#1}%
- \def\tmp{int}\ifx\next\tmp\aftergroup\hyperciteint
- \else\def\tmp{cite}\ifx\next\tmp\aftergroup\hyperciteint
- \else\def\tmp{ext}\ifx\next\tmp\aftergroup\hyperciteext
- \else\def\tmp{nocite}\ifx\next\tmp\aftergroup\hyperciteext
- \else\def\tmp{no}\ifx\next\tmp\aftergroup\hyperciteext
- \else\typeout{*** unknown option \next\space to  hypercite ***}%
- \fi\fi\fi\fi\fi}}
-\newcommand{\hyperciteint}[4]{#2{\def\tmp{#3}\def\emptyopt{}%
- \ifx\tmp\emptyopt\cite{#4}\else\cite[#3]{#4}\fi}}
-\newcommand{\hyperciteext}[3]{#2\nocite{#3}}
-
-
-
-%%% HTMLREF
-% Reference in HTML version only.
-% First arg is text for in both versions, second is label for use in HTML
-% version.
-\newcommand{\htmlref}[2]{#1}
-
-%%% HTMLCITE
-% Reference in HTML version only.
-% First arg is text for in both versions, second is citation for use in HTML
-% version.
-\newcommand{\htmlcite}[2]{#1}
-
-
-%%% HTMLIMAGE
-% This command can be used inside any environment that is converted
-% into an inlined image (eg a "figure" environment) in order to change
-% the way the image will be translated. The argument of \htmlimage
-% is really a string of options separated by commas ie
-% [scale=<scale factor>],[external],[thumbnail=<reduction factor>
-% The scale option allows control over the size of the final image.
-% The external'' option will cause the image not to be inlined
-% (images are inlined by default). External images will be accessible
-% The thumbnail'' option will cause a small inlined image to be
-% placed in the caption. The size of the thumbnail depends on the
-% reduction factor. The use of the thumbnail'' option implies
-% the external'' option.
-%
-% Example:
-% \htmlimage{scale=1.5,external,thumbnail=0.2}
-% will cause a small thumbnail image 1/5th of the original size to be
-% placed in the final document, pointing to an external image 1.5
-% times bigger than the original.
-%
-\newcommand{\htmlimage}[1]{}
-
-
-% \htmlborder causes a border to be placed around an image or table
-% when the image is placed within a <TABLE> cell.
-\newcommand{\htmlborder}[1]{}
-
-% Put \begin{makeimage}, \end{makeimage} around LaTeX to ensure its
-% translation into an image.
-% This shields sensitive text from being translated.
-\newenvironment{makeimage}{}{}
-
-
-% A dummy environment that can be useful to alter the order
-% in which commands are processed, in LaTeX2HTML
-\newenvironment{tex2html_deferred}{}{}
-
-
-% This command appends its argument to the buttons in the navigation
-% panel. It is ignored by LaTeX.
-%
-% Example:
-%              {http://server/path}}
-
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-% Comment.sty   version 2.0, 19 June 1992
-% selectively in/exclude pieces of text: the user can define new
-% comment versions, and each is controlled separately.
-% This style can be used with plain TeX or LaTeX, and probably
-% most other packages too.
-%
-% Examples of use in LaTeX and TeX follow \endinput
-%
-% Author
-%    Victor Eijkhout
-%    Department of Computer Science
-%    University Tennessee at Knoxville
-%    104 Ayres Hall
-%    Knoxville, TN 37996
-%    USA
-%
-%    eijkhout@xxxxxxxxxx
-%
-% Usage: all text included in between
-%    \comment ... \endcomment
-% or \begin{comment} ... \end{comment}
-% is discarded. The closing command should appear on a line
-% of its own. No starting spaces, nothing after it.
-% This environment should work with arbitrary amounts
-% of comment.
-%
-% Other 'comment' environments are defined by
-% and are selected/deselected with
-% \includecomment{versiona}
-% \excludecoment{versionb}
-%
-% These environments are used as
-% \versiona ... \endversiona
-% or \begin{versiona} ... \end{versiona}
-% with the closing command again on a line of its own.
-%
-% Basic approach:
-% to comment something out, scoop up  every line in verbatim mode
-% as macro argument, then throw it away.
-% For inclusions, both the opening and closing comands
-% are defined as noop
-%
-% Changed \next to \html@next to prevent clashes with other sty files
-% (mike@xxxxxx)
-% Changed \html@next to \htmlnext so the \makeatletter and
-% \makeatother commands could be removed (they were causing other
-% style files - changebar.sty - to crash) (nikos@xxxxxxxxxxxxxxx)
-% Changed \htmlnext back to \html@xxxxxxx
-
-\def\makeinnocent#1{\catcode#1=12 }
-\def\csarg#1#2{\expandafter#1\csname#2\endcsname}
-
-\def\ThrowAwayComment#1{\begingroup
-    \def\CurrentComment{#1}%
-    \let\do\makeinnocent \dospecials
-    \makeinnocent\^^L% and whatever other special cases
-    \endlinechar\^^M \catcode\^^M=12 \xComment}
-{\catcode\^^M=12 \endlinechar=-1 %
- \gdef\xComment#1^^M{\def\test{#1}\edef\test{\meaning\test}
-      \csarg\ifx{PlainEnd\CurrentComment Test}\test
-          \let\html@next\endgroup
-      \else \csarg\ifx{LaLaEnd\CurrentComment Test}\test
-            \edef\html@next{\endgroup\noexpand\end{\CurrentComment}}
-      \else \csarg\ifx{LaInnEnd\CurrentComment Test}\test
-            \edef\html@next{\endgroup\noexpand\end{\CurrentComment}}
-      \else \let\html@next\xComment
-      \fi \fi \fi \html@next}
-}
-
-\def\includecomment
- #1{\expandafter\def\csname#1\endcsname{}%
-    \expandafter\def\csname end#1\endcsname{}}
-\def\excludecomment
- #1{\expandafter\def\csname#1\endcsname{\ThrowAwayComment{#1}}%
-    {\escapechar=-1\relax
-     \edef\tmp{\string\\end#1}%
-      \csarg\xdef{PlainEnd#1Test}{\meaning\tmp}%
-     \edef\tmp{\string\\end\string\{#1\string\}}%
-      \csarg\xdef{LaLaEnd#1Test}{\meaning\tmp}%
-     \edef\tmp{\string\\end \string\{#1\string\}}%
-      \csarg\xdef{LaInnEnd#1Test}{\meaning\tmp}%
-    }}
-
-\excludecomment{comment}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-% end Comment.sty
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-%
-% Alternative code by Robin Fairbairns, 22 September 1997
-%
-\newcommand\@gobbleenv{\let\reserved@a\@currenvir\@gobble@nv}
-\long\def\@gobble@nv#1\end#2{\def\reserved@b{#2}%
- \ifx\reserved@a\reserved@b
-  \edef\reserved@a{\noexpand\end{\reserved@a}}%
-  \expandafter\reserved@a
- \else
-  \expandafter\@gobble@nv
- \fi}
-
-\renewcommand{\excludecomment}[1]{%
-    \csname newenvironment\endcsname{#1}{\@gobbleenv}{}}
-
-%%% RAW HTML
-%
-% Enclose raw HTML between a \begin{rawhtml} and \end{rawhtml}.
-% The html environment ignores its body
-%
-\excludecomment{rawhtml}
-
-
-%%% HTML ONLY
-%
-% Enclose LaTeX constructs which will only appear in the
-% HTML output and will be ignored by LaTeX with
-% \begin{htmlonly} and \end{htmlonly}
-%
-\excludecomment{htmlonly}
-% Shorter version
-\newcommand{\html}[1]{}
-
-% for images.tex only
-\excludecomment{imagesonly}
-
-%%% LaTeX ONLY
-% Enclose LaTeX constructs which will only appear in the
-% DVI output and will be ignored by latex2html with
-%\begin{latexonly} and \end{latexonly}
-%
-\newenvironment{latexonly}{}{}
-% Shorter version
-\newcommand{\latex}[1]{#1}
-
-
-%%% LaTeX or HTML
-% Combination of \latex and \html.
-% Say \latexhtml{this should be latex text}{this html text}
-%
-%\newcommand{\latexhtml}[2]{#1}
-\long\def\latexhtml#1#2{#1}
-
-
-%%% tracing the HTML conversions
-% This alters the tracing-level within the processing
-%
-% Revision 1.9  1997/02/17 02:26:26  RRM
-% - changes to counter handling (RRM)
-% - shuffled around some definitions
-% - changed \htmlrule of 209 mode
-%
-% Revision 1.8  1997/01/26 09:04:12  RRM
-% RRM: added optional argument to sectioning commands
-%      \htmlbase  sets the <BASE HREF=...> tag
-%      \htmlinfo  and  \htmlinfo* allow the document info to be positioned
-%
-% Revision 1.7  1997/01/03 12:15:44  L2HADMIN
-% % - fixes to the  color  and  natbib  interfaces
-% % - extended usage of  \hyperref, via an optional argument.
-% % - extended use comment environments to allow shifting expansions
-% %     e.g. within \multicolumn  (bug' reported by Luc De Coninck).
-% % - allow optional argument to: \htmlimage, \htmlhead,
-%
-% Revision 1.6  1996/12/25 03:04:54  JCL
-% added patches to segment feature from Martin Wilck
-%
-% Revision 1.5  1996/12/23 01:48:06  JCL
-%  o introduced the environment makeimage, which may be used to force
-%    LaTeX2HTML to generate an image from the contents.
-%    There's no magic, all what we have now is a defined empty environment
-%    which LaTeX2HTML will not recognize and thus pass it to images.tex.
-%  o provided \protect to the \htmlrule commands to allow for usage
-%    within captions.
-%
-% Revision 1.4  1996/12/21 19:59:22  JCL
-% - shuffled some entries
-%
-% Revision 1.3  1996/12/21 12:22:59  JCL
-% removed duplicate \htmlrule, changed \htmlrule back not to create a \hrule
-% to allow occurrence in caption
-%
-% Revision 1.2  1996/12/20 04:03:41  JCL
-% changed occurrence of \makeatletter, \makeatother
-% added new \htmlrule command both for the LaTeX2.09 and LaTeX2e
-% sections
-%
-%
-% jcl 30-SEP-96
-%  - Stuck the commands commonly used by both LaTeX versions to the top,
-%    added a check which stops input or reads further if the document
-%    makes use of LaTeX2e.
-%  - Introduced rrm's \dumpcurrentcolor and \bodytext
-% hws 31-JAN-96 - Added support for document segmentation
-% hws 10-OCT-95 - Added \htmlrule command
-% jz 22-APR-94 - Added support for htmlref
-% nd  - Created
diff -r 7fea8bf25c4c -r b25eaeba53f5 docs/pythfilter.py
--- a/docs/pythfilter.py        Fri Jan 25 09:02:13 2013 +0000
+++ /dev/null   Thu Jan 01 00:00:00 1970 +0000
@@ -1,658 +0,0 @@
-#!/usr/bin/env python
-
-# pythfilter.py v1.5.5, written by Matthias Baas (baas@xxxxxxxxxx)
-
-# Doxygen filter which can be used to document Python source code.
-# Classes (incl. methods) and functions can be documented.
-# Every comment that begins with ## is literally turned into an
-# Doxygen comment. Consecutive comment lines are turned into
-# comment blocks (-> /** ... */).
-# All the stuff is put inside a namespace with the same name as
-# the source file.
-
-# Conversions:
-# ============
-# ##-blocks                  ->  /** ... */
-# "class name(base): ..."    ->  "class name : public base {...}"
-# "def name(params): ..."    ->  "name(params) {...}"
-
-# Changelog:
-# 21.01.2003: Raw (r"") or unicode (u"") doc string will now be properly
-#             handled. (thanks to Richard Laager for the patch)
-# 22.12.2003: Fixed a bug where no function names would be output for "def"
-#             blocks that were not in a class.
-#             (thanks to Richard Laager for the patch)
-# 12.12.2003: Implemented code to handle static and class methods with
-#             this logic: Methods with "self" as the first argument are
-#             non-static. Methods with "cls" are Python class methods,
-#             which translate into static methods for Doxygen. Other
-#             methods are assumed to be static methods. As should be
-#             obvious, this logic doesn't take into account if the method
-#             is actually setup as a classmethod() or a staticmethod(),
-#             just if it follows the normal conventions.
-#             (thanks to Richard Laager for the patch)
-# 11.12.2003: Corrected #includes to use os.path.sep instead of ".". Corrected
-#             namespace code to use "::" instead of ".".
-#             (thanks to Richard Laager for the patch)
-# 11.12.2003: Methods beginning with two underscores that end with
-#             something other than two underscores are considered private
-#             and are handled accordingly.
-#             (thanks to Richard Laager for the patch)
-# 03.12.2003: The first parameter of class methods (self) is removed from
-#             the documentation.
-# 03.11.2003: The module docstring will be used as namespace documentation
-#             (thanks to Joe Bronkema for the patch)
-# 08.07.2003: Namespaces get a default documentation so that the namespace
-#             and its contents will show up in the generated documentation.
-# 05.02.2003: Directories will be delted during synchronization.
-# 31.01.2003: -f option & filtering entire directory trees.
-# 10.08.2002: In base classes the '.' will be replaced by '::'
-# 18.07.2002: * and ** will be translated into arguments
-# 18.07.2002: Argument lists may contain default values using constructors.
-# 18.06.2002: Support for ## public:
-# 21.01.2002: from ... import will be translated to "using namespace ...;"
-#             TODO: "from ... import *" vs "from ... import names"
-#             TODO: Using normal imports: name.name -> name::name
-# 20.01.2002: #includes will be placed in front of the namespace
-
-######################################################################
-
-# The program is written as a state machine with the following states:
-#
-# - OUTSIDE               The current position is outside any comment,
-#                         class definition or function.
-#
-# - BUILD_COMMENT         Begins with first "##".
-#                         Ends with the first token that is no "##"
-#                         at the same column as before.
-#
-# - BUILD_CLASS_DECL      Begins with "class".
-#                         Ends with ":"
-# - BUILD_CLASS_BODY      Begins just after BUILD_CLASS_DECL.
-#                         The first following token (which is no comment)
-#                         determines indentation depth.
-#                         Ends with a token that has a smaller indendation.
-#
-# - BUILD_DEF_DECL        Begins with "def".
-#                         Ends with ":".
-# - BUILD_DEF_BODY        Begins just after BUILD_DEF_DECL.
-#                         The first following token (which is no comment)
-#                         determines indentation depth.
-#                         Ends with a token that has a smaller indendation.
-
-import getopt
-import glob
-import os.path
-import re
-import shutil
-import string
-import sys
-import token
-import tokenize
-
-from stat import *
-
-OUTSIDE          = 0
-BUILD_COMMENT    = 1
-BUILD_CLASS_DECL = 2
-BUILD_CLASS_BODY = 3
-BUILD_DEF_DECL   = 4
-BUILD_DEF_BODY   = 5
-IMPORT           = 6
-IMPORT_OP        = 7
-IMPORT_APPEND    = 8
-
-# Output file stream
-outfile = sys.stdout
-
-# Output buffer
-outbuffer = []
-
-out_row = 1
-out_col = 0
-
-# Variables used by rec_name_n_param()
-name         = ""
-param        = ""
-doc_string   = ""
-record_state = 0
-bracket_counter = 0
-
-# Tuple: (row,column)
-class_spos  = (0,0)
-def_spos    = (0,0)
-import_spos = (0,0)
-
-# Which import was used? ("import" or "from")
-import_token = ""
-
-# Comment block buffer
-comment_block = []
-comment_finished = 0
-
-# Imported modules
-modules = []
-
-# Program state
-stateStack = [OUTSIDE]
-
-# Keep track of whether module has a docstring
-module_has_docstring = False
-
-# Keep track of member protection
-protection_level = "public"
-private_member = False
-
-# Keep track of the module namespace
-namespace = ""
-
-######################################################################
-# Output string s. '\n' may only be at the end of the string (not
-# somewhere in the middle).
-#
-# In: s    - String
-#     spos - Startpos
-######################################################################
-def output(s,spos, immediate=0):
-    global outbuffer, out_row, out_col, outfile
-
-    os = string.rjust(s,spos[1]-out_col+len(s))
-
-    if immediate:
-        outfile.write(os)
-    else:
-        outbuffer.append(os)
-
-    assert -1 == string.find(s[0:-2], "\n"), s
-
-    if (s[-1:]=="\n"):
-        out_row = out_row+1
-        out_col = 0
-    else:
-        out_col = spos[1]+len(s)
-
-
-######################################################################
-# Records a name and parameters. The name is either a class name or
-# a function name. Then the parameter is either the base class or
-# the function parameters.
-# The name is stored in the global variable "name", the parameters
-# in "param".
-# The variable "record_state" holds the current state of this internal
-# state machine.
-# The recording is started by calling start_recording().
-#
-# In: type, tok
-######################################################################
-def rec_name_n_param(type, tok):
-    global record_state,name,param,doc_string,bracket_counter
-    s = record_state
-    # State 0: Do nothing.
-    if   (s==0):
-         return
-    # State 1: Remember name.
-    elif (s==1):
-        name = tok
-        record_state = 2
-    # State 2: Wait for opening bracket or colon
-    elif (s==2):
-        if (tok=='('):
-            bracket_counter = 1
-            record_state=3
-        if (tok==':'): record_state=4
-    # State 3: Store parameter (or base class) and wait for an ending bracket
-    elif (s==3):
-        if (tok=='*' or tok=='**'):
-            tok=''
-        if (tok=='('):
-            bracket_counter = bracket_counter+1
-        if (tok==')'):
-            bracket_counter = bracket_counter-1
-        if bracket_counter==0:
-            record_state=4
-        else:
-            param=param+tok
-    # State 4: Look for doc string
-    elif (s==4):
-        if (type==token.NEWLINE or type==token.INDENT or
type==token.SLASHEQUAL):
-            return
-        elif (tok==":"):
-            return
-        elif (type==token.STRING):
-            while tok[:1]=='r' or tok[:1]=='u':
-                tok=tok[1:]
-            while tok[:1]=='"':
-                tok=tok[1:]
-            while tok[-1:]=='"':
-                tok=tok[:-1]
-            doc_string=tok
-        record_state=0
-
-######################################################################
-# Starts the recording of a name & param part.
-# The function rec_name_n_param() has to be fed with tokens. After
-# the necessary tokens are fed the name and parameters can be found
-# in the global variables "name" und "param".
-######################################################################
-def start_recording():
-    global record_state,param,name, doc_string
-    record_state=1
-    name=""
-    param=""
-    doc_string=""
-
-######################################################################
-# Test if recording is finished
-######################################################################
-def is_recording_finished():
-    global record_state
-    return record_state==0
-
-######################################################################
-## Gather comment block
-######################################################################
-def gather_comment(type,tok,spos):
-    global comment_block,comment_finished
-    if (type!=tokenize.COMMENT):
-        comment_finished = 1
-    else:
-        # Output old comment block if a new one is started.
-        if (comment_finished):
-            print_comment(spos)
-            comment_finished=0
-        if (tok[0:2]=="##" and tok[0:3]!="###"):
-            append_comment_lines(tok[2:])
-
-######################################################################
-## Output comment block and empty buffer.
-######################################################################
-def print_comment(spos):
-    global comment_block,comment_finished
-    if (comment_block!=[]):
-        output("/** ",spos)
-        for c in comment_block:
-            output(c,spos)
-        output("*/\n",spos)
-    comment_block    = []
-    comment_finished = 0
-
-######################################################################
-def set_state(s):
-    global stateStack
-    stateStack[len(stateStack)-1]=s
-
-######################################################################
-def get_state():
-    global stateStack
-    return stateStack[len(stateStack)-1]
-
-######################################################################
-def push_state(s):
-    global stateStack
-    stateStack.append(s)
-
-######################################################################
-def pop_state():
-    global stateStack
-    stateStack.pop()
-
-
-######################################################################
-def tok_eater(type, tok, spos, epos, line):
-    global stateStack,name,param,class_spos,def_spos,import_spos
-    global doc_string, modules, import_token, module_has_docstring
-    global protection_level, private_member
-    global out_row
-
-    while out_row + 1 < spos[0]:
-        output("\n", (0, 0))
-
-    rec_name_n_param(type,tok)
-    if (string.replace(string.strip(tok)," ","")=="##private:"):
-         protection_level = "private"
-         output("private:\n",spos)
-    elif (string.replace(string.strip(tok)," ","")=="##protected:"):
-         protection_level = "protected"
-         output("protected:\n",spos)
-    elif (string.replace(string.strip(tok)," ","")=="##public:"):
-         protection_level = "public"
-         output("public:\n",spos)
-    else:
-         gather_comment(type,tok,spos)
-
-    state = get_state()
-
-#    sys.stderr.write("%d: %s\n"%(state, tok))
-
-    # OUTSIDE
-    if   (state==OUTSIDE):
-        if  (tok=="class"):
-            start_recording()
-            class_spos = spos
-            push_state(BUILD_CLASS_DECL)
-        elif (tok=="def"):
-            start_recording()
-            def_spos = spos
-            push_state(BUILD_DEF_DECL)
-        elif (tok=="import") or (tok=="from"):
-            import_token = tok
-            import_spos = spos
-            modules     = []
-            push_state(IMPORT)
-        elif (spos[1] == 0 and tok[:3] == '"""'):
-            # Capture module docstring as namespace documentation
-            module_has_docstring = True
-            append_comment_lines("\\namespace %s\n" % namespace)
-            append_comment_lines(tok[3:-3])
-            print_comment(spos)
-
-    # IMPORT
-    elif (state==IMPORT):
-        if (type==token.NAME):
-            modules.append(tok)
-            set_state(IMPORT_OP)
-    # IMPORT_OP
-    elif (state==IMPORT_OP):
-        if (tok=="."):
-            set_state(IMPORT_APPEND)
-        elif (tok==","):
-            set_state(IMPORT)
-        else:
-            for m in modules:
-                output('#include "'+m.replace('.',os.path.sep)+'.py"\n',
import_spos, immediate=1)
-                if import_token=="from":
-                    output('using namespace '+m.replace('.', '::')+';\n',
import_spos)
-            pop_state()
-    # IMPORT_APPEND
-    elif (state==IMPORT_APPEND):
-        if (type==token.NAME):
-            modules[len(modules)-1]+="."+tok
-            set_state(IMPORT_OP)
-    # BUILD_CLASS_DECL
-    elif (state==BUILD_CLASS_DECL):
-        if (is_recording_finished()):
-            s = "class "+name
-            if (param!=""): s = s+" : public "+param.replace('.','::')
-            if (doc_string!=""):
-                append_comment_lines(doc_string)
-            print_comment(class_spos)
-            output(s+"\n",class_spos)
-            output("{\n",(class_spos[0]+1,class_spos[1]))
-            protection_level = "public"
-            output("  public:\n",(class_spos[0]+2,class_spos[1]))
-            set_state(BUILD_CLASS_BODY)
-    # BUILD_CLASS_BODY
-    elif (state==BUILD_CLASS_BODY):
-        if (type!=token.INDENT and type!=token.NEWLINE and type!=40 and
-            type!=tokenize.NL and type!=tokenize.COMMENT and
-            (spos[1]<=class_spos[1])):
-            output("}; // end of class\n",(out_row+1,class_spos[1]))
-            pop_state()
-        elif (tok=="def"):
-            start_recording()
-            def_spos = spos
-            push_state(BUILD_DEF_DECL)
-    # BUILD_DEF_DECL
-    elif (state==BUILD_DEF_DECL):
-        if (is_recording_finished()):
-            param = param.replace("\n", " ")
-            param = param.replace("=", " = ")
-            params = param.split(",")
-            if BUILD_CLASS_BODY in stateStack:
-                if len(name) > 1 \
-                   and name[0:2] == '__' \
-                   and name[len(name)-2:len(name)] != '__' \
-                   and protection_level != 'private':
-                       private_member = True
-                       output("  private:\n",(def_spos[0]+2,def_spos[1]))
-
-            if (doc_string != ""):
-                append_comment_lines(doc_string)
-
-            print_comment(def_spos)
-
-            output_function_decl(name, params)
-#       output("{\n",(def_spos[0]+1,def_spos[1]))
-            set_state(BUILD_DEF_BODY)
-    # BUILD_DEF_BODY
-    elif (state==BUILD_DEF_BODY):
-        if (type!=token.INDENT and type!=token.NEWLINE \
-            and type!=40 and type!=tokenize.NL \
-            and (spos[1]<=def_spos[1])):
-#            output("} // end of method/function\n",(out_row+1,def_spos[1]))
-            if private_member and protection_level != 'private':
-                private_member = False
-                output("  " + protection_level +
":\n",(def_spos[0]+2,def_spos[1]))
-            pop_state()
-#       else:
-#            output(tok,spos)
-
-
-def output_function_decl(name, params):
-    global def_spos
-
-    # Do we document a class method? then remove the 'self' parameter
-    if params[0] == 'self':
-        preamble = ''
-        params = params[1:]
-    else:
-        preamble = 'static '
-        if params[0] == 'cls':
-            params = params[1:]
-
-    param_string = string.join(params, ", Type ")
-
-    if param_string == '':
-        param_string = '(' + param_string + ');\n'
-    else:
-        param_string = '(Type ' + param_string + ');\n'
-
-    output(preamble, def_spos)
-    output(name, def_spos)
-    output(param_string, def_spos)
-
-
-def append_comment_lines(lines):
-    map(append_comment_line, doc_string.split('\n'))
-
-paramRE = re.compile(r'(@param \w+):')
-
-def append_comment_line(line):
-    global paramRE
-
-    comment_block.append(paramRE.sub(r'\1', line) + '\n')
-
-def dump(filename):
-    f = open(filename)
-    for s in r:
-        sys.stdout.write(s)
-
-def filter(filename):
-    global name, module_has_docstring, source_root
-
-    path,name = os.path.split(filename)
-    root,ext  = os.path.splitext(name)
-
-    if source_root and path.find(source_root) == 0:
-        path = path[len(source_root):]
-
-        if path[0] == os.sep:
-            path = path[1:]
-
-        ns = path.split(os.sep)
-    else:
-        ns = []
-
-    ns.append(root)
-
-    for n in ns:
-        output("namespace " + n + " {\n",(0,0))
-
-    # set module name for tok_eater to use if there's a module doc string
-    name = root
-
-#    sys.stderr.write('Filtering "'+filename+'"...')
-    f = open(filename)
-    f.close()
-    print_comment((0,0))
-
-    output("\n",(0,0))
-
-    for n in ns:
-        output("}  // end of namespace\n",(0,0))
-
-    if not module_has_docstring:
-        # Put in default namespace documentation
-        output('/** \\namespace '+root+' \n',(0,0))
-        output('    \\brief Module "%s" */\n'%(root),(0,0))
-
-    for s in outbuffer:
-        outfile.write(s)
-
-
-def filterFile(filename, out=sys.stdout):
-    global outfile
-
-    outfile = out
-
-    try:
-        root,ext  = os.path.splitext(filename)
-
-        if ext==".py":
-            filter(filename)
-        else:
-            dump(filename)
-
-#        sys.stderr.write("OK\n")
-    except IOError,e:
-        sys.stderr.write(e[1]+"\n")
-
-
-######################################################################
-
-# preparePath
-def preparePath(path):
-    """Prepare a path.
-
-    Checks if the path exists and creates it if it does not exist.
-    """
-    if not os.path.exists(path):
-        parent = os.path.dirname(path)
-        if parent!="":
-            preparePath(parent)
-        os.mkdir(path)
-
-    """Check if file1 is newer than file2.
-
-    file1 must be an existing file.
-    """
-    if not os.path.exists(file2):
-        return True
-    return os.stat(file1)[ST_MTIME]>os.stat(file2)[ST_MTIME]
-
-# convert
-def convert(srcpath, destpath):
-    """Convert a Python source tree into a C+ stub tree.
-
-    All *.py files in srcpath (including sub-directories) are filtered
-    and written to destpath. If destpath exists, only the files
-    that have been modified are filtered again. Files that were deleted
-    from srcpath are also deleted in destpath if they are still present.
-    The function returns the number of processed *.py files.
-    """
-    count=0
-    sp = os.path.join(srcpath,"*")
-    sfiles = glob.glob(sp)
-    dp = os.path.join(destpath,"*")
-    dfiles = glob.glob(dp)
-    leftovers={}
-    for df in dfiles:
-        leftovers[os.path.basename(df)]=1
-
-    for srcfile in sfiles:
-        basename = os.path.basename(srcfile)
-        if basename in leftovers:
-            del leftovers[basename]
-
-        # Is it a subdirectory?
-        if os.path.isdir(srcfile):
-            sdir = os.path.join(srcpath,basename)
-            ddir = os.path.join(destpath,basename)
-            count+=convert(sdir, ddir)
-            continue
-        # Check the extension (only *.py will be converted)
-        root, ext = os.path.splitext(srcfile)
-        if ext.lower()!=".py":
-            continue
-
-        destfile = os.path.join(destpath,basename)
-        if destfile==srcfile:
-            print "WARNING: Input and output names are identical!"
-            sys.exit(1)
-
-        count+=1
-#        sys.stdout.write("%s\015"%(srcfile))
-
-            preparePath(os.path.dirname(destfile))
-#            out=open(destfile,"w")
-#            filterFile(srcfile, out)
-#            out.close()
-            os.system("python %s -f %s>%s"%(sys.argv[0],srcfile,destfile))
-
-    # Delete obsolete files in destpath
-    for df in leftovers:
-        dname=os.path.join(destpath,df)
-        if os.path.isdir(dname):
-            try:
-                shutil.rmtree(dname)
-            except:
-                print "Can't remove obsolete directory '%s'"%dname
-        else:
-            try:
-                os.remove(dname)
-            except:
-                print "Can't remove obsolete file '%s'"%dname
-
-    return count
-
-
-######################################################################
-######################################################################
-######################################################################
-
-filter_file = False
-source_root = None
-
-try:
-    opts, args = getopt.getopt(sys.argv[1:], "hfr:", ["help"])
-except getopt.GetoptError,e:
-    print e
-    sys.exit(1)
-
-for o,a in opts:
-    if o=="-f":
-        filter_file = True
-
-    if o=="-r":
-        source_root = os.path.abspath(a)
-
-if filter_file:
-    # Filter the specified file and print the result to stdout
-    filename = string.join(args)
-    filterFile(os.path.abspath(filename))
-else:
-
-    if len(args)!=2:
-        sys.stderr.write("%s options input
output\n"%(os.path.basename(sys.argv[0])))
-        sys.exit(1)
-
-    # Filter an entire Python source tree
-    print '"%s" -> "%s"\n'%(args[0],args[1])
-    c=convert(args[0],args[1])
-    print "%d files"%(c)
-


_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxx
http://lists.xensource.com/xen-changelog

 Lists.xenproject.org is hosted with RackSpace, monitoring our servers 24x7x365 and backed by RackSpace's Fanatical Support®.