Showing preview only (784K chars total). Download the full file or copy to clipboard to get everything.
Repository: ericdegroot/gr-dsss
Branch: master
Commit: 56c0d503fc50
Files: 60
Total size: 754.7 KB
Directory structure:
gitextract_h3fhltzh/
├── .gitignore
├── CMakeLists.txt
├── README.md
├── apps/
│ └── CMakeLists.txt
├── cmake/
│ ├── Modules/
│ │ ├── CMakeParseArgumentsCopy.cmake
│ │ ├── FindCppUnit.cmake
│ │ ├── FindGnuradioRuntime.cmake
│ │ ├── GrMiscUtils.cmake
│ │ ├── GrPlatform.cmake
│ │ ├── GrPython.cmake
│ │ ├── GrSwig.cmake
│ │ ├── GrTest.cmake
│ │ └── dsssConfig.cmake
│ └── cmake_uninstall.cmake.in
├── docs/
│ ├── CMakeLists.txt
│ ├── README.dsss
│ └── doxygen/
│ ├── CMakeLists.txt
│ ├── Doxyfile.in
│ ├── Doxyfile.swig_doc.in
│ ├── doxyxml/
│ │ ├── __init__.py
│ │ ├── base.py
│ │ ├── doxyindex.py
│ │ ├── generated/
│ │ │ ├── __init__.py
│ │ │ ├── compound.py
│ │ │ ├── compoundsuper.py
│ │ │ ├── index.py
│ │ │ └── indexsuper.py
│ │ └── text.py
│ ├── other/
│ │ ├── group_defs.dox
│ │ └── main_page.dox
│ └── swig_doc.py
├── examples/
│ ├── dsss_decoder.grc
│ ├── dsss_decoder2.grc
│ ├── dsss_decoder_exp.grc
│ ├── dsss_decoder_rx.grc
│ ├── dsss_decoder_tx.grc
│ └── dsss_encoder.grc
├── grc/
│ ├── CMakeLists.txt
│ ├── dsss_dsss_decoder_cc.xml
│ └── dsss_dsss_encoder_bb.xml
├── include/
│ └── dsss/
│ ├── CMakeLists.txt
│ ├── api.h
│ ├── dsss_decoder_cc.h
│ └── dsss_encoder_bb.h
├── lib/
│ ├── CMakeLists.txt
│ ├── dsss_decoder_cc_impl.cc
│ ├── dsss_decoder_cc_impl.h
│ ├── dsss_encoder_bb_impl.cc
│ ├── dsss_encoder_bb_impl.h
│ ├── qa_dsss.cc
│ ├── qa_dsss.h
│ └── test_dsss.cc
├── python/
│ ├── CMakeLists.txt
│ ├── __init__.py
│ ├── build_utils.py
│ ├── build_utils_codes.py
│ ├── qa_dsss_decoder_cc.py
│ └── qa_dsss_encoder_bb.py
└── swig/
├── CMakeLists.txt
└── dsss_swig.i
================================================
FILE CONTENTS
================================================
================================================
FILE: .gitignore
================================================
\#*
.\#*
*~
*.pyc
build
examples/top_block.py
================================================
FILE: CMakeLists.txt
================================================
# Copyright 2011,2012 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
# GNU Radio is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# GNU Radio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Radio; see the file COPYING. If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
########################################################################
# Project setup
########################################################################
cmake_minimum_required(VERSION 2.6)
project(gr-dsss CXX C)
enable_testing()
#select the release build type by default to get optimization flags
if(NOT CMAKE_BUILD_TYPE)
set(CMAKE_BUILD_TYPE "Release")
message(STATUS "Build type not specified: defaulting to release.")
endif(NOT CMAKE_BUILD_TYPE)
set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE} CACHE STRING "")
list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/Modules)
########################################################################
# Compiler specific setup
########################################################################
if(CMAKE_COMPILER_IS_GNUCXX AND NOT WIN32)
#http://gcc.gnu.org/wiki/Visibility
add_definitions(-fvisibility=hidden)
endif()
########################################################################
# Find boost
########################################################################
if(UNIX AND EXISTS "/usr/lib64")
list(APPEND BOOST_LIBRARYDIR "/usr/lib64") #fedora 64-bit fix
endif(UNIX AND EXISTS "/usr/lib64")
set(Boost_ADDITIONAL_VERSIONS
"1.35.0" "1.35" "1.36.0" "1.36" "1.37.0" "1.37" "1.38.0" "1.38" "1.39.0" "1.39"
"1.40.0" "1.40" "1.41.0" "1.41" "1.42.0" "1.42" "1.43.0" "1.43" "1.44.0" "1.44"
"1.45.0" "1.45" "1.46.0" "1.46" "1.47.0" "1.47" "1.48.0" "1.48" "1.49.0" "1.49"
"1.50.0" "1.50" "1.51.0" "1.51" "1.52.0" "1.52" "1.53.0" "1.53" "1.54.0" "1.54"
"1.55.0" "1.55" "1.56.0" "1.56" "1.57.0" "1.57" "1.58.0" "1.58" "1.59.0" "1.59"
"1.60.0" "1.60" "1.61.0" "1.61" "1.62.0" "1.62" "1.63.0" "1.63" "1.64.0" "1.64"
"1.65.0" "1.65" "1.66.0" "1.66" "1.67.0" "1.67" "1.68.0" "1.68" "1.69.0" "1.69"
)
find_package(Boost "1.35" COMPONENTS filesystem system)
if(NOT Boost_FOUND)
message(FATAL_ERROR "Boost required to compile dsss")
endif()
########################################################################
# Install directories
########################################################################
include(GrPlatform) #define LIB_SUFFIX
set(GR_RUNTIME_DIR bin)
set(GR_LIBRARY_DIR lib${LIB_SUFFIX})
set(GR_INCLUDE_DIR include/dsss)
set(GR_DATA_DIR share)
set(GR_PKG_DATA_DIR ${GR_DATA_DIR}/${CMAKE_PROJECT_NAME})
set(GR_DOC_DIR ${GR_DATA_DIR}/doc)
set(GR_PKG_DOC_DIR ${GR_DOC_DIR}/${CMAKE_PROJECT_NAME})
set(GR_CONF_DIR etc)
set(GR_PKG_CONF_DIR ${GR_CONF_DIR}/${CMAKE_PROJECT_NAME}/conf.d)
set(GR_LIBEXEC_DIR libexec)
set(GR_PKG_LIBEXEC_DIR ${GR_LIBEXEC_DIR}/${CMAKE_PROJECT_NAME})
set(GRC_BLOCKS_DIR ${GR_PKG_DATA_DIR}/grc/blocks)
########################################################################
# Find gnuradio build dependencies
########################################################################
find_package(CppUnit)
# Search for GNU Radio and its components and versions. Add any
# components required to the list of GR_REQUIRED_COMPONENTS (in all
# caps such as FILTER or FFT) and change the version to the minimum
# API compatible version required.
set(GR_REQUIRED_COMPONENTS RUNTIME)
find_package(Gnuradio "3.7.2" REQUIRED)
if(NOT CPPUNIT_FOUND)
message(FATAL_ERROR "CppUnit required to compile dsss")
endif()
########################################################################
# Setup the include and linker paths
########################################################################
include_directories(
${CMAKE_SOURCE_DIR}/lib
${CMAKE_SOURCE_DIR}/include
${CMAKE_BINARY_DIR}/lib
${CMAKE_BINARY_DIR}/include
${Boost_INCLUDE_DIRS}
${CPPUNIT_INCLUDE_DIRS}
${GNURADIO_ALL_INCLUDE_DIRS}
)
link_directories(
${Boost_LIBRARY_DIRS}
${CPPUNIT_LIBRARY_DIRS}
${GNURADIO_RUNTIME_LIBRARY_DIRS}
)
# Set component parameters
set(GR_DSSS_INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/include CACHE INTERNAL "" FORCE)
set(GR_DSSS_SWIG_INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/swig CACHE INTERNAL "" FORCE)
########################################################################
# Create uninstall target
########################################################################
configure_file(
${CMAKE_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in
${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake
@ONLY)
add_custom_target(uninstall
${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake
)
########################################################################
# Add subdirectories
########################################################################
add_subdirectory(include/dsss)
add_subdirectory(lib)
add_subdirectory(swig)
add_subdirectory(python)
add_subdirectory(grc)
add_subdirectory(apps)
add_subdirectory(docs)
########################################################################
# Install cmake search helper for this library
########################################################################
install(FILES cmake/Modules/dsssConfig.cmake
DESTINATION lib/cmake/dsss
)
================================================
FILE: README.md
================================================
Direct Sequence Spread Spectrum blocks for GNU Radio
Note: This code is not maintained. A fork with bug fixes can be found at: https://github.com/kantooon/gr-dsss
================================================
FILE: apps/CMakeLists.txt
================================================
# Copyright 2011 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
# GNU Radio is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# GNU Radio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Radio; see the file COPYING. If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
include(GrPython)
GR_PYTHON_INSTALL(
PROGRAMS
DESTINATION bin
)
================================================
FILE: cmake/Modules/CMakeParseArgumentsCopy.cmake
================================================
# CMAKE_PARSE_ARGUMENTS(<prefix> <options> <one_value_keywords> <multi_value_keywords> args...)
#
# CMAKE_PARSE_ARGUMENTS() is intended to be used in macros or functions for
# parsing the arguments given to that macro or function.
# It processes the arguments and defines a set of variables which hold the
# values of the respective options.
#
# The <options> argument contains all options for the respective macro,
# i.e. keywords which can be used when calling the macro without any value
# following, like e.g. the OPTIONAL keyword of the install() command.
#
# The <one_value_keywords> argument contains all keywords for this macro
# which are followed by one value, like e.g. DESTINATION keyword of the
# install() command.
#
# The <multi_value_keywords> argument contains all keywords for this macro
# which can be followed by more than one value, like e.g. the TARGETS or
# FILES keywords of the install() command.
#
# When done, CMAKE_PARSE_ARGUMENTS() will have defined for each of the
# keywords listed in <options>, <one_value_keywords> and
# <multi_value_keywords> a variable composed of the given <prefix>
# followed by "_" and the name of the respective keyword.
# These variables will then hold the respective value from the argument list.
# For the <options> keywords this will be TRUE or FALSE.
#
# All remaining arguments are collected in a variable
# <prefix>_UNPARSED_ARGUMENTS, this can be checked afterwards to see whether
# your macro was called with unrecognized parameters.
#
# As an example here a my_install() macro, which takes similar arguments as the
# real install() command:
#
# function(MY_INSTALL)
# set(options OPTIONAL FAST)
# set(oneValueArgs DESTINATION RENAME)
# set(multiValueArgs TARGETS CONFIGURATIONS)
# cmake_parse_arguments(MY_INSTALL "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
# ...
#
# Assume my_install() has been called like this:
# my_install(TARGETS foo bar DESTINATION bin OPTIONAL blub)
#
# After the cmake_parse_arguments() call the macro will have set the following
# variables:
# MY_INSTALL_OPTIONAL = TRUE
# MY_INSTALL_FAST = FALSE (this option was not used when calling my_install()
# MY_INSTALL_DESTINATION = "bin"
# MY_INSTALL_RENAME = "" (was not used)
# MY_INSTALL_TARGETS = "foo;bar"
# MY_INSTALL_CONFIGURATIONS = "" (was not used)
# MY_INSTALL_UNPARSED_ARGUMENTS = "blub" (no value expected after "OPTIONAL"
#
# You can the continue and process these variables.
#
# Keywords terminate lists of values, e.g. if directly after a one_value_keyword
# another recognized keyword follows, this is interpreted as the beginning of
# the new option.
# E.g. my_install(TARGETS foo DESTINATION OPTIONAL) would result in
# MY_INSTALL_DESTINATION set to "OPTIONAL", but MY_INSTALL_DESTINATION would
# be empty and MY_INSTALL_OPTIONAL would be set to TRUE therefor.
#=============================================================================
# Copyright 2010 Alexander Neundorf <neundorf@kde.org>
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
# (To distribute this file outside of CMake, substitute the full
# License text for the above reference.)
if(__CMAKE_PARSE_ARGUMENTS_INCLUDED)
return()
endif()
set(__CMAKE_PARSE_ARGUMENTS_INCLUDED TRUE)
function(CMAKE_PARSE_ARGUMENTS prefix _optionNames _singleArgNames _multiArgNames)
# first set all result variables to empty/FALSE
foreach(arg_name ${_singleArgNames} ${_multiArgNames})
set(${prefix}_${arg_name})
endforeach(arg_name)
foreach(option ${_optionNames})
set(${prefix}_${option} FALSE)
endforeach(option)
set(${prefix}_UNPARSED_ARGUMENTS)
set(insideValues FALSE)
set(currentArgName)
# now iterate over all arguments and fill the result variables
foreach(currentArg ${ARGN})
list(FIND _optionNames "${currentArg}" optionIndex) # ... then this marks the end of the arguments belonging to this keyword
list(FIND _singleArgNames "${currentArg}" singleArgIndex) # ... then this marks the end of the arguments belonging to this keyword
list(FIND _multiArgNames "${currentArg}" multiArgIndex) # ... then this marks the end of the arguments belonging to this keyword
if(${optionIndex} EQUAL -1 AND ${singleArgIndex} EQUAL -1 AND ${multiArgIndex} EQUAL -1)
if(insideValues)
if("${insideValues}" STREQUAL "SINGLE")
set(${prefix}_${currentArgName} ${currentArg})
set(insideValues FALSE)
elseif("${insideValues}" STREQUAL "MULTI")
list(APPEND ${prefix}_${currentArgName} ${currentArg})
endif()
else(insideValues)
list(APPEND ${prefix}_UNPARSED_ARGUMENTS ${currentArg})
endif(insideValues)
else()
if(NOT ${optionIndex} EQUAL -1)
set(${prefix}_${currentArg} TRUE)
set(insideValues FALSE)
elseif(NOT ${singleArgIndex} EQUAL -1)
set(currentArgName ${currentArg})
set(${prefix}_${currentArgName})
set(insideValues "SINGLE")
elseif(NOT ${multiArgIndex} EQUAL -1)
set(currentArgName ${currentArg})
set(${prefix}_${currentArgName})
set(insideValues "MULTI")
endif()
endif()
endforeach(currentArg)
# propagate the result variables to the caller:
foreach(arg_name ${_singleArgNames} ${_multiArgNames} ${_optionNames})
set(${prefix}_${arg_name} ${${prefix}_${arg_name}} PARENT_SCOPE)
endforeach(arg_name)
set(${prefix}_UNPARSED_ARGUMENTS ${${prefix}_UNPARSED_ARGUMENTS} PARENT_SCOPE)
endfunction(CMAKE_PARSE_ARGUMENTS _options _singleArgs _multiArgs)
================================================
FILE: cmake/Modules/FindCppUnit.cmake
================================================
# http://www.cmake.org/pipermail/cmake/2006-October/011446.html
# Modified to use pkg config and use standard var names
#
# Find the CppUnit includes and library
#
# This module defines
# CPPUNIT_INCLUDE_DIR, where to find tiff.h, etc.
# CPPUNIT_LIBRARIES, the libraries to link against to use CppUnit.
# CPPUNIT_FOUND, If false, do not try to use CppUnit.
INCLUDE(FindPkgConfig)
PKG_CHECK_MODULES(PC_CPPUNIT "cppunit")
FIND_PATH(CPPUNIT_INCLUDE_DIRS
NAMES cppunit/TestCase.h
HINTS ${PC_CPPUNIT_INCLUDE_DIR}
PATHS
/usr/local/include
/usr/include
)
FIND_LIBRARY(CPPUNIT_LIBRARIES
NAMES cppunit
HINTS ${PC_CPPUNIT_LIBDIR}
PATHS
${CPPUNIT_INCLUDE_DIRS}/../lib
/usr/local/lib
/usr/lib
)
LIST(APPEND CPPUNIT_LIBRARIES ${CMAKE_DL_LIBS})
INCLUDE(FindPackageHandleStandardArgs)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(CPPUNIT DEFAULT_MSG CPPUNIT_LIBRARIES CPPUNIT_INCLUDE_DIRS)
MARK_AS_ADVANCED(CPPUNIT_LIBRARIES CPPUNIT_INCLUDE_DIRS)
================================================
FILE: cmake/Modules/FindGnuradioRuntime.cmake
================================================
INCLUDE(FindPkgConfig)
PKG_CHECK_MODULES(PC_GNURADIO_RUNTIME gnuradio-runtime)
if(PC_GNURADIO_RUNTIME_FOUND)
# look for include files
FIND_PATH(
GNURADIO_RUNTIME_INCLUDE_DIRS
NAMES gnuradio/top_block.h
HINTS $ENV{GNURADIO_RUNTIME_DIR}/include
${PC_GNURADIO_RUNTIME_INCLUDE_DIRS}
${CMAKE_INSTALL_PREFIX}/include
PATHS /usr/local/include
/usr/include
)
# look for libs
FIND_LIBRARY(
GNURADIO_RUNTIME_LIBRARIES
NAMES gnuradio-runtime
HINTS $ENV{GNURADIO_RUNTIME_DIR}/lib
${PC_GNURADIO_RUNTIME_LIBDIR}
${CMAKE_INSTALL_PREFIX}/lib/
${CMAKE_INSTALL_PREFIX}/lib64/
PATHS /usr/local/lib
/usr/local/lib64
/usr/lib
/usr/lib64
)
set(GNURADIO_RUNTIME_FOUND ${PC_GNURADIO_RUNTIME_FOUND})
endif(PC_GNURADIO_RUNTIME_FOUND)
INCLUDE(FindPackageHandleStandardArgs)
# do not check GNURADIO_RUNTIME_INCLUDE_DIRS, is not set when default include path us used.
FIND_PACKAGE_HANDLE_STANDARD_ARGS(GNURADIO_RUNTIME DEFAULT_MSG GNURADIO_RUNTIME_LIBRARIES)
MARK_AS_ADVANCED(GNURADIO_RUNTIME_LIBRARIES GNURADIO_RUNTIME_INCLUDE_DIRS)
================================================
FILE: cmake/Modules/GrMiscUtils.cmake
================================================
# Copyright 2010-2011 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
# GNU Radio is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# GNU Radio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Radio; see the file COPYING. If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
if(DEFINED __INCLUDED_GR_MISC_UTILS_CMAKE)
return()
endif()
set(__INCLUDED_GR_MISC_UTILS_CMAKE TRUE)
########################################################################
# Set global variable macro.
# Used for subdirectories to export settings.
# Example: include and library paths.
########################################################################
function(GR_SET_GLOBAL var)
set(${var} ${ARGN} CACHE INTERNAL "" FORCE)
endfunction(GR_SET_GLOBAL)
########################################################################
# Set the pre-processor definition if the condition is true.
# - def the pre-processor definition to set and condition name
########################################################################
function(GR_ADD_COND_DEF def)
if(${def})
add_definitions(-D${def})
endif(${def})
endfunction(GR_ADD_COND_DEF)
########################################################################
# Check for a header and conditionally set a compile define.
# - hdr the relative path to the header file
# - def the pre-processor definition to set
########################################################################
function(GR_CHECK_HDR_N_DEF hdr def)
include(CheckIncludeFileCXX)
CHECK_INCLUDE_FILE_CXX(${hdr} ${def})
GR_ADD_COND_DEF(${def})
endfunction(GR_CHECK_HDR_N_DEF)
########################################################################
# Include subdirectory macro.
# Sets the CMake directory variables,
# includes the subdirectory CMakeLists.txt,
# resets the CMake directory variables.
#
# This macro includes subdirectories rather than adding them
# so that the subdirectory can affect variables in the level above.
# This provides a work-around for the lack of convenience libraries.
# This way a subdirectory can append to the list of library sources.
########################################################################
macro(GR_INCLUDE_SUBDIRECTORY subdir)
#insert the current directories on the front of the list
list(INSERT _cmake_source_dirs 0 ${CMAKE_CURRENT_SOURCE_DIR})
list(INSERT _cmake_binary_dirs 0 ${CMAKE_CURRENT_BINARY_DIR})
#set the current directories to the names of the subdirs
set(CMAKE_CURRENT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/${subdir})
set(CMAKE_CURRENT_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/${subdir})
#include the subdirectory CMakeLists to run it
file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
include(${CMAKE_CURRENT_SOURCE_DIR}/CMakeLists.txt)
#reset the value of the current directories
list(GET _cmake_source_dirs 0 CMAKE_CURRENT_SOURCE_DIR)
list(GET _cmake_binary_dirs 0 CMAKE_CURRENT_BINARY_DIR)
#pop the subdir names of the front of the list
list(REMOVE_AT _cmake_source_dirs 0)
list(REMOVE_AT _cmake_binary_dirs 0)
endmacro(GR_INCLUDE_SUBDIRECTORY)
########################################################################
# Check if a compiler flag works and conditionally set a compile define.
# - flag the compiler flag to check for
# - have the variable to set with result
########################################################################
macro(GR_ADD_CXX_COMPILER_FLAG_IF_AVAILABLE flag have)
include(CheckCXXCompilerFlag)
CHECK_CXX_COMPILER_FLAG(${flag} ${have})
if(${have})
add_definitions(${flag})
endif(${have})
endmacro(GR_ADD_CXX_COMPILER_FLAG_IF_AVAILABLE)
########################################################################
# Generates the .la libtool file
# This appears to generate libtool files that cannot be used by auto*.
# Usage GR_LIBTOOL(TARGET [target] DESTINATION [dest])
# Notice: there is not COMPONENT option, these will not get distributed.
########################################################################
function(GR_LIBTOOL)
if(NOT DEFINED GENERATE_LIBTOOL)
set(GENERATE_LIBTOOL OFF) #disabled by default
endif()
if(GENERATE_LIBTOOL)
include(CMakeParseArgumentsCopy)
CMAKE_PARSE_ARGUMENTS(GR_LIBTOOL "" "TARGET;DESTINATION" "" ${ARGN})
find_program(LIBTOOL libtool)
if(LIBTOOL)
include(CMakeMacroLibtoolFile)
CREATE_LIBTOOL_FILE(${GR_LIBTOOL_TARGET} /${GR_LIBTOOL_DESTINATION})
endif(LIBTOOL)
endif(GENERATE_LIBTOOL)
endfunction(GR_LIBTOOL)
########################################################################
# Do standard things to the library target
# - set target properties
# - make install rules
# Also handle gnuradio custom naming conventions w/ extras mode.
########################################################################
function(GR_LIBRARY_FOO target)
#parse the arguments for component names
include(CMakeParseArgumentsCopy)
CMAKE_PARSE_ARGUMENTS(GR_LIBRARY "" "RUNTIME_COMPONENT;DEVEL_COMPONENT" "" ${ARGN})
#set additional target properties
set_target_properties(${target} PROPERTIES SOVERSION ${LIBVER})
#install the generated files like so...
install(TARGETS ${target}
LIBRARY DESTINATION ${GR_LIBRARY_DIR} COMPONENT ${GR_LIBRARY_RUNTIME_COMPONENT} # .so/.dylib file
ARCHIVE DESTINATION ${GR_LIBRARY_DIR} COMPONENT ${GR_LIBRARY_DEVEL_COMPONENT} # .lib file
RUNTIME DESTINATION ${GR_RUNTIME_DIR} COMPONENT ${GR_LIBRARY_RUNTIME_COMPONENT} # .dll file
)
#extras mode enabled automatically on linux
if(NOT DEFINED LIBRARY_EXTRAS)
set(LIBRARY_EXTRAS ${LINUX})
endif()
#special extras mode to enable alternative naming conventions
if(LIBRARY_EXTRAS)
#create .la file before changing props
GR_LIBTOOL(TARGET ${target} DESTINATION ${GR_LIBRARY_DIR})
#give the library a special name with ultra-zero soversion
set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_NAME ${target}-${LIBVER} SOVERSION "0.0.0")
set(target_name lib${target}-${LIBVER}.so.0.0.0)
#custom command to generate symlinks
add_custom_command(
TARGET ${target}
POST_BUILD
COMMAND ${CMAKE_COMMAND} -E create_symlink ${target_name} ${CMAKE_CURRENT_BINARY_DIR}/lib${target}.so
COMMAND ${CMAKE_COMMAND} -E create_symlink ${target_name} ${CMAKE_CURRENT_BINARY_DIR}/lib${target}-${LIBVER}.so.0
COMMAND ${CMAKE_COMMAND} -E touch ${target_name} #so the symlinks point to something valid so cmake 2.6 will install
)
#and install the extra symlinks
install(
FILES
${CMAKE_CURRENT_BINARY_DIR}/lib${target}.so
${CMAKE_CURRENT_BINARY_DIR}/lib${target}-${LIBVER}.so.0
DESTINATION ${GR_LIBRARY_DIR} COMPONENT ${GR_LIBRARY_RUNTIME_COMPONENT}
)
endif(LIBRARY_EXTRAS)
endfunction(GR_LIBRARY_FOO)
########################################################################
# Create a dummy custom command that depends on other targets.
# Usage:
# GR_GEN_TARGET_DEPS(unique_name target_deps <target1> <target2> ...)
# ADD_CUSTOM_COMMAND(<the usual args> ${target_deps})
#
# Custom command cant depend on targets, but can depend on executables,
# and executables can depend on targets. So this is the process:
########################################################################
function(GR_GEN_TARGET_DEPS name var)
file(
WRITE ${CMAKE_CURRENT_BINARY_DIR}/${name}.cpp.in
"int main(void){return 0;}\n"
)
execute_process(
COMMAND ${CMAKE_COMMAND} -E copy_if_different
${CMAKE_CURRENT_BINARY_DIR}/${name}.cpp.in
${CMAKE_CURRENT_BINARY_DIR}/${name}.cpp
)
add_executable(${name} ${CMAKE_CURRENT_BINARY_DIR}/${name}.cpp)
if(ARGN)
add_dependencies(${name} ${ARGN})
endif(ARGN)
if(CMAKE_CROSSCOMPILING)
set(${var} "DEPENDS;${name}" PARENT_SCOPE) #cant call command when cross
else()
set(${var} "DEPENDS;${name};COMMAND;${name}" PARENT_SCOPE)
endif()
endfunction(GR_GEN_TARGET_DEPS)
================================================
FILE: cmake/Modules/GrPlatform.cmake
================================================
# Copyright 2011 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
# GNU Radio is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# GNU Radio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Radio; see the file COPYING. If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
if(DEFINED __INCLUDED_GR_PLATFORM_CMAKE)
return()
endif()
set(__INCLUDED_GR_PLATFORM_CMAKE TRUE)
########################################################################
# Setup additional defines for OS types
########################################################################
if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
set(LINUX TRUE)
endif()
if(LINUX AND EXISTS "/etc/debian_version")
set(DEBIAN TRUE)
endif()
if(LINUX AND EXISTS "/etc/redhat-release")
set(REDHAT TRUE)
endif()
########################################################################
# when the library suffix should be 64 (applies to redhat linux family)
########################################################################
if(NOT DEFINED LIB_SUFFIX AND REDHAT AND CMAKE_SYSTEM_PROCESSOR MATCHES "64$")
set(LIB_SUFFIX 64)
endif()
set(LIB_SUFFIX ${LIB_SUFFIX} CACHE STRING "lib directory suffix")
================================================
FILE: cmake/Modules/GrPython.cmake
================================================
# Copyright 2010-2011 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
# GNU Radio is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# GNU Radio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Radio; see the file COPYING. If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
if(DEFINED __INCLUDED_GR_PYTHON_CMAKE)
return()
endif()
set(__INCLUDED_GR_PYTHON_CMAKE TRUE)
########################################################################
# Setup the python interpreter:
# This allows the user to specify a specific interpreter,
# or finds the interpreter via the built-in cmake module.
########################################################################
#this allows the user to override PYTHON_EXECUTABLE
if(PYTHON_EXECUTABLE)
set(PYTHONINTERP_FOUND TRUE)
#otherwise if not set, try to automatically find it
else(PYTHON_EXECUTABLE)
#use the built-in find script
find_package(PythonInterp 2)
#and if that fails use the find program routine
if(NOT PYTHONINTERP_FOUND)
find_program(PYTHON_EXECUTABLE NAMES python python2 python2.7 python2.6 python2.5)
if(PYTHON_EXECUTABLE)
set(PYTHONINTERP_FOUND TRUE)
endif(PYTHON_EXECUTABLE)
endif(NOT PYTHONINTERP_FOUND)
endif(PYTHON_EXECUTABLE)
#make the path to the executable appear in the cmake gui
set(PYTHON_EXECUTABLE ${PYTHON_EXECUTABLE} CACHE FILEPATH "python interpreter")
#make sure we can use -B with python (introduced in 2.6)
if(PYTHON_EXECUTABLE)
execute_process(
COMMAND ${PYTHON_EXECUTABLE} -B -c ""
OUTPUT_QUIET ERROR_QUIET
RESULT_VARIABLE PYTHON_HAS_DASH_B_RESULT
)
if(PYTHON_HAS_DASH_B_RESULT EQUAL 0)
set(PYTHON_DASH_B "-B")
endif()
endif(PYTHON_EXECUTABLE)
########################################################################
# Check for the existence of a python module:
# - desc a string description of the check
# - mod the name of the module to import
# - cmd an additional command to run
# - have the result variable to set
########################################################################
macro(GR_PYTHON_CHECK_MODULE desc mod cmd have)
message(STATUS "")
message(STATUS "Python checking for ${desc}")
execute_process(
COMMAND ${PYTHON_EXECUTABLE} -c "
#########################################
try: import ${mod}
except: exit(-1)
try: assert ${cmd}
except: exit(-1)
#########################################"
RESULT_VARIABLE ${have}
)
if(${have} EQUAL 0)
message(STATUS "Python checking for ${desc} - found")
set(${have} TRUE)
else(${have} EQUAL 0)
message(STATUS "Python checking for ${desc} - not found")
set(${have} FALSE)
endif(${have} EQUAL 0)
endmacro(GR_PYTHON_CHECK_MODULE)
########################################################################
# Sets the python installation directory GR_PYTHON_DIR
########################################################################
execute_process(COMMAND ${PYTHON_EXECUTABLE} -c "
from distutils import sysconfig
print sysconfig.get_python_lib(plat_specific=True, prefix='')
" OUTPUT_VARIABLE GR_PYTHON_DIR OUTPUT_STRIP_TRAILING_WHITESPACE
)
file(TO_CMAKE_PATH ${GR_PYTHON_DIR} GR_PYTHON_DIR)
########################################################################
# Create an always-built target with a unique name
# Usage: GR_UNIQUE_TARGET(<description> <dependencies list>)
########################################################################
function(GR_UNIQUE_TARGET desc)
file(RELATIVE_PATH reldir ${CMAKE_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR})
execute_process(COMMAND ${PYTHON_EXECUTABLE} -c "import re, hashlib
unique = hashlib.md5('${reldir}${ARGN}').hexdigest()[:5]
print(re.sub('\\W', '_', '${desc} ${reldir} ' + unique))"
OUTPUT_VARIABLE _target OUTPUT_STRIP_TRAILING_WHITESPACE)
add_custom_target(${_target} ALL DEPENDS ${ARGN})
endfunction(GR_UNIQUE_TARGET)
########################################################################
# Install python sources (also builds and installs byte-compiled python)
########################################################################
function(GR_PYTHON_INSTALL)
include(CMakeParseArgumentsCopy)
CMAKE_PARSE_ARGUMENTS(GR_PYTHON_INSTALL "" "DESTINATION;COMPONENT" "FILES;PROGRAMS" ${ARGN})
####################################################################
if(GR_PYTHON_INSTALL_FILES)
####################################################################
install(${ARGN}) #installs regular python files
#create a list of all generated files
unset(pysrcfiles)
unset(pycfiles)
unset(pyofiles)
foreach(pyfile ${GR_PYTHON_INSTALL_FILES})
get_filename_component(pyfile ${pyfile} ABSOLUTE)
list(APPEND pysrcfiles ${pyfile})
#determine if this file is in the source or binary directory
file(RELATIVE_PATH source_rel_path ${CMAKE_CURRENT_SOURCE_DIR} ${pyfile})
string(LENGTH "${source_rel_path}" source_rel_path_len)
file(RELATIVE_PATH binary_rel_path ${CMAKE_CURRENT_BINARY_DIR} ${pyfile})
string(LENGTH "${binary_rel_path}" binary_rel_path_len)
#and set the generated path appropriately
if(${source_rel_path_len} GREATER ${binary_rel_path_len})
set(pygenfile ${CMAKE_CURRENT_BINARY_DIR}/${binary_rel_path})
else()
set(pygenfile ${CMAKE_CURRENT_BINARY_DIR}/${source_rel_path})
endif()
list(APPEND pycfiles ${pygenfile}c)
list(APPEND pyofiles ${pygenfile}o)
#ensure generation path exists
get_filename_component(pygen_path ${pygenfile} PATH)
file(MAKE_DIRECTORY ${pygen_path})
endforeach(pyfile)
#the command to generate the pyc files
add_custom_command(
DEPENDS ${pysrcfiles} OUTPUT ${pycfiles}
COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_BINARY_DIR}/python_compile_helper.py ${pysrcfiles} ${pycfiles}
)
#the command to generate the pyo files
add_custom_command(
DEPENDS ${pysrcfiles} OUTPUT ${pyofiles}
COMMAND ${PYTHON_EXECUTABLE} -O ${CMAKE_BINARY_DIR}/python_compile_helper.py ${pysrcfiles} ${pyofiles}
)
#create install rule and add generated files to target list
set(python_install_gen_targets ${pycfiles} ${pyofiles})
install(FILES ${python_install_gen_targets}
DESTINATION ${GR_PYTHON_INSTALL_DESTINATION}
COMPONENT ${GR_PYTHON_INSTALL_COMPONENT}
)
####################################################################
elseif(GR_PYTHON_INSTALL_PROGRAMS)
####################################################################
file(TO_NATIVE_PATH ${PYTHON_EXECUTABLE} pyexe_native)
foreach(pyfile ${GR_PYTHON_INSTALL_PROGRAMS})
get_filename_component(pyfile_name ${pyfile} NAME)
get_filename_component(pyfile ${pyfile} ABSOLUTE)
string(REPLACE "${CMAKE_SOURCE_DIR}" "${CMAKE_BINARY_DIR}" pyexefile "${pyfile}.exe")
list(APPEND python_install_gen_targets ${pyexefile})
get_filename_component(pyexefile_path ${pyexefile} PATH)
file(MAKE_DIRECTORY ${pyexefile_path})
add_custom_command(
OUTPUT ${pyexefile} DEPENDS ${pyfile}
COMMAND ${PYTHON_EXECUTABLE} -c
\"open('${pyexefile}', 'w').write('\#!${pyexe_native}\\n'+open('${pyfile}').read())\"
COMMENT "Shebangin ${pyfile_name}"
)
#on windows, python files need an extension to execute
get_filename_component(pyfile_ext ${pyfile} EXT)
if(WIN32 AND NOT pyfile_ext)
set(pyfile_name "${pyfile_name}.py")
endif()
install(PROGRAMS ${pyexefile} RENAME ${pyfile_name}
DESTINATION ${GR_PYTHON_INSTALL_DESTINATION}
COMPONENT ${GR_PYTHON_INSTALL_COMPONENT}
)
endforeach(pyfile)
endif()
GR_UNIQUE_TARGET("pygen" ${python_install_gen_targets})
endfunction(GR_PYTHON_INSTALL)
########################################################################
# Write the python helper script that generates byte code files
########################################################################
file(WRITE ${CMAKE_BINARY_DIR}/python_compile_helper.py "
import sys, py_compile
files = sys.argv[1:]
srcs, gens = files[:len(files)/2], files[len(files)/2:]
for src, gen in zip(srcs, gens):
py_compile.compile(file=src, cfile=gen, doraise=True)
")
================================================
FILE: cmake/Modules/GrSwig.cmake
================================================
# Copyright 2010-2011 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
# GNU Radio is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# GNU Radio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Radio; see the file COPYING. If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
if(DEFINED __INCLUDED_GR_SWIG_CMAKE)
return()
endif()
set(__INCLUDED_GR_SWIG_CMAKE TRUE)
include(GrPython)
########################################################################
# Builds a swig documentation file to be generated into python docstrings
# Usage: GR_SWIG_MAKE_DOCS(output_file input_path input_path....)
#
# Set the following variable to specify extra dependent targets:
# - GR_SWIG_DOCS_SOURCE_DEPS
# - GR_SWIG_DOCS_TARGET_DEPS
########################################################################
function(GR_SWIG_MAKE_DOCS output_file)
find_package(Doxygen)
if(DOXYGEN_FOUND)
#setup the input files variable list, quote formated
set(input_files)
unset(INPUT_PATHS)
foreach(input_path ${ARGN})
if (IS_DIRECTORY ${input_path}) #when input path is a directory
file(GLOB input_path_h_files ${input_path}/*.h)
else() #otherwise its just a file, no glob
set(input_path_h_files ${input_path})
endif()
list(APPEND input_files ${input_path_h_files})
set(INPUT_PATHS "${INPUT_PATHS} \"${input_path}\"")
endforeach(input_path)
#determine the output directory
get_filename_component(name ${output_file} NAME_WE)
get_filename_component(OUTPUT_DIRECTORY ${output_file} PATH)
set(OUTPUT_DIRECTORY ${OUTPUT_DIRECTORY}/${name}_swig_docs)
make_directory(${OUTPUT_DIRECTORY})
#generate the Doxyfile used by doxygen
configure_file(
${CMAKE_SOURCE_DIR}/docs/doxygen/Doxyfile.swig_doc.in
${OUTPUT_DIRECTORY}/Doxyfile
@ONLY)
#Create a dummy custom command that depends on other targets
include(GrMiscUtils)
GR_GEN_TARGET_DEPS(_${name}_tag tag_deps ${GR_SWIG_DOCS_TARGET_DEPS})
#call doxygen on the Doxyfile + input headers
add_custom_command(
OUTPUT ${OUTPUT_DIRECTORY}/xml/index.xml
DEPENDS ${input_files} ${GR_SWIG_DOCS_SOURCE_DEPS} ${tag_deps}
COMMAND ${DOXYGEN_EXECUTABLE} ${OUTPUT_DIRECTORY}/Doxyfile
COMMENT "Generating doxygen xml for ${name} docs"
)
#call the swig_doc script on the xml files
add_custom_command(
OUTPUT ${output_file}
DEPENDS ${input_files} ${OUTPUT_DIRECTORY}/xml/index.xml
COMMAND ${PYTHON_EXECUTABLE} ${PYTHON_DASH_B}
${CMAKE_SOURCE_DIR}/docs/doxygen/swig_doc.py
${OUTPUT_DIRECTORY}/xml
${output_file}
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/docs/doxygen
)
else(DOXYGEN_FOUND)
file(WRITE ${output_file} "\n") #no doxygen -> empty file
endif(DOXYGEN_FOUND)
endfunction(GR_SWIG_MAKE_DOCS)
########################################################################
# Build a swig target for the common gnuradio use case. Usage:
# GR_SWIG_MAKE(target ifile ifile ifile...)
#
# Set the following variables before calling:
# - GR_SWIG_FLAGS
# - GR_SWIG_INCLUDE_DIRS
# - GR_SWIG_LIBRARIES
# - GR_SWIG_SOURCE_DEPS
# - GR_SWIG_TARGET_DEPS
# - GR_SWIG_DOC_FILE
# - GR_SWIG_DOC_DIRS
########################################################################
macro(GR_SWIG_MAKE name)
set(ifiles ${ARGN})
#do swig doc generation if specified
if (GR_SWIG_DOC_FILE)
set(GR_SWIG_DOCS_SOURCE_DEPS ${GR_SWIG_SOURCE_DEPS})
set(GR_SWIG_DOCS_TAREGT_DEPS ${GR_SWIG_TARGET_DEPS})
GR_SWIG_MAKE_DOCS(${GR_SWIG_DOC_FILE} ${GR_SWIG_DOC_DIRS})
list(APPEND GR_SWIG_SOURCE_DEPS ${GR_SWIG_DOC_FILE})
endif()
#append additional include directories
find_package(PythonLibs 2)
list(APPEND GR_SWIG_INCLUDE_DIRS ${PYTHON_INCLUDE_PATH}) #deprecated name (now dirs)
list(APPEND GR_SWIG_INCLUDE_DIRS ${PYTHON_INCLUDE_DIRS})
list(APPEND GR_SWIG_INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR})
list(APPEND GR_SWIG_INCLUDE_DIRS ${CMAKE_CURRENT_BINARY_DIR})
#determine include dependencies for swig file
execute_process(
COMMAND ${PYTHON_EXECUTABLE}
${CMAKE_BINARY_DIR}/get_swig_deps.py
"${ifiles}" "${GR_SWIG_INCLUDE_DIRS}"
OUTPUT_STRIP_TRAILING_WHITESPACE
OUTPUT_VARIABLE SWIG_MODULE_${name}_EXTRA_DEPS
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)
#Create a dummy custom command that depends on other targets
include(GrMiscUtils)
GR_GEN_TARGET_DEPS(_${name}_swig_tag tag_deps ${GR_SWIG_TARGET_DEPS})
set(tag_file ${CMAKE_CURRENT_BINARY_DIR}/${name}.tag)
add_custom_command(
OUTPUT ${tag_file}
DEPENDS ${GR_SWIG_SOURCE_DEPS} ${tag_deps}
COMMAND ${CMAKE_COMMAND} -E touch ${tag_file}
)
#append the specified include directories
include_directories(${GR_SWIG_INCLUDE_DIRS})
list(APPEND SWIG_MODULE_${name}_EXTRA_DEPS ${tag_file})
#setup the swig flags with flags and include directories
set(CMAKE_SWIG_FLAGS -fvirtual -modern -keyword -w511 -module ${name} ${GR_SWIG_FLAGS})
foreach(dir ${GR_SWIG_INCLUDE_DIRS})
list(APPEND CMAKE_SWIG_FLAGS "-I${dir}")
endforeach(dir)
#set the C++ property on the swig .i file so it builds
set_source_files_properties(${ifiles} PROPERTIES CPLUSPLUS ON)
#setup the actual swig library target to be built
include(UseSWIG)
SWIG_ADD_MODULE(${name} python ${ifiles})
SWIG_LINK_LIBRARIES(${name} ${PYTHON_LIBRARIES} ${GR_SWIG_LIBRARIES})
endmacro(GR_SWIG_MAKE)
########################################################################
# Install swig targets generated by GR_SWIG_MAKE. Usage:
# GR_SWIG_INSTALL(
# TARGETS target target target...
# [DESTINATION destination]
# [COMPONENT component]
# )
########################################################################
macro(GR_SWIG_INSTALL)
include(CMakeParseArgumentsCopy)
CMAKE_PARSE_ARGUMENTS(GR_SWIG_INSTALL "" "DESTINATION;COMPONENT" "TARGETS" ${ARGN})
foreach(name ${GR_SWIG_INSTALL_TARGETS})
install(TARGETS ${SWIG_MODULE_${name}_REAL_NAME}
DESTINATION ${GR_SWIG_INSTALL_DESTINATION}
COMPONENT ${GR_SWIG_INSTALL_COMPONENT}
)
include(GrPython)
GR_PYTHON_INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/${name}.py
DESTINATION ${GR_SWIG_INSTALL_DESTINATION}
COMPONENT ${GR_SWIG_INSTALL_COMPONENT}
)
GR_LIBTOOL(
TARGET ${SWIG_MODULE_${name}_REAL_NAME}
DESTINATION ${GR_SWIG_INSTALL_DESTINATION}
)
endforeach(name)
endmacro(GR_SWIG_INSTALL)
########################################################################
# Generate a python file that can determine swig dependencies.
# Used by the make macro above to determine extra dependencies.
# When you build C++, CMake figures out the header dependencies.
# This code essentially performs that logic for swig includes.
########################################################################
file(WRITE ${CMAKE_BINARY_DIR}/get_swig_deps.py "
import os, sys, re
include_matcher = re.compile('[#|%]include\\s*[<|\"](.*)[>|\"]')
include_dirs = sys.argv[2].split(';')
def get_swig_incs(file_path):
file_contents = open(file_path, 'r').read()
return include_matcher.findall(file_contents, re.MULTILINE)
def get_swig_deps(file_path, level):
deps = [file_path]
if level == 0: return deps
for inc_file in get_swig_incs(file_path):
for inc_dir in include_dirs:
inc_path = os.path.join(inc_dir, inc_file)
if not os.path.exists(inc_path): continue
deps.extend(get_swig_deps(inc_path, level-1))
return deps
if __name__ == '__main__':
ifiles = sys.argv[1].split(';')
deps = sum([get_swig_deps(ifile, 3) for ifile in ifiles], [])
#sys.stderr.write(';'.join(set(deps)) + '\\n\\n')
print(';'.join(set(deps)))
")
================================================
FILE: cmake/Modules/GrTest.cmake
================================================
# Copyright 2010-2011 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
# GNU Radio is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# GNU Radio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Radio; see the file COPYING. If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
if(DEFINED __INCLUDED_GR_TEST_CMAKE)
return()
endif()
set(__INCLUDED_GR_TEST_CMAKE TRUE)
########################################################################
# Add a unit test and setup the environment for a unit test.
# Takes the same arguments as the ADD_TEST function.
#
# Before calling set the following variables:
# GR_TEST_TARGET_DEPS - built targets for the library path
# GR_TEST_LIBRARY_DIRS - directories for the library path
# GR_TEST_PYTHON_DIRS - directories for the python path
########################################################################
function(GR_ADD_TEST test_name)
if(WIN32)
#Ensure that the build exe also appears in the PATH.
list(APPEND GR_TEST_TARGET_DEPS ${ARGN})
#In the land of windows, all libraries must be in the PATH.
#Since the dependent libraries are not yet installed,
#we must manually set them in the PATH to run tests.
#The following appends the path of a target dependency.
foreach(target ${GR_TEST_TARGET_DEPS})
get_target_property(location ${target} LOCATION)
if(location)
get_filename_component(path ${location} PATH)
string(REGEX REPLACE "\\$\\(.*\\)" ${CMAKE_BUILD_TYPE} path ${path})
list(APPEND GR_TEST_LIBRARY_DIRS ${path})
endif(location)
endforeach(target)
#SWIG generates the python library files into a subdirectory.
#Therefore, we must append this subdirectory into PYTHONPATH.
#Only do this for the python directories matching the following:
foreach(pydir ${GR_TEST_PYTHON_DIRS})
get_filename_component(name ${pydir} NAME)
if(name MATCHES "^(swig|lib|src)$")
list(APPEND GR_TEST_PYTHON_DIRS ${pydir}/${CMAKE_BUILD_TYPE})
endif()
endforeach(pydir)
endif(WIN32)
file(TO_NATIVE_PATH ${CMAKE_CURRENT_SOURCE_DIR} srcdir)
file(TO_NATIVE_PATH "${GR_TEST_LIBRARY_DIRS}" libpath) #ok to use on dir list?
file(TO_NATIVE_PATH "${GR_TEST_PYTHON_DIRS}" pypath) #ok to use on dir list?
set(environs "GR_DONT_LOAD_PREFS=1" "srcdir=${srcdir}")
#http://www.cmake.org/pipermail/cmake/2009-May/029464.html
#Replaced this add test + set environs code with the shell script generation.
#Its nicer to be able to manually run the shell script to diagnose problems.
#ADD_TEST(${ARGV})
#SET_TESTS_PROPERTIES(${test_name} PROPERTIES ENVIRONMENT "${environs}")
if(UNIX)
set(binpath "${CMAKE_CURRENT_BINARY_DIR}:$PATH")
#set both LD and DYLD paths to cover multiple UNIX OS library paths
list(APPEND libpath "$LD_LIBRARY_PATH" "$DYLD_LIBRARY_PATH")
list(APPEND pypath "$PYTHONPATH")
#replace list separator with the path separator
string(REPLACE ";" ":" libpath "${libpath}")
string(REPLACE ";" ":" pypath "${pypath}")
list(APPEND environs "PATH=${binpath}" "LD_LIBRARY_PATH=${libpath}" "DYLD_LIBRARY_PATH=${libpath}" "PYTHONPATH=${pypath}")
#generate a bat file that sets the environment and runs the test
find_program(SHELL sh)
set(sh_file ${CMAKE_CURRENT_BINARY_DIR}/${test_name}_test.sh)
file(WRITE ${sh_file} "#!${SHELL}\n")
#each line sets an environment variable
foreach(environ ${environs})
file(APPEND ${sh_file} "export ${environ}\n")
endforeach(environ)
#load the command to run with its arguments
foreach(arg ${ARGN})
file(APPEND ${sh_file} "${arg} ")
endforeach(arg)
file(APPEND ${sh_file} "\n")
#make the shell file executable
execute_process(COMMAND chmod +x ${sh_file})
add_test(${test_name} ${SHELL} ${sh_file})
endif(UNIX)
if(WIN32)
list(APPEND libpath ${DLL_PATHS} "%PATH%")
list(APPEND pypath "%PYTHONPATH%")
#replace list separator with the path separator (escaped)
string(REPLACE ";" "\\;" libpath "${libpath}")
string(REPLACE ";" "\\;" pypath "${pypath}")
list(APPEND environs "PATH=${libpath}" "PYTHONPATH=${pypath}")
#generate a bat file that sets the environment and runs the test
set(bat_file ${CMAKE_CURRENT_BINARY_DIR}/${test_name}_test.bat)
file(WRITE ${bat_file} "@echo off\n")
#each line sets an environment variable
foreach(environ ${environs})
file(APPEND ${bat_file} "SET ${environ}\n")
endforeach(environ)
#load the command to run with its arguments
foreach(arg ${ARGN})
file(APPEND ${bat_file} "${arg} ")
endforeach(arg)
file(APPEND ${bat_file} "\n")
add_test(${test_name} ${bat_file})
endif(WIN32)
endfunction(GR_ADD_TEST)
================================================
FILE: cmake/Modules/dsssConfig.cmake
================================================
INCLUDE(FindPkgConfig)
PKG_CHECK_MODULES(PC_DSSS dsss)
FIND_PATH(
DSSS_INCLUDE_DIRS
NAMES dsss/api.h
HINTS $ENV{DSSS_DIR}/include
${PC_DSSS_INCLUDEDIR}
PATHS ${CMAKE_INSTALL_PREFIX}/include
/usr/local/include
/usr/include
)
FIND_LIBRARY(
DSSS_LIBRARIES
NAMES gnuradio-dsss
HINTS $ENV{DSSS_DIR}/lib
${PC_DSSS_LIBDIR}
PATHS ${CMAKE_INSTALL_PREFIX}/lib
${CMAKE_INSTALL_PREFIX}/lib64
/usr/local/lib
/usr/local/lib64
/usr/lib
/usr/lib64
)
INCLUDE(FindPackageHandleStandardArgs)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(DSSS DEFAULT_MSG DSSS_LIBRARIES DSSS_INCLUDE_DIRS)
MARK_AS_ADVANCED(DSSS_LIBRARIES DSSS_INCLUDE_DIRS)
================================================
FILE: cmake/cmake_uninstall.cmake.in
================================================
# http://www.vtk.org/Wiki/CMake_FAQ#Can_I_do_.22make_uninstall.22_with_CMake.3F
IF(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt")
MESSAGE(FATAL_ERROR "Cannot find install manifest: \"@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt\"")
ENDIF(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt")
FILE(READ "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt" files)
STRING(REGEX REPLACE "\n" ";" files "${files}")
FOREACH(file ${files})
MESSAGE(STATUS "Uninstalling \"$ENV{DESTDIR}${file}\"")
IF(EXISTS "$ENV{DESTDIR}${file}")
EXEC_PROGRAM(
"@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\""
OUTPUT_VARIABLE rm_out
RETURN_VALUE rm_retval
)
IF(NOT "${rm_retval}" STREQUAL 0)
MESSAGE(FATAL_ERROR "Problem when removing \"$ENV{DESTDIR}${file}\"")
ENDIF(NOT "${rm_retval}" STREQUAL 0)
ELSEIF(IS_SYMLINK "$ENV{DESTDIR}${file}")
EXEC_PROGRAM(
"@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\""
OUTPUT_VARIABLE rm_out
RETURN_VALUE rm_retval
)
IF(NOT "${rm_retval}" STREQUAL 0)
MESSAGE(FATAL_ERROR "Problem when removing \"$ENV{DESTDIR}${file}\"")
ENDIF(NOT "${rm_retval}" STREQUAL 0)
ELSE(EXISTS "$ENV{DESTDIR}${file}")
MESSAGE(STATUS "File \"$ENV{DESTDIR}${file}\" does not exist.")
ENDIF(EXISTS "$ENV{DESTDIR}${file}")
ENDFOREACH(file)
================================================
FILE: docs/CMakeLists.txt
================================================
# Copyright 2011 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
# GNU Radio is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# GNU Radio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Radio; see the file COPYING. If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
########################################################################
# Setup dependencies
########################################################################
find_package(Doxygen)
########################################################################
# Begin conditional configuration
########################################################################
if(ENABLE_DOXYGEN)
########################################################################
# Add subdirectories
########################################################################
add_subdirectory(doxygen)
endif(ENABLE_DOXYGEN)
================================================
FILE: docs/README.dsss
================================================
This is the dsss-write-a-block package meant as a guide to building
out-of-tree packages. To use the dsss blocks, the Python namespaces
is in 'dsss', which is imported as:
import dsss
See the Doxygen documentation for details about the blocks available
in this package. A quick listing of the details can be found in Python
after importing by using:
help(dsss)
================================================
FILE: docs/doxygen/CMakeLists.txt
================================================
# Copyright 2011 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
# GNU Radio is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# GNU Radio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Radio; see the file COPYING. If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
########################################################################
# Create the doxygen configuration file
########################################################################
file(TO_NATIVE_PATH ${CMAKE_SOURCE_DIR} top_srcdir)
file(TO_NATIVE_PATH ${CMAKE_BINARY_DIR} top_builddir)
file(TO_NATIVE_PATH ${CMAKE_SOURCE_DIR} abs_top_srcdir)
file(TO_NATIVE_PATH ${CMAKE_BINARY_DIR} abs_top_builddir)
set(HAVE_DOT ${DOXYGEN_DOT_FOUND})
set(enable_html_docs YES)
set(enable_latex_docs NO)
set(enable_xml_docs YES)
configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
@ONLY)
set(BUILT_DIRS ${CMAKE_CURRENT_BINARY_DIR}/xml ${CMAKE_CURRENT_BINARY_DIR}/html)
########################################################################
# Make and install doxygen docs
########################################################################
add_custom_command(
OUTPUT ${BUILT_DIRS}
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating documentation with doxygen"
)
add_custom_target(doxygen_target ALL DEPENDS ${BUILT_DIRS})
install(DIRECTORY ${BUILT_DIRS} DESTINATION ${GR_PKG_DOC_DIR})
================================================
FILE: docs/doxygen/Doxyfile.in
================================================
# Doxyfile 1.5.7.1
# 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
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
# http://www.gnu.org/software/libiconv for the list of possible encodings.
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
PROJECT_NAME = "GNU Radio's DSSS Package"
# 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 =
# 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:
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
# Spanish, Swedish, and Ukrainian.
OUTPUT_LANGUAGE = English
# 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 = YES
# 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 = NO
# 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 regular Qt-style comments
# (thus requiring an explicit @brief command for a brief description.)
JAVADOC_AUTOBRIEF = NO
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
# comment as the brief description. If set to NO, the comments
# will behave just like regular Qt-style comments (thus requiring
# an explicit \brief command for a brief description.)
QT_AUTOBRIEF = NO
# 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 = 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 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 = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for
# Fortran.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
# VHDL.
OPTIMIZE_OUTPUT_VHDL = NO
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should
# set this tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
# func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
BUILTIN_STL_SUPPORT = YES
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
# Doxygen will parse them like normal C++ but will assume all classes use public
# instead of private inheritance when no explicit protection keyword is present.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate getter
# and setter methods for a property. Setting this option to YES (the default)
# will make doxygen to replace the get and set methods by a property in the
# documentation. This will only work if the methods are indeed getting or
# setting a simple type. If this is not the case, or you want to show the
# methods anyway, you should set this option to NO.
IDL_PROPERTY_SUPPORT = 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
# 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
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
# is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically
# be useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
TYPEDEF_HIDES_STRUCT = NO
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
# determine which symbols to keep in memory and which to flush to disk.
# When the cache is full, less often used symbols will be written to disk.
# For small to medium size projects (<1000 input files) the default value is
# probably good enough. For larger projects a too small cache size can cause
# doxygen to be busy swapping symbols to and from disk most of the time
# causing a significant performance penality.
# If the system has enough physical memory increasing the cache will improve the
# performance by keeping more symbols in memory. Note that the value works on
# a logarithmic scale so increasing the size by one will rougly double the
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols
SYMBOL_CACHE_SIZE = 4
#---------------------------------------------------------------------------
# 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 = NO
# 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 this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base
# name of the file that contains the anonymous namespace. By default
# anonymous namespace are hidden.
EXTRACT_ANON_NSPACES = 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_GROUP_NAMES tag is set to YES then doxygen will sort the
# hierarchy of group names into alphabetical order. If set to NO (the default)
# the group names will appear in their defined order.
SORT_GROUP_NAMES = 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 = NO
# 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 = NO
# 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 = NO
# 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= NO
# 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. The default is NO.
SHOW_DIRECTORIES = NO
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
# Namespaces page. This will remove the Namespaces entry from the Quick Index
# and from the Folder Tree View (if specified). The default is YES.
SHOW_NAMESPACES = NO
# 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 program writes to standard output
# is used as the file version. See the manual for examples.
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
# doxygen. The layout file controls the global structure of the generated output files
# in an output format independent way. The create the layout file that represents
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
# of the layout file.
LAYOUT_FILE =
#---------------------------------------------------------------------------
# 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 = @top_srcdir@ @top_builddir@
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
# also the default input encoding. Doxygen uses libiconv (or the iconv built
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
# the list of possible encodings.
INPUT_ENCODING = UTF-8
# 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 *.py *.f90
FILE_PATTERNS = *.h \
*.dox
# 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 = @abs_top_builddir@/docs/doxygen/html \
@abs_top_builddir@/docs/doxygen/xml \
@abs_top_builddir@/docs/doxygen/other/doxypy.py \
@abs_top_builddir@/_CPack_Packages \
@abs_top_srcdir@/cmake
# 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. Note that the wildcards are matched
# against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/*
EXCLUDE_PATTERNS = */.deps/* \
*/.libs/* \
*/.svn/* \
*/CVS/* \
*/__init__.py \
*/qa_*.cc \
*/qa_*.h \
*/qa_*.py
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
EXCLUDE_SYMBOLS = ad9862 \
numpy \
*swig* \
*Swig* \
*my_top_block* \
*my_graph* \
*app_top_block* \
*am_rx_graph* \
*_queue_watcher_thread* \
*parse* \
*MyFrame* \
*MyApp* \
*PyObject* \
*wfm_rx_block* \
*_sptr* \
*debug* \
*wfm_rx_sca_block* \
*tv_rx_block* \
*wxapt_rx_block* \
*example_signal*
# 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 =
# 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 = *.py=@top_srcdir@/doc/doxygen/other/doxypy.py
# 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 = NO
#---------------------------------------------------------------------------
# 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 = NO
# If the REFERENCED_BY_RELATION tag is set to YES
# 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
# then for each documented function all documented entities
# called/used by that function will be listed.
REFERENCES_RELATION = YES
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
# link to the source code. Otherwise they will link to the documentstion.
REFERENCES_LINK_SOURCE = YES
# If the USE_HTAGS tag is set to YES then the references to source code
# will point to the HTML generated by the htags(1) tool instead of doxygen
# built-in source browser. The htags tool is part of GNU's global source
# tagging system (see http://www.gnu.org/software/global/global.html). You
# will need version 4.8.6 or higher.
USE_HTAGS = NO
# 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 = YES
# 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 = @enable_html_docs@
# 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 HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
HTML_DYNAMIC_SECTIONS = NO
# If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3
# integrated development environment, introduced with OSX 10.5 (Leopard).
# To create a documentation set, doxygen will generate a Makefile in the
# HTML output directory. Running make will produce the docset in that
# directory and running "make install" will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# it at startup.
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
GENERATE_DOCSET = NO
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
# feed. A documentation feed provides an umbrella under which multiple
# documentation sets from a single provider (such as a company or product suite)
# can be grouped.
DOCSET_FEEDNAME = "Doxygen generated docs"
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
# should uniquely identify the documentation set bundle. This should be a
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
# will append .docset to the name.
DOCSET_BUNDLE_ID = org.doxygen.Project
# 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 compiled 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 CHM_INDEX_ENCODING
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
# content.
CHM_INDEX_ENCODING =
# 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 = YES
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
# are set, an additional index file will be generated that can be used as input for
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
# HTML documentation.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
# The path specified is relative to the HTML output folder.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.
QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.
QHP_VIRTUAL_FOLDER = doc
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
# be used to specify the location of Qt's qhelpgenerator.
# If non-empty doxygen will try to run qhelpgenerator on the generated
# .qhp file .
QHG_LOCATION =
# 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 = YES
# 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
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information.
# If the tag value is set to FRAME, 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. Other possible values
# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list;
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
# disables this behavior completely. For backwards compatibility with previous
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
# respectively.
GENERATE_TREEVIEW = YES
# 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 = 180
# Use this tag to change the font size of Latex formulas included
# as images in the HTML documentation. The default is 10. Note that
# when you change the font size after a successful doxygen run you need
# to manually remove any form_*.png images from the HTML output directory
# to force them to be regenerated.
FORMULA_FONTSIZE = 10
#---------------------------------------------------------------------------
# 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 = @enable_latex_docs@
# 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 = letter
# 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 = NO
# 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 = @enable_xml_docs@
# 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 = NO
#---------------------------------------------------------------------------
# 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_DEFINED 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
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# 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 = @HAVE_DOT@
# By default doxygen will write a font called FreeSans.ttf to the output
# directory and reference it in all dot files that doxygen generates. This
# font does not include all possible unicode characters however, so when you need
# these (or just want a differently looking font) you can specify the font name
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
# which can be done by putting it in a standard location or by setting the
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
# containing the font.
DOT_FONTNAME = FreeSans
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
# The default size is 10pt.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the output directory to look for the
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
# different font using DOT_FONTNAME you can set the path where dot
# can find it using this tag.
DOT_FONTPATH =
# 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 = NO
# 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 options 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 CALLER_GRAPH and HAVE_DOT tags are set to YES then
# doxygen will generate a caller 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 caller
# graphs for selected functions only using the \callergraph command.
CALLER_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 DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
# nodes that will be shown in the graph. If the number of nodes in a graph
# becomes larger than this value, doxygen will truncate the graph, which is
# visualized by representing a node as a red box. Note that doxygen if the
# number of direct children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
DOT_GRAPH_MAX_NODES = 50
# 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 the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not
# seem to support this out of the box. 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 = YES
# 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
================================================
FILE: docs/doxygen/Doxyfile.swig_doc.in
================================================
# Doxyfile 1.6.1
# 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
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
# http://www.gnu.org/software/libiconv for the list of possible encodings.
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
PROJECT_NAME = @CPACK_PACKAGE_NAME@
# 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 = @CPACK_PACKAGE_VERSION@
# 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 = @OUTPUT_DIRECTORY@
# 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:
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
OUTPUT_LANGUAGE = English
# 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 regular Qt-style comments
# (thus requiring an explicit @brief command for a brief description.)
JAVADOC_AUTOBRIEF = NO
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
# comment as the brief description. If set to NO, the comments
# will behave just like regular Qt-style comments (thus requiring
# an explicit \brief command for a brief description.)
QT_AUTOBRIEF = NO
# 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 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 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 = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for
# Fortran.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
# VHDL.
OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the files it parses.
# With this tag you can assign which parser to use for a given extension.
# Doxygen has a built-in mapping, but you can override or extend it using this tag.
# The format is ext=language, where ext is a file extension, and language is one of
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
EXTENSION_MAPPING =
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should
# set this tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
# func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
BUILTIN_STL_SUPPORT = YES
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
# Doxygen will parse them like normal C++ but will assume all classes use public
# instead of private inheritance when no explicit protection keyword is present.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate getter
# and setter methods for a property. Setting this option to YES (the default)
# will make doxygen to replace the get and set methods by a property in the
# documentation. This will only work if the methods are indeed getting or
# setting a simple type. If this is not the case, or you want to show the
# methods anyway, you should set this option to NO.
IDL_PROPERTY_SUPPORT = 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
# 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
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
# is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically
# be useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
TYPEDEF_HIDES_STRUCT = NO
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
# determine which symbols to keep in memory and which to flush to disk.
# When the cache is full, less often used symbols will be written to disk.
# For small to medium size projects (<1000 input files) the default value is
# probably good enough. For larger projects a too small cache size can cause
# doxygen to be busy swapping symbols to and from disk most of the time
# causing a significant performance penality.
# If the system has enough physical memory increasing the cache will improve the
# performance by keeping more symbols in memory. Note that the value works on
# a logarithmic scale so increasing the size by one will rougly double the
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols
SYMBOL_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# 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 = NO
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
EXTRACT_STATIC = NO
# 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 this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base
# name of the file that contains the anonymous namespace. By default
# anonymous namespace are hidden.
EXTRACT_ANON_NSPACES = 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_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
# hierarchy of group names into alphabetical order. If set to NO (the default)
# the group names will appear in their defined order.
SORT_GROUP_NAMES = 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. The default is NO.
SHOW_DIRECTORIES = NO
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
# Namespaces page.
# This will remove the Namespaces entry from the Quick Index
# and from the Folder Tree View (if specified). The default is YES.
SHOW_NAMESPACES = 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 program writes to standard output
# is used as the file version. See the manual for examples.
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
# doxygen. The layout file controls the global structure of the generated output files
# in an output format independent way. The create the layout file that represents
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
# of the layout file.
LAYOUT_FILE =
#---------------------------------------------------------------------------
# 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 = @INPUT_PATHS@
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
# also the default input encoding. Doxygen uses libiconv (or the iconv built
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
# the list of possible encodings.
INPUT_ENCODING = UTF-8
# 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 *.py *.f90
FILE_PATTERNS = *.h
# 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. Note that the wildcards are matched
# against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/*
EXCLUDE_PATTERNS =
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
EXCLUDE_SYMBOLS =
# 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 =
# 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 = NO
#---------------------------------------------------------------------------
# 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
# then for each documented function all documented
# functions referencing it will be listed.
REFERENCED_BY_RELATION = NO
# If the REFERENCES_RELATION tag is set to YES
# then for each documented function all documented entities
# called/used by that function will be listed.
REFERENCES_RELATION = NO
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
# link to the source code.
# Otherwise they will link to the documentation.
REFERENCES_LINK_SOURCE = YES
# If the USE_HTAGS tag is set to YES then the references to source code
# will point to the HTML generated by the htags(1) tool instead of doxygen
# built-in source browser. The htags tool is part of GNU's global source
# tagging system (see http://www.gnu.org/software/global/global.html). You
# will need version 4.8.6 or higher.
USE_HTAGS = NO
# 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 = NO
# 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 HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
HTML_DYNAMIC_SECTIONS = NO
# If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3
# integrated development environment, introduced with OSX 10.5 (Leopard).
# To create a documentation set, doxygen will generate a Makefile in the
# HTML output directory. Running make will produce the docset in that
# directory and running "make install" will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# it at startup.
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
GENERATE_DOCSET = NO
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
# feed. A documentation feed provides an umbrella under which multiple
# documentation sets from a single provider (such as a company or product suite)
# can be grouped.
DOCSET_FEEDNAME = "Doxygen generated docs"
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
# should uniquely identify the documentation set bundle. This should be a
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
# will append .docset to the name.
DOCSET_BUNDLE_ID = org.doxygen.Project
# 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 compiled 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 CHM_INDEX_ENCODING
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
# content.
CHM_INDEX_ENCODING =
# 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
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
# are set, an additional index file will be generated that can be used as input for
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
# HTML documentation.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
# The path specified is relative to the HTML output folder.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#namespace
QHP_NAMESPACE =
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
QHP_VIRTUAL_FOLDER = doc
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
# For more information please see
# http://doc.trolltech.com/qthelpproject.html#custom-filters
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
# filter section matches.
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
QHP_SECT_FILTER_ATTRS =
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
# be used to specify the location of Qt's qhelpgenerator.
# If non-empty doxygen will try to run qhelpgenerator on the generated
# .qhp file.
QHG_LOCATION =
# 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
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information.
# If the tag value 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 (i.e. any modern browser).
# Windows users are probably better off using the HTML help feature.
GENERATE_TREEVIEW = NO
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list.
USE_INLINE_TREES = 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
# Use this tag to change the font size of Latex formulas included
# as images in the HTML documentation. The default is 10. Note that
# when you change the font size after a successful doxygen run you need
# to manually remove any form_*.png images from the HTML output directory
# to force them to be regenerated.
FORMULA_FONTSIZE = 10
# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
# there is already a search function so this one should typically
# be disabled.
SEARCHENGINE = YES
#---------------------------------------------------------------------------
# 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 = NO
# 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 = a4wide
# 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
# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
LATEX_SOURCE_CODE = 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 = YES
# 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 = YES
# 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_DEFINED 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
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# 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
# By default doxygen will write a font called FreeSans.ttf to the output
# directory and reference it in all dot files that doxygen generates. This
# font does not include all possible unicode characters however, so when you need
# these (or just want a differently looking font) you can specify the font name
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
# which can be done by putting it in a standard location or by setting the
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
# containing the font.
DOT_FONTNAME = FreeSans
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
# The default size is 10pt.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the output directory to look for the
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
# different font using DOT_FONTNAME you can set the path where dot
# can find it using this tag.
DOT_FONTPATH =
# 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 options 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 CALLER_GRAPH and HAVE_DOT tags are set to YES then
# doxygen will generate a caller 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 caller
# graphs for selected functions only using the \callergraph command.
CALLER_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 DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
# nodes that will be shown in the graph. If the number of nodes in a graph
# becomes larger than this value, doxygen will truncate the graph, which is
# visualized by representing a node as a red box. Note that doxygen if the
# number of direct children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
DOT_GRAPH_MAX_NODES = 50
# 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 the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not
# seem to support this out of the box. 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 = YES
# 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
================================================
FILE: docs/doxygen/doxyxml/__init__.py
================================================
#
# Copyright 2010 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
# GNU Radio is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# GNU Radio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Radio; see the file COPYING. If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
#
"""
Python interface to contents of doxygen xml documentation.
Example use:
See the contents of the example folder for the C++ and
doxygen-generated xml used in this example.
>>> # Parse the doxygen docs.
>>> import os
>>> this_dir = os.path.dirname(globals()['__file__'])
>>> xml_path = this_dir + "/example/xml/"
>>> di = DoxyIndex(xml_path)
Get a list of all top-level objects.
>>> print([mem.name() for mem in di.members()])
[u'Aadvark', u'aadvarky_enough', u'main']
Get all functions.
>>> print([mem.name() for mem in di.in_category(DoxyFunction)])
[u'aadvarky_enough', u'main']
Check if an object is present.
>>> di.has_member(u'Aadvark')
True
>>> di.has_member(u'Fish')
False
Get an item by name and check its properties.
>>> aad = di.get_member(u'Aadvark')
>>> print(aad.brief_description)
Models the mammal Aadvark.
>>> print(aad.detailed_description)
Sadly the model is incomplete and cannot capture all aspects of an aadvark yet.
<BLANKLINE>
This line is uninformative and is only to test line breaks in the comments.
>>> [mem.name() for mem in aad.members()]
[u'aadvarkness', u'print', u'Aadvark', u'get_aadvarkness']
>>> aad.get_member(u'print').brief_description
u'Outputs the vital aadvark statistics.'
"""
from doxyindex import DoxyIndex, DoxyFunction, DoxyParam, DoxyClass, DoxyFile, DoxyNamespace, DoxyGroup, DoxyFriend, DoxyOther
def _test():
import os
this_dir = os.path.dirname(globals()['__file__'])
xml_path = this_dir + "/example/xml/"
di = DoxyIndex(xml_path)
# Get the Aadvark class
aad = di.get_member('Aadvark')
aad.brief_description
import doctest
return doctest.testmod()
if __name__ == "__main__":
_test()
================================================
FILE: docs/doxygen/doxyxml/base.py
================================================
#
# Copyright 2010 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
# GNU Radio is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# GNU Radio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Radio; see the file COPYING. If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
#
"""
A base class is created.
Classes based upon this are used to make more user-friendly interfaces
to the doxygen xml docs than the generated classes provide.
"""
import os
import pdb
from xml.parsers.expat import ExpatError
from generated import compound
class Base(object):
class Duplicate(StandardError):
pass
class NoSuchMember(StandardError):
pass
class ParsingError(StandardError):
pass
def __init__(self, parse_data, top=None):
self._parsed = False
self._error = False
self._parse_data = parse_data
self._members = []
self._dict_members = {}
self._in_category = {}
self._data = {}
if top is not None:
self._xml_path = top._xml_path
# Set up holder of references
else:
top = self
self._refs = {}
self._xml_path = parse_data
self.top = top
@classmethod
def from_refid(cls, refid, top=None):
""" Instantiate class from a refid rather than parsing object. """
# First check to see if its already been instantiated.
if top is not None and refid in top._refs:
return top._refs[refid]
# Otherwise create a new instance and set refid.
inst = cls(None, top=top)
inst.refid = refid
inst.add_ref(inst)
return inst
@classmethod
def from_parse_data(cls, parse_data, top=None):
refid = getattr(parse_data, 'refid', None)
if refid is not None and top is not None and refid in top._refs:
return top._refs[refid]
inst = cls(parse_data, top=top)
if refid is not None:
inst.refid = refid
inst.add_ref(inst)
return inst
def add_ref(self, obj):
if hasattr(obj, 'refid'):
self.top._refs[obj.refid] = obj
mem_classes = []
def get_cls(self, mem):
for cls in self.mem_classes:
if cls.can_parse(mem):
return cls
raise StandardError(("Did not find a class for object '%s'." \
% (mem.get_name())))
def convert_mem(self, mem):
try:
cls = self.get_cls(mem)
converted = cls.from_parse_data(mem, self.top)
if converted is None:
raise StandardError('No class matched this object.')
self.add_ref(converted)
return converted
except StandardError, e:
print e
@classmethod
def includes(cls, inst):
return isinstance(inst, cls)
@classmethod
def can_parse(cls, obj):
return False
def _parse(self):
self._parsed = True
def _get_dict_members(self, cat=None):
"""
For given category a dictionary is returned mapping member names to
members of that category. For names that are duplicated the name is
mapped to None.
"""
self.confirm_no_error()
if cat not in self._dict_members:
new_dict = {}
for mem in self.in_category(cat):
if mem.name() not in new_dict:
new_dict[mem.name()] = mem
else:
new_dict[mem.name()] = self.Duplicate
self._dict_members[cat] = new_dict
return self._dict_members[cat]
def in_category(self, cat):
self.confirm_no_error()
if cat is None:
return self._members
if cat not in self._in_category:
self._in_category[cat] = [mem for mem in self._members
if cat.includes(mem)]
return self._in_category[cat]
def get_member(self, name, cat=None):
self.confirm_no_error()
# Check if it's in a namespace or class.
bits = name.split('::')
first = bits[0]
rest = '::'.join(bits[1:])
member = self._get_dict_members(cat).get(first, self.NoSuchMember)
# Raise any errors that are returned.
if member in set([self.NoSuchMember, self.Duplicate]):
raise member()
if rest:
return member.get_member(rest, cat=cat)
return member
def has_member(self, name, cat=None):
try:
mem = self.get_member(name, cat=cat)
return True
except self.NoSuchMember:
return False
def data(self):
self.confirm_no_error()
return self._data
def members(self):
self.confirm_no_error()
return self._members
def process_memberdefs(self):
mdtss = []
for sec in self._retrieved_data.compounddef.sectiondef:
mdtss += sec.memberdef
# At the moment we lose all information associated with sections.
# Sometimes a memberdef is in several sectiondef.
# We make sure we don't get duplicates here.
uniques = set([])
for mem in mdtss:
converted = self.convert_mem(mem)
pair = (mem.name, mem.__class__)
if pair not in uniques:
uniques.add(pair)
self._members.append(converted)
def retrieve_data(self):
filename = os.path.join(self._xml_path, self.refid + '.xml')
try:
self._retrieved_data = compound.parse(filename)
except ExpatError:
print('Error in xml in file %s' % filename)
self._error = True
self._retrieved_data = None
def check_parsed(self):
if not self._parsed:
self._parse()
def confirm_no_error(self):
self.check_parsed()
if self._error:
raise self.ParsingError()
def error(self):
self.check_parsed()
return self._error
def name(self):
# first see if we can do it without processing.
if self._parse_data is not None:
return self._parse_data.name
self.check_parsed()
return self._retrieved_data.compounddef.name
================================================
FILE: docs/doxygen/doxyxml/doxyindex.py
================================================
#
# Copyright 2010 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
# GNU Radio is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# GNU Radio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Radio; see the file COPYING. If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
#
"""
Classes providing more user-friendly interfaces to the doxygen xml
docs than the generated classes provide.
"""
import os
from generated import index
from base import Base
from text import description
class DoxyIndex(Base):
"""
Parses a doxygen xml directory.
"""
__module__ = "gnuradio.utils.doxyxml"
def _parse(self):
if self._parsed:
return
super(DoxyIndex, self)._parse()
self._root = index.parse(os.path.join(self._xml_path, 'index.xml'))
for mem in self._root.compound:
converted = self.convert_mem(mem)
# For files we want the contents to be accessible directly
# from the parent rather than having to go through the file
# object.
if self.get_cls(mem) == DoxyFile:
if mem.name.endswith('.h'):
self._members += converted.members()
self._members.append(converted)
else:
self._members.append(converted)
def generate_swig_doc_i(self):
"""
%feature("docstring") gr_make_align_on_samplenumbers_ss::align_state "
Wraps the C++: gr_align_on_samplenumbers_ss::align_state";
"""
pass
class DoxyCompMem(Base):
kind = None
def __init__(self, *args, **kwargs):
super(DoxyCompMem, self).__init__(*args, **kwargs)
@classmethod
def can_parse(cls, obj):
return obj.kind == cls.kind
def set_descriptions(self, parse_data):
bd = description(getattr(parse_data, 'briefdescription', None))
dd = description(getattr(parse_data, 'detaileddescription', None))
self._data['brief_description'] = bd
self._data['detailed_description'] = dd
class DoxyCompound(DoxyCompMem):
pass
class DoxyMember(DoxyCompMem):
pass
class DoxyFunction(DoxyMember):
__module__ = "gnuradio.utils.doxyxml"
kind = 'function'
def _parse(self):
if self._parsed:
return
super(DoxyFunction, self)._parse()
self.set_descriptions(self._parse_data)
self._data['params'] = []
prms = self._parse_data.param
for prm in prms:
self._data['params'].append(DoxyParam(prm))
brief_description = property(lambda self: self.data()['brief_description'])
detailed_description = property(lambda self: self.data()['detailed_description'])
params = property(lambda self: self.data()['params'])
Base.mem_classes.append(DoxyFunction)
class DoxyParam(DoxyMember):
__module__ = "gnuradio.utils.doxyxml"
def _parse(self):
if self._parsed:
return
super(DoxyParam, self)._parse()
self.set_descriptions(self._parse_data)
self._data['declname'] = self._parse_data.declname
brief_description = property(lambda self: self.data()['brief_description'])
detailed_description = property(lambda self: self.data()['detailed_description'])
declname = property(lambda self: self.data()['declname'])
class DoxyClass(DoxyCompound):
__module__ = "gnuradio.utils.doxyxml"
kind = 'class'
def _parse(self):
if self._parsed:
return
super(DoxyClass, self)._parse()
self.retrieve_data()
if self._error:
return
self.set_descriptions(self._retrieved_data.compounddef)
# Sectiondef.kind tells about whether private or public.
# We just ignore this for now.
self.process_memberdefs()
brief_description = property(lambda self: self.data()['brief_description'])
detailed_description = property(lambda self: self.data()['detailed_description'])
Base.mem_classes.append(DoxyClass)
class DoxyFile(DoxyCompound):
__module__ = "gnuradio.utils.doxyxml"
kind = 'file'
def _parse(self):
if self._parsed:
return
super(DoxyFile, self)._parse()
self.retrieve_data()
self.set_descriptions(self._retrieved_data.compounddef)
if self._error:
return
self.process_memberdefs()
brief_description = property(lambda self: self.data()['brief_description'])
detailed_description = property(lambda self: self.data()['detailed_description'])
Base.mem_classes.append(DoxyFile)
class DoxyNamespace(DoxyCompound):
__module__ = "gnuradio.utils.doxyxml"
kind = 'namespace'
Base.mem_classes.append(DoxyNamespace)
class DoxyGroup(DoxyCompound):
__module__ = "gnuradio.utils.doxyxml"
kind = 'group'
def _parse(self):
if self._parsed:
return
super(DoxyGroup, self)._parse()
self.retrieve_data()
if self._error:
return
cdef = self._retrieved_data.compounddef
self._data['title'] = description(cdef.title)
# Process inner groups
grps = cdef.innergroup
for grp in grps:
converted = DoxyGroup.from_refid(grp.refid, top=self.top)
self._members.append(converted)
# Process inner classes
klasses = cdef.innerclass
for kls in klasses:
converted = DoxyClass.from_refid(kls.refid, top=self.top)
self._members.append(converted)
# Process normal members
self.process_memberdefs()
title = property(lambda self: self.data()['title'])
Base.mem_classes.append(DoxyGroup)
class DoxyFriend(DoxyMember):
__module__ = "gnuradio.utils.doxyxml"
kind = 'friend'
Base.mem_classes.append(DoxyFriend)
class DoxyOther(Base):
__module__ = "gnuradio.utils.doxyxml"
kinds = set(['variable', 'struct', 'union', 'define', 'typedef', 'enum', 'dir', 'page'])
@classmethod
def can_parse(cls, obj):
return obj.kind in cls.kinds
Base.mem_classes.append(DoxyOther)
================================================
FILE: docs/doxygen/doxyxml/generated/__init__.py
================================================
"""
Contains generated files produced by generateDS.py.
These do the real work of parsing the doxygen xml files but the
resultant classe
gitextract_h3fhltzh/
├── .gitignore
├── CMakeLists.txt
├── README.md
├── apps/
│ └── CMakeLists.txt
├── cmake/
│ ├── Modules/
│ │ ├── CMakeParseArgumentsCopy.cmake
│ │ ├── FindCppUnit.cmake
│ │ ├── FindGnuradioRuntime.cmake
│ │ ├── GrMiscUtils.cmake
│ │ ├── GrPlatform.cmake
│ │ ├── GrPython.cmake
│ │ ├── GrSwig.cmake
│ │ ├── GrTest.cmake
│ │ └── dsssConfig.cmake
│ └── cmake_uninstall.cmake.in
├── docs/
│ ├── CMakeLists.txt
│ ├── README.dsss
│ └── doxygen/
│ ├── CMakeLists.txt
│ ├── Doxyfile.in
│ ├── Doxyfile.swig_doc.in
│ ├── doxyxml/
│ │ ├── __init__.py
│ │ ├── base.py
│ │ ├── doxyindex.py
│ │ ├── generated/
│ │ │ ├── __init__.py
│ │ │ ├── compound.py
│ │ │ ├── compoundsuper.py
│ │ │ ├── index.py
│ │ │ └── indexsuper.py
│ │ └── text.py
│ ├── other/
│ │ ├── group_defs.dox
│ │ └── main_page.dox
│ └── swig_doc.py
├── examples/
│ ├── dsss_decoder.grc
│ ├── dsss_decoder2.grc
│ ├── dsss_decoder_exp.grc
│ ├── dsss_decoder_rx.grc
│ ├── dsss_decoder_tx.grc
│ └── dsss_encoder.grc
├── grc/
│ ├── CMakeLists.txt
│ ├── dsss_dsss_decoder_cc.xml
│ └── dsss_dsss_encoder_bb.xml
├── include/
│ └── dsss/
│ ├── CMakeLists.txt
│ ├── api.h
│ ├── dsss_decoder_cc.h
│ └── dsss_encoder_bb.h
├── lib/
│ ├── CMakeLists.txt
│ ├── dsss_decoder_cc_impl.cc
│ ├── dsss_decoder_cc_impl.h
│ ├── dsss_encoder_bb_impl.cc
│ ├── dsss_encoder_bb_impl.h
│ ├── qa_dsss.cc
│ ├── qa_dsss.h
│ └── test_dsss.cc
├── python/
│ ├── CMakeLists.txt
│ ├── __init__.py
│ ├── build_utils.py
│ ├── build_utils_codes.py
│ ├── qa_dsss_decoder_cc.py
│ └── qa_dsss_encoder_bb.py
└── swig/
├── CMakeLists.txt
└── dsss_swig.i
SYMBOL INDEX (1989 symbols across 21 files)
FILE: docs/doxygen/doxyxml/__init__.py
function _test (line 69) | def _test():
FILE: docs/doxygen/doxyxml/base.py
class Base (line 36) | class Base(object):
class Duplicate (line 38) | class Duplicate(StandardError):
class NoSuchMember (line 41) | class NoSuchMember(StandardError):
class ParsingError (line 44) | class ParsingError(StandardError):
method __init__ (line 47) | def __init__(self, parse_data, top=None):
method from_refid (line 65) | def from_refid(cls, refid, top=None):
method from_parse_data (line 77) | def from_parse_data(cls, parse_data, top=None):
method add_ref (line 87) | def add_ref(self, obj):
method get_cls (line 93) | def get_cls(self, mem):
method convert_mem (line 100) | def convert_mem(self, mem):
method includes (line 112) | def includes(cls, inst):
method can_parse (line 116) | def can_parse(cls, obj):
method _parse (line 119) | def _parse(self):
method _get_dict_members (line 122) | def _get_dict_members(self, cat=None):
method in_category (line 139) | def in_category(self, cat):
method get_member (line 148) | def get_member(self, name, cat=None):
method has_member (line 162) | def has_member(self, name, cat=None):
method data (line 169) | def data(self):
method members (line 173) | def members(self):
method process_memberdefs (line 177) | def process_memberdefs(self):
method retrieve_data (line 192) | def retrieve_data(self):
method check_parsed (line 201) | def check_parsed(self):
method confirm_no_error (line 205) | def confirm_no_error(self):
method error (line 210) | def error(self):
method name (line 214) | def name(self):
FILE: docs/doxygen/doxyxml/doxyindex.py
class DoxyIndex (line 32) | class DoxyIndex(Base):
method _parse (line 39) | def _parse(self):
function generate_swig_doc_i (line 57) | def generate_swig_doc_i(self):
class DoxyCompMem (line 65) | class DoxyCompMem(Base):
method __init__ (line 70) | def __init__(self, *args, **kwargs):
method can_parse (line 74) | def can_parse(cls, obj):
method set_descriptions (line 77) | def set_descriptions(self, parse_data):
class DoxyCompound (line 83) | class DoxyCompound(DoxyCompMem):
class DoxyMember (line 86) | class DoxyMember(DoxyCompMem):
class DoxyFunction (line 90) | class DoxyFunction(DoxyMember):
method _parse (line 96) | def _parse(self):
class DoxyParam (line 113) | class DoxyParam(DoxyMember):
method _parse (line 117) | def _parse(self):
class DoxyClass (line 128) | class DoxyClass(DoxyCompound):
method _parse (line 134) | def _parse(self):
class DoxyFile (line 152) | class DoxyFile(DoxyCompound):
method _parse (line 158) | def _parse(self):
class DoxyNamespace (line 174) | class DoxyNamespace(DoxyCompound):
class DoxyGroup (line 183) | class DoxyGroup(DoxyCompound):
method _parse (line 189) | def _parse(self):
class DoxyFriend (line 217) | class DoxyFriend(DoxyMember):
class DoxyOther (line 226) | class DoxyOther(Base):
method can_parse (line 233) | def can_parse(cls, obj):
FILE: docs/doxygen/doxyxml/generated/compound.py
class DoxygenTypeSub (line 17) | class DoxygenTypeSub(supermod.DoxygenType):
method __init__ (line 18) | def __init__(self, version=None, compounddef=None):
method find (line 21) | def find(self, details):
class compounddefTypeSub (line 29) | class compounddefTypeSub(supermod.compounddefType):
method __init__ (line 30) | def __init__(self, kind=None, prot=None, id=None, compoundname='', tit...
method find (line 33) | def find(self, details):
class listofallmembersTypeSub (line 48) | class listofallmembersTypeSub(supermod.listofallmembersType):
method __init__ (line 49) | def __init__(self, member=None):
class memberRefTypeSub (line 55) | class memberRefTypeSub(supermod.memberRefType):
method __init__ (line 56) | def __init__(self, virt=None, prot=None, refid=None, ambiguityscope=No...
class compoundRefTypeSub (line 62) | class compoundRefTypeSub(supermod.compoundRefType):
method __init__ (line 63) | def __init__(self, virt=None, prot=None, refid=None, valueOf_='', mixe...
class reimplementTypeSub (line 69) | class reimplementTypeSub(supermod.reimplementType):
method __init__ (line 70) | def __init__(self, refid=None, valueOf_='', mixedclass_=None, content_...
class incTypeSub (line 76) | class incTypeSub(supermod.incType):
method __init__ (line 77) | def __init__(self, local=None, refid=None, valueOf_='', mixedclass_=No...
class refTypeSub (line 83) | class refTypeSub(supermod.refType):
method __init__ (line 84) | def __init__(self, prot=None, refid=None, valueOf_='', mixedclass_=Non...
class refTextTypeSub (line 91) | class refTextTypeSub(supermod.refTextType):
method __init__ (line 92) | def __init__(self, refid=None, kindref=None, external=None, valueOf_='...
class sectiondefTypeSub (line 98) | class sectiondefTypeSub(supermod.sectiondefType):
method __init__ (line 101) | def __init__(self, kind=None, header='', description=None, memberdef=N...
method find (line 104) | def find(self, details):
class memberdefTypeSub (line 117) | class memberdefTypeSub(supermod.memberdefType):
method __init__ (line 118) | def __init__(self, initonly=None, kind=None, volatile=None, const=None...
class descriptionTypeSub (line 124) | class descriptionTypeSub(supermod.descriptionType):
method __init__ (line 125) | def __init__(self, title='', para=None, sect1=None, internal=None, mix...
class enumvalueTypeSub (line 131) | class enumvalueTypeSub(supermod.enumvalueType):
method __init__ (line 132) | def __init__(self, prot=None, id=None, name='', initializer=None, brie...
class templateparamlistTypeSub (line 138) | class templateparamlistTypeSub(supermod.templateparamlistType):
method __init__ (line 139) | def __init__(self, param=None):
class paramTypeSub (line 145) | class paramTypeSub(supermod.paramType):
method __init__ (line 146) | def __init__(self, type_=None, declname='', defname='', array='', defv...
class linkedTextTypeSub (line 152) | class linkedTextTypeSub(supermod.linkedTextType):
method __init__ (line 153) | def __init__(self, ref=None, mixedclass_=None, content_=None):
class graphTypeSub (line 159) | class graphTypeSub(supermod.graphType):
method __init__ (line 160) | def __init__(self, node=None):
class nodeTypeSub (line 166) | class nodeTypeSub(supermod.nodeType):
method __init__ (line 167) | def __init__(self, id=None, label='', link=None, childnode=None):
class childnodeTypeSub (line 173) | class childnodeTypeSub(supermod.childnodeType):
method __init__ (line 174) | def __init__(self, relation=None, refid=None, edgelabel=None):
class linkTypeSub (line 180) | class linkTypeSub(supermod.linkType):
method __init__ (line 181) | def __init__(self, refid=None, external=None, valueOf_=''):
class listingTypeSub (line 187) | class listingTypeSub(supermod.listingType):
method __init__ (line 188) | def __init__(self, codeline=None):
class codelineTypeSub (line 194) | class codelineTypeSub(supermod.codelineType):
method __init__ (line 195) | def __init__(self, external=None, lineno=None, refkind=None, refid=Non...
class highlightTypeSub (line 201) | class highlightTypeSub(supermod.highlightType):
method __init__ (line 202) | def __init__(self, class_=None, sp=None, ref=None, mixedclass_=None, c...
class referenceTypeSub (line 208) | class referenceTypeSub(supermod.referenceType):
method __init__ (line 209) | def __init__(self, endline=None, startline=None, refid=None, compoundr...
class locationTypeSub (line 215) | class locationTypeSub(supermod.locationType):
method __init__ (line 216) | def __init__(self, bodystart=None, line=None, bodyend=None, bodyfile=N...
class docSect1TypeSub (line 222) | class docSect1TypeSub(supermod.docSect1Type):
method __init__ (line 223) | def __init__(self, id=None, title='', para=None, sect2=None, internal=...
class docSect2TypeSub (line 229) | class docSect2TypeSub(supermod.docSect2Type):
method __init__ (line 230) | def __init__(self, id=None, title='', para=None, sect3=None, internal=...
class docSect3TypeSub (line 236) | class docSect3TypeSub(supermod.docSect3Type):
method __init__ (line 237) | def __init__(self, id=None, title='', para=None, sect4=None, internal=...
class docSect4TypeSub (line 243) | class docSect4TypeSub(supermod.docSect4Type):
method __init__ (line 244) | def __init__(self, id=None, title='', para=None, internal=None, mixedc...
class docInternalTypeSub (line 250) | class docInternalTypeSub(supermod.docInternalType):
method __init__ (line 251) | def __init__(self, para=None, sect1=None, mixedclass_=None, content_=N...
class docInternalS1TypeSub (line 257) | class docInternalS1TypeSub(supermod.docInternalS1Type):
method __init__ (line 258) | def __init__(self, para=None, sect2=None, mixedclass_=None, content_=N...
class docInternalS2TypeSub (line 264) | class docInternalS2TypeSub(supermod.docInternalS2Type):
method __init__ (line 265) | def __init__(self, para=None, sect3=None, mixedclass_=None, content_=N...
class docInternalS3TypeSub (line 271) | class docInternalS3TypeSub(supermod.docInternalS3Type):
method __init__ (line 272) | def __init__(self, para=None, sect3=None, mixedclass_=None, content_=N...
class docInternalS4TypeSub (line 278) | class docInternalS4TypeSub(supermod.docInternalS4Type):
method __init__ (line 279) | def __init__(self, para=None, mixedclass_=None, content_=None):
class docURLLinkSub (line 285) | class docURLLinkSub(supermod.docURLLink):
method __init__ (line 286) | def __init__(self, url=None, valueOf_='', mixedclass_=None, content_=N...
class docAnchorTypeSub (line 292) | class docAnchorTypeSub(supermod.docAnchorType):
method __init__ (line 293) | def __init__(self, id=None, valueOf_='', mixedclass_=None, content_=No...
class docFormulaTypeSub (line 299) | class docFormulaTypeSub(supermod.docFormulaType):
method __init__ (line 300) | def __init__(self, id=None, valueOf_='', mixedclass_=None, content_=No...
class docIndexEntryTypeSub (line 306) | class docIndexEntryTypeSub(supermod.docIndexEntryType):
method __init__ (line 307) | def __init__(self, primaryie='', secondaryie=''):
class docListTypeSub (line 313) | class docListTypeSub(supermod.docListType):
method __init__ (line 314) | def __init__(self, listitem=None):
class docListItemTypeSub (line 320) | class docListItemTypeSub(supermod.docListItemType):
method __init__ (line 321) | def __init__(self, para=None):
class docSimpleSectTypeSub (line 327) | class docSimpleSectTypeSub(supermod.docSimpleSectType):
method __init__ (line 328) | def __init__(self, kind=None, title=None, para=None):
class docVarListEntryTypeSub (line 334) | class docVarListEntryTypeSub(supermod.docVarListEntryType):
method __init__ (line 335) | def __init__(self, term=None):
class docRefTextTypeSub (line 341) | class docRefTextTypeSub(supermod.docRefTextType):
method __init__ (line 342) | def __init__(self, refid=None, kindref=None, external=None, valueOf_='...
class docTableTypeSub (line 348) | class docTableTypeSub(supermod.docTableType):
method __init__ (line 349) | def __init__(self, rows=None, cols=None, row=None, caption=None):
class docRowTypeSub (line 355) | class docRowTypeSub(supermod.docRowType):
method __init__ (line 356) | def __init__(self, entry=None):
class docEntryTypeSub (line 362) | class docEntryTypeSub(supermod.docEntryType):
method __init__ (line 363) | def __init__(self, thead=None, para=None):
class docHeadingTypeSub (line 369) | class docHeadingTypeSub(supermod.docHeadingType):
method __init__ (line 370) | def __init__(self, level=None, valueOf_='', mixedclass_=None, content_...
class docImageTypeSub (line 376) | class docImageTypeSub(supermod.docImageType):
method __init__ (line 377) | def __init__(self, width=None, type_=None, name=None, height=None, val...
class docDotFileTypeSub (line 383) | class docDotFileTypeSub(supermod.docDotFileType):
method __init__ (line 384) | def __init__(self, name=None, valueOf_='', mixedclass_=None, content_=...
class docTocItemTypeSub (line 390) | class docTocItemTypeSub(supermod.docTocItemType):
method __init__ (line 391) | def __init__(self, id=None, valueOf_='', mixedclass_=None, content_=No...
class docTocListTypeSub (line 397) | class docTocListTypeSub(supermod.docTocListType):
method __init__ (line 398) | def __init__(self, tocitem=None):
class docLanguageTypeSub (line 404) | class docLanguageTypeSub(supermod.docLanguageType):
method __init__ (line 405) | def __init__(self, langid=None, para=None):
class docParamListTypeSub (line 411) | class docParamListTypeSub(supermod.docParamListType):
method __init__ (line 412) | def __init__(self, kind=None, parameteritem=None):
class docParamListItemSub (line 418) | class docParamListItemSub(supermod.docParamListItem):
method __init__ (line 419) | def __init__(self, parameternamelist=None, parameterdescription=None):
class docParamNameListSub (line 425) | class docParamNameListSub(supermod.docParamNameList):
method __init__ (line 426) | def __init__(self, parametername=None):
class docParamNameSub (line 432) | class docParamNameSub(supermod.docParamName):
method __init__ (line 433) | def __init__(self, direction=None, ref=None, mixedclass_=None, content...
class docXRefSectTypeSub (line 439) | class docXRefSectTypeSub(supermod.docXRefSectType):
method __init__ (line 440) | def __init__(self, id=None, xreftitle=None, xrefdescription=None):
class docCopyTypeSub (line 446) | class docCopyTypeSub(supermod.docCopyType):
method __init__ (line 447) | def __init__(self, link=None, para=None, sect1=None, internal=None):
class docCharTypeSub (line 453) | class docCharTypeSub(supermod.docCharType):
method __init__ (line 454) | def __init__(self, char=None, valueOf_=''):
class docParaTypeSub (line 459) | class docParaTypeSub(supermod.docParaType):
method __init__ (line 460) | def __init__(self, char=None, valueOf_=''):
method buildChildren (line 467) | def buildChildren(self, child_, nodeName_):
function parse (line 496) | def parse(inFilename):
FILE: docs/doxygen/doxyxml/generated/compoundsuper.py
class GeneratedsSuper (line 24) | class GeneratedsSuper:
method format_string (line 25) | def format_string(self, input_data, input_name=''):
method format_integer (line 27) | def format_integer(self, input_data, input_name=''):
method format_float (line 29) | def format_float(self, input_data, input_name=''):
method format_double (line 31) | def format_double(self, input_data, input_name=''):
method format_boolean (line 33) | def format_boolean(self, input_data, input_name=''):
function showIndent (line 62) | def showIndent(outfile, level):
function quote_xml (line 66) | def quote_xml(inStr):
function quote_attrib (line 74) | def quote_attrib(inStr):
function quote_python (line 89) | def quote_python(inStr):
class MixedContainer (line 105) | class MixedContainer:
method __init__ (line 120) | def __init__(self, category, content_type, name, value):
method getCategory (line 125) | def getCategory(self):
method getContenttype (line 127) | def getContenttype(self, content_type):
method getValue (line 129) | def getValue(self):
method getName (line 131) | def getName(self):
method export (line 133) | def export(self, outfile, level, name, namespace):
method exportSimple (line 140) | def exportSimple(self, outfile, level, name):
method exportLiteral (line 151) | def exportLiteral(self, outfile, level, name):
class _MemberSpec (line 169) | class _MemberSpec(object):
method __init__ (line 170) | def __init__(self, name='', data_type='', container=0):
method set_name (line 174) | def set_name(self, name): self.name = name
method get_name (line 175) | def get_name(self): return self.name
method set_data_type (line 176) | def set_data_type(self, data_type): self.data_type = data_type
method get_data_type (line 177) | def get_data_type(self): return self.data_type
method set_container (line 178) | def set_container(self, container): self.container = container
method get_container (line 179) | def get_container(self): return self.container
class DoxygenType (line 186) | class DoxygenType(GeneratedsSuper):
method __init__ (line 189) | def __init__(self, version=None, compounddef=None):
method factory (line 192) | def factory(*args_, **kwargs_):
method get_compounddef (line 198) | def get_compounddef(self): return self.compounddef
method set_compounddef (line 199) | def set_compounddef(self, compounddef): self.compounddef = compounddef
method get_version (line 200) | def get_version(self): return self.version
method set_version (line 201) | def set_version(self, version): self.version = version
method export (line 202) | def export(self, outfile, level, namespace_='', name_='DoxygenType', n...
method exportAttributes (line 213) | def exportAttributes(self, outfile, level, namespace_='', name_='Doxyg...
method exportChildren (line 215) | def exportChildren(self, outfile, level, namespace_='', name_='Doxygen...
method hasContent_ (line 218) | def hasContent_(self):
method exportLiteral (line 225) | def exportLiteral(self, outfile, level, name_='DoxygenType'):
method exportLiteralAttributes (line 230) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 234) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 241) | def build(self, node_):
method buildAttributes (line 247) | def buildAttributes(self, attrs):
method buildChildren (line 250) | def buildChildren(self, child_, nodeName_):
class compounddefType (line 259) | class compounddefType(GeneratedsSuper):
method __init__ (line 262) | def __init__(self, kind=None, prot=None, id=None, compoundname=None, t...
method factory (line 322) | def factory(*args_, **kwargs_):
method get_compoundname (line 328) | def get_compoundname(self): return self.compoundname
method set_compoundname (line 329) | def set_compoundname(self, compoundname): self.compoundname = compound...
method get_title (line 330) | def get_title(self): return self.title
method set_title (line 331) | def set_title(self, title): self.title = title
method get_basecompoundref (line 332) | def get_basecompoundref(self): return self.basecompoundref
method set_basecompoundref (line 333) | def set_basecompoundref(self, basecompoundref): self.basecompoundref =...
method add_basecompoundref (line 334) | def add_basecompoundref(self, value): self.basecompoundref.append(value)
method insert_basecompoundref (line 335) | def insert_basecompoundref(self, index, value): self.basecompoundref[i...
method get_derivedcompoundref (line 336) | def get_derivedcompoundref(self): return self.derivedcompoundref
method set_derivedcompoundref (line 337) | def set_derivedcompoundref(self, derivedcompoundref): self.derivedcomp...
method add_derivedcompoundref (line 338) | def add_derivedcompoundref(self, value): self.derivedcompoundref.appen...
method insert_derivedcompoundref (line 339) | def insert_derivedcompoundref(self, index, value): self.derivedcompoun...
method get_includes (line 340) | def get_includes(self): return self.includes
method set_includes (line 341) | def set_includes(self, includes): self.includes = includes
method add_includes (line 342) | def add_includes(self, value): self.includes.append(value)
method insert_includes (line 343) | def insert_includes(self, index, value): self.includes[index] = value
method get_includedby (line 344) | def get_includedby(self): return self.includedby
method set_includedby (line 345) | def set_includedby(self, includedby): self.includedby = includedby
method add_includedby (line 346) | def add_includedby(self, value): self.includedby.append(value)
method insert_includedby (line 347) | def insert_includedby(self, index, value): self.includedby[index] = value
method get_incdepgraph (line 348) | def get_incdepgraph(self): return self.incdepgraph
method set_incdepgraph (line 349) | def set_incdepgraph(self, incdepgraph): self.incdepgraph = incdepgraph
method get_invincdepgraph (line 350) | def get_invincdepgraph(self): return self.invincdepgraph
method set_invincdepgraph (line 351) | def set_invincdepgraph(self, invincdepgraph): self.invincdepgraph = in...
method get_innerdir (line 352) | def get_innerdir(self): return self.innerdir
method set_innerdir (line 353) | def set_innerdir(self, innerdir): self.innerdir = innerdir
method add_innerdir (line 354) | def add_innerdir(self, value): self.innerdir.append(value)
method insert_innerdir (line 355) | def insert_innerdir(self, index, value): self.innerdir[index] = value
method get_innerfile (line 356) | def get_innerfile(self): return self.innerfile
method set_innerfile (line 357) | def set_innerfile(self, innerfile): self.innerfile = innerfile
method add_innerfile (line 358) | def add_innerfile(self, value): self.innerfile.append(value)
method insert_innerfile (line 359) | def insert_innerfile(self, index, value): self.innerfile[index] = value
method get_innerclass (line 360) | def get_innerclass(self): return self.innerclass
method set_innerclass (line 361) | def set_innerclass(self, innerclass): self.innerclass = innerclass
method add_innerclass (line 362) | def add_innerclass(self, value): self.innerclass.append(value)
method insert_innerclass (line 363) | def insert_innerclass(self, index, value): self.innerclass[index] = value
method get_innernamespace (line 364) | def get_innernamespace(self): return self.innernamespace
method set_innernamespace (line 365) | def set_innernamespace(self, innernamespace): self.innernamespace = in...
method add_innernamespace (line 366) | def add_innernamespace(self, value): self.innernamespace.append(value)
method insert_innernamespace (line 367) | def insert_innernamespace(self, index, value): self.innernamespace[ind...
method get_innerpage (line 368) | def get_innerpage(self): return self.innerpage
method set_innerpage (line 369) | def set_innerpage(self, innerpage): self.innerpage = innerpage
method add_innerpage (line 370) | def add_innerpage(self, value): self.innerpage.append(value)
method insert_innerpage (line 371) | def insert_innerpage(self, index, value): self.innerpage[index] = value
method get_innergroup (line 372) | def get_innergroup(self): return self.innergroup
method set_innergroup (line 373) | def set_innergroup(self, innergroup): self.innergroup = innergroup
method add_innergroup (line 374) | def add_innergroup(self, value): self.innergroup.append(value)
method insert_innergroup (line 375) | def insert_innergroup(self, index, value): self.innergroup[index] = value
method get_templateparamlist (line 376) | def get_templateparamlist(self): return self.templateparamlist
method set_templateparamlist (line 377) | def set_templateparamlist(self, templateparamlist): self.templateparam...
method get_sectiondef (line 378) | def get_sectiondef(self): return self.sectiondef
method set_sectiondef (line 379) | def set_sectiondef(self, sectiondef): self.sectiondef = sectiondef
method add_sectiondef (line 380) | def add_sectiondef(self, value): self.sectiondef.append(value)
method insert_sectiondef (line 381) | def insert_sectiondef(self, index, value): self.sectiondef[index] = value
method get_briefdescription (line 382) | def get_briefdescription(self): return self.briefdescription
method set_briefdescription (line 383) | def set_briefdescription(self, briefdescription): self.briefdescriptio...
method get_detaileddescription (line 384) | def get_detaileddescription(self): return self.detaileddescription
method set_detaileddescription (line 385) | def set_detaileddescription(self, detaileddescription): self.detailedd...
method get_inheritancegraph (line 386) | def get_inheritancegraph(self): return self.inheritancegraph
method set_inheritancegraph (line 387) | def set_inheritancegraph(self, inheritancegraph): self.inheritancegrap...
method get_collaborationgraph (line 388) | def get_collaborationgraph(self): return self.collaborationgraph
method set_collaborationgraph (line 389) | def set_collaborationgraph(self, collaborationgraph): self.collaborati...
method get_programlisting (line 390) | def get_programlisting(self): return self.programlisting
method set_programlisting (line 391) | def set_programlisting(self, programlisting): self.programlisting = pr...
method get_location (line 392) | def get_location(self): return self.location
method set_location (line 393) | def set_location(self, location): self.location = location
method get_listofallmembers (line 394) | def get_listofallmembers(self): return self.listofallmembers
method set_listofallmembers (line 395) | def set_listofallmembers(self, listofallmembers): self.listofallmember...
method get_kind (line 396) | def get_kind(self): return self.kind
method set_kind (line 397) | def set_kind(self, kind): self.kind = kind
method get_prot (line 398) | def get_prot(self): return self.prot
method set_prot (line 399) | def set_prot(self, prot): self.prot = prot
method get_id (line 400) | def get_id(self): return self.id
method set_id (line 401) | def set_id(self, id): self.id = id
method export (line 402) | def export(self, outfile, level, namespace_='', name_='compounddefType...
method exportAttributes (line 413) | def exportAttributes(self, outfile, level, namespace_='', name_='compo...
method exportChildren (line 420) | def exportChildren(self, outfile, level, namespace_='', name_='compoun...
method hasContent_ (line 469) | def hasContent_(self):
method exportLiteral (line 498) | def exportLiteral(self, outfile, level, name_='compounddefType'):
method exportLiteralAttributes (line 503) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 513) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 714) | def build(self, node_):
method buildAttributes (line 720) | def buildAttributes(self, attrs):
method buildChildren (line 727) | def buildChildren(self, child_, nodeName_):
class listofallmembersType (line 847) | class listofallmembersType(GeneratedsSuper):
method __init__ (line 850) | def __init__(self, member=None):
method factory (line 855) | def factory(*args_, **kwargs_):
method get_member (line 861) | def get_member(self): return self.member
method set_member (line 862) | def set_member(self, member): self.member = member
method add_member (line 863) | def add_member(self, value): self.member.append(value)
method insert_member (line 864) | def insert_member(self, index, value): self.member[index] = value
method export (line 865) | def export(self, outfile, level, namespace_='', name_='listofallmember...
method exportAttributes (line 876) | def exportAttributes(self, outfile, level, namespace_='', name_='listo...
method exportChildren (line 878) | def exportChildren(self, outfile, level, namespace_='', name_='listofa...
method hasContent_ (line 881) | def hasContent_(self):
method exportLiteral (line 888) | def exportLiteral(self, outfile, level, name_='listofallmembersType'):
method exportLiteralAttributes (line 893) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 895) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 908) | def build(self, node_):
method buildAttributes (line 914) | def buildAttributes(self, attrs):
method buildChildren (line 916) | def buildChildren(self, child_, nodeName_):
class memberRefType (line 925) | class memberRefType(GeneratedsSuper):
method __init__ (line 928) | def __init__(self, virt=None, prot=None, refid=None, ambiguityscope=No...
method factory (line 935) | def factory(*args_, **kwargs_):
method get_scope (line 941) | def get_scope(self): return self.scope
method set_scope (line 942) | def set_scope(self, scope): self.scope = scope
method get_name (line 943) | def get_name(self): return self.name
method set_name (line 944) | def set_name(self, name): self.name = name
method get_virt (line 945) | def get_virt(self): return self.virt
method set_virt (line 946) | def set_virt(self, virt): self.virt = virt
method get_prot (line 947) | def get_prot(self): return self.prot
method set_prot (line 948) | def set_prot(self, prot): self.prot = prot
method get_refid (line 949) | def get_refid(self): return self.refid
method set_refid (line 950) | def set_refid(self, refid): self.refid = refid
method get_ambiguityscope (line 951) | def get_ambiguityscope(self): return self.ambiguityscope
method set_ambiguityscope (line 952) | def set_ambiguityscope(self, ambiguityscope): self.ambiguityscope = am...
method export (line 953) | def export(self, outfile, level, namespace_='', name_='memberRefType',...
method exportAttributes (line 964) | def exportAttributes(self, outfile, level, namespace_='', name_='membe...
method exportChildren (line 973) | def exportChildren(self, outfile, level, namespace_='', name_='memberR...
method hasContent_ (line 980) | def hasContent_(self):
method exportLiteral (line 988) | def exportLiteral(self, outfile, level, name_='memberRefType'):
method exportLiteralAttributes (line 993) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 1006) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 1011) | def build(self, node_):
method buildAttributes (line 1017) | def buildAttributes(self, attrs):
method buildChildren (line 1026) | def buildChildren(self, child_, nodeName_):
class scope (line 1042) | class scope(GeneratedsSuper):
method __init__ (line 1045) | def __init__(self, valueOf_=''):
method factory (line 1047) | def factory(*args_, **kwargs_):
method getValueOf_ (line 1053) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 1054) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 1055) | def export(self, outfile, level, namespace_='', name_='scope', namespa...
method exportAttributes (line 1066) | def exportAttributes(self, outfile, level, namespace_='', name_='scope'):
method exportChildren (line 1068) | def exportChildren(self, outfile, level, namespace_='', name_='scope'):
method hasContent_ (line 1076) | def hasContent_(self):
method exportLiteral (line 1083) | def exportLiteral(self, outfile, level, name_='scope'):
method exportLiteralAttributes (line 1088) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 1090) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 1093) | def build(self, node_):
method buildAttributes (line 1100) | def buildAttributes(self, attrs):
method buildChildren (line 1102) | def buildChildren(self, child_, nodeName_):
class name (line 1110) | class name(GeneratedsSuper):
method __init__ (line 1113) | def __init__(self, valueOf_=''):
method factory (line 1115) | def factory(*args_, **kwargs_):
method getValueOf_ (line 1121) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 1122) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 1123) | def export(self, outfile, level, namespace_='', name_='name', namespac...
method exportAttributes (line 1134) | def exportAttributes(self, outfile, level, namespace_='', name_='name'):
method exportChildren (line 1136) | def exportChildren(self, outfile, level, namespace_='', name_='name'):
method hasContent_ (line 1144) | def hasContent_(self):
method exportLiteral (line 1151) | def exportLiteral(self, outfile, level, name_='name'):
method exportLiteralAttributes (line 1156) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 1158) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 1161) | def build(self, node_):
method buildAttributes (line 1168) | def buildAttributes(self, attrs):
method buildChildren (line 1170) | def buildChildren(self, child_, nodeName_):
class compoundRefType (line 1178) | class compoundRefType(GeneratedsSuper):
method __init__ (line 1181) | def __init__(self, virt=None, prot=None, refid=None, valueOf_='', mixe...
method factory (line 1193) | def factory(*args_, **kwargs_):
method get_virt (line 1199) | def get_virt(self): return self.virt
method set_virt (line 1200) | def set_virt(self, virt): self.virt = virt
method get_prot (line 1201) | def get_prot(self): return self.prot
method set_prot (line 1202) | def set_prot(self, prot): self.prot = prot
method get_refid (line 1203) | def get_refid(self): return self.refid
method set_refid (line 1204) | def set_refid(self, refid): self.refid = refid
method getValueOf_ (line 1205) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 1206) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 1207) | def export(self, outfile, level, namespace_='', name_='compoundRefType...
method exportAttributes (line 1214) | def exportAttributes(self, outfile, level, namespace_='', name_='compo...
method exportChildren (line 1221) | def exportChildren(self, outfile, level, namespace_='', name_='compoun...
method hasContent_ (line 1229) | def hasContent_(self):
method exportLiteral (line 1236) | def exportLiteral(self, outfile, level, name_='compoundRefType'):
method exportLiteralAttributes (line 1241) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 1251) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 1254) | def build(self, node_):
method buildAttributes (line 1261) | def buildAttributes(self, attrs):
method buildChildren (line 1268) | def buildChildren(self, child_, nodeName_):
class reimplementType (line 1280) | class reimplementType(GeneratedsSuper):
method __init__ (line 1283) | def __init__(self, refid=None, valueOf_='', mixedclass_=None, content_...
method factory (line 1293) | def factory(*args_, **kwargs_):
method get_refid (line 1299) | def get_refid(self): return self.refid
method set_refid (line 1300) | def set_refid(self, refid): self.refid = refid
method getValueOf_ (line 1301) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 1302) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 1303) | def export(self, outfile, level, namespace_='', name_='reimplementType...
method exportAttributes (line 1310) | def exportAttributes(self, outfile, level, namespace_='', name_='reimp...
method exportChildren (line 1313) | def exportChildren(self, outfile, level, namespace_='', name_='reimple...
method hasContent_ (line 1321) | def hasContent_(self):
method exportLiteral (line 1328) | def exportLiteral(self, outfile, level, name_='reimplementType'):
method exportLiteralAttributes (line 1333) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 1337) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 1340) | def build(self, node_):
method buildAttributes (line 1347) | def buildAttributes(self, attrs):
method buildChildren (line 1350) | def buildChildren(self, child_, nodeName_):
class incType (line 1362) | class incType(GeneratedsSuper):
method __init__ (line 1365) | def __init__(self, local=None, refid=None, valueOf_='', mixedclass_=No...
method factory (line 1376) | def factory(*args_, **kwargs_):
method get_local (line 1382) | def get_local(self): return self.local
method set_local (line 1383) | def set_local(self, local): self.local = local
method get_refid (line 1384) | def get_refid(self): return self.refid
method set_refid (line 1385) | def set_refid(self, refid): self.refid = refid
method getValueOf_ (line 1386) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 1387) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 1388) | def export(self, outfile, level, namespace_='', name_='incType', names...
method exportAttributes (line 1395) | def exportAttributes(self, outfile, level, namespace_='', name_='incTy...
method exportChildren (line 1400) | def exportChildren(self, outfile, level, namespace_='', name_='incType'):
method hasContent_ (line 1408) | def hasContent_(self):
method exportLiteral (line 1415) | def exportLiteral(self, outfile, level, name_='incType'):
method exportLiteralAttributes (line 1420) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 1427) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 1430) | def build(self, node_):
method buildAttributes (line 1437) | def buildAttributes(self, attrs):
method buildChildren (line 1442) | def buildChildren(self, child_, nodeName_):
class refType (line 1454) | class refType(GeneratedsSuper):
method __init__ (line 1457) | def __init__(self, prot=None, refid=None, valueOf_='', mixedclass_=Non...
method factory (line 1468) | def factory(*args_, **kwargs_):
method get_prot (line 1474) | def get_prot(self): return self.prot
method set_prot (line 1475) | def set_prot(self, prot): self.prot = prot
method get_refid (line 1476) | def get_refid(self): return self.refid
method set_refid (line 1477) | def set_refid(self, refid): self.refid = refid
method getValueOf_ (line 1478) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 1479) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 1480) | def export(self, outfile, level, namespace_='', name_='refType', names...
method exportAttributes (line 1487) | def exportAttributes(self, outfile, level, namespace_='', name_='refTy...
method exportChildren (line 1492) | def exportChildren(self, outfile, level, namespace_='', name_='refType'):
method hasContent_ (line 1500) | def hasContent_(self):
method exportLiteral (line 1507) | def exportLiteral(self, outfile, level, name_='refType'):
method exportLiteralAttributes (line 1512) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 1519) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 1522) | def build(self, node_):
method buildAttributes (line 1529) | def buildAttributes(self, attrs):
method buildChildren (line 1534) | def buildChildren(self, child_, nodeName_):
class refTextType (line 1546) | class refTextType(GeneratedsSuper):
method __init__ (line 1549) | def __init__(self, refid=None, kindref=None, external=None, valueOf_='...
method factory (line 1561) | def factory(*args_, **kwargs_):
method get_refid (line 1567) | def get_refid(self): return self.refid
method set_refid (line 1568) | def set_refid(self, refid): self.refid = refid
method get_kindref (line 1569) | def get_kindref(self): return self.kindref
method set_kindref (line 1570) | def set_kindref(self, kindref): self.kindref = kindref
method get_external (line 1571) | def get_external(self): return self.external
method set_external (line 1572) | def set_external(self, external): self.external = external
method getValueOf_ (line 1573) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 1574) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 1575) | def export(self, outfile, level, namespace_='', name_='refTextType', n...
method exportAttributes (line 1582) | def exportAttributes(self, outfile, level, namespace_='', name_='refTe...
method exportChildren (line 1589) | def exportChildren(self, outfile, level, namespace_='', name_='refText...
method hasContent_ (line 1597) | def hasContent_(self):
method exportLiteral (line 1604) | def exportLiteral(self, outfile, level, name_='refTextType'):
method exportLiteralAttributes (line 1609) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 1619) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 1622) | def build(self, node_):
method buildAttributes (line 1629) | def buildAttributes(self, attrs):
method buildChildren (line 1636) | def buildChildren(self, child_, nodeName_):
class sectiondefType (line 1648) | class sectiondefType(GeneratedsSuper):
method __init__ (line 1651) | def __init__(self, kind=None, header=None, description=None, memberdef...
method factory (line 1659) | def factory(*args_, **kwargs_):
method get_header (line 1665) | def get_header(self): return self.header
method set_header (line 1666) | def set_header(self, header): self.header = header
method get_description (line 1667) | def get_description(self): return self.description
method set_description (line 1668) | def set_description(self, description): self.description = description
method get_memberdef (line 1669) | def get_memberdef(self): return self.memberdef
method set_memberdef (line 1670) | def set_memberdef(self, memberdef): self.memberdef = memberdef
method add_memberdef (line 1671) | def add_memberdef(self, value): self.memberdef.append(value)
method insert_memberdef (line 1672) | def insert_memberdef(self, index, value): self.memberdef[index] = value
method get_kind (line 1673) | def get_kind(self): return self.kind
method set_kind (line 1674) | def set_kind(self, kind): self.kind = kind
method export (line 1675) | def export(self, outfile, level, namespace_='', name_='sectiondefType'...
method exportAttributes (line 1686) | def exportAttributes(self, outfile, level, namespace_='', name_='secti...
method exportChildren (line 1689) | def exportChildren(self, outfile, level, namespace_='', name_='section...
method hasContent_ (line 1697) | def hasContent_(self):
method exportLiteral (line 1706) | def exportLiteral(self, outfile, level, name_='sectiondefType'):
method exportLiteralAttributes (line 1711) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 1715) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 1736) | def build(self, node_):
method buildAttributes (line 1742) | def buildAttributes(self, attrs):
method buildChildren (line 1745) | def buildChildren(self, child_, nodeName_):
class memberdefType (line 1765) | class memberdefType(GeneratedsSuper):
method __init__ (line 1768) | def __init__(self, initonly=None, kind=None, volatile=None, const=None...
method factory (line 1828) | def factory(*args_, **kwargs_):
method get_templateparamlist (line 1834) | def get_templateparamlist(self): return self.templateparamlist
method set_templateparamlist (line 1835) | def set_templateparamlist(self, templateparamlist): self.templateparam...
method get_type (line 1836) | def get_type(self): return self.type_
method set_type (line 1837) | def set_type(self, type_): self.type_ = type_
method get_definition (line 1838) | def get_definition(self): return self.definition
method set_definition (line 1839) | def set_definition(self, definition): self.definition = definition
method get_argsstring (line 1840) | def get_argsstring(self): return self.argsstring
method set_argsstring (line 1841) | def set_argsstring(self, argsstring): self.argsstring = argsstring
method get_name (line 1842) | def get_name(self): return self.name
method set_name (line 1843) | def set_name(self, name): self.name = name
method get_read (line 1844) | def get_read(self): return self.read
method set_read (line 1845) | def set_read(self, read): self.read = read
method get_write (line 1846) | def get_write(self): return self.write
method set_write (line 1847) | def set_write(self, write): self.write = write
method get_bitfield (line 1848) | def get_bitfield(self): return self.bitfield
method set_bitfield (line 1849) | def set_bitfield(self, bitfield): self.bitfield = bitfield
method get_reimplements (line 1850) | def get_reimplements(self): return self.reimplements
method set_reimplements (line 1851) | def set_reimplements(self, reimplements): self.reimplements = reimplem...
method add_reimplements (line 1852) | def add_reimplements(self, value): self.reimplements.append(value)
method insert_reimplements (line 1853) | def insert_reimplements(self, index, value): self.reimplements[index] ...
method get_reimplementedby (line 1854) | def get_reimplementedby(self): return self.reimplementedby
method set_reimplementedby (line 1855) | def set_reimplementedby(self, reimplementedby): self.reimplementedby =...
method add_reimplementedby (line 1856) | def add_reimplementedby(self, value): self.reimplementedby.append(value)
method insert_reimplementedby (line 1857) | def insert_reimplementedby(self, index, value): self.reimplementedby[i...
method get_param (line 1858) | def get_param(self): return self.param
method set_param (line 1859) | def set_param(self, param): self.param = param
method add_param (line 1860) | def add_param(self, value): self.param.append(value)
method insert_param (line 1861) | def insert_param(self, index, value): self.param[index] = value
method get_enumvalue (line 1862) | def get_enumvalue(self): return self.enumvalue
method set_enumvalue (line 1863) | def set_enumvalue(self, enumvalue): self.enumvalue = enumvalue
method add_enumvalue (line 1864) | def add_enumvalue(self, value): self.enumvalue.append(value)
method insert_enumvalue (line 1865) | def insert_enumvalue(self, index, value): self.enumvalue[index] = value
method get_initializer (line 1866) | def get_initializer(self): return self.initializer
method set_initializer (line 1867) | def set_initializer(self, initializer): self.initializer = initializer
method get_exceptions (line 1868) | def get_exceptions(self): return self.exceptions
method set_exceptions (line 1869) | def set_exceptions(self, exceptions): self.exceptions = exceptions
method get_briefdescription (line 1870) | def get_briefdescription(self): return self.briefdescription
method set_briefdescription (line 1871) | def set_briefdescription(self, briefdescription): self.briefdescriptio...
method get_detaileddescription (line 1872) | def get_detaileddescription(self): return self.detaileddescription
method set_detaileddescription (line 1873) | def set_detaileddescription(self, detaileddescription): self.detailedd...
method get_inbodydescription (line 1874) | def get_inbodydescription(self): return self.inbodydescription
method set_inbodydescription (line 1875) | def set_inbodydescription(self, inbodydescription): self.inbodydescrip...
method get_location (line 1876) | def get_location(self): return self.location
method set_location (line 1877) | def set_location(self, location): self.location = location
method get_references (line 1878) | def get_references(self): return self.references
method set_references (line 1879) | def set_references(self, references): self.references = references
method add_references (line 1880) | def add_references(self, value): self.references.append(value)
method insert_references (line 1881) | def insert_references(self, index, value): self.references[index] = value
method get_referencedby (line 1882) | def get_referencedby(self): return self.referencedby
method set_referencedby (line 1883) | def set_referencedby(self, referencedby): self.referencedby = referenc...
method add_referencedby (line 1884) | def add_referencedby(self, value): self.referencedby.append(value)
method insert_referencedby (line 1885) | def insert_referencedby(self, index, value): self.referencedby[index] ...
method get_initonly (line 1886) | def get_initonly(self): return self.initonly
method set_initonly (line 1887) | def set_initonly(self, initonly): self.initonly = initonly
method get_kind (line 1888) | def get_kind(self): return self.kind
method set_kind (line 1889) | def set_kind(self, kind): self.kind = kind
method get_volatile (line 1890) | def get_volatile(self): return self.volatile
method set_volatile (line 1891) | def set_volatile(self, volatile): self.volatile = volatile
method get_const (line 1892) | def get_const(self): return self.const
method set_const (line 1893) | def set_const(self, const): self.const = const
method get_raise (line 1894) | def get_raise(self): return self.raisexx
method set_raise (line 1895) | def set_raise(self, raisexx): self.raisexx = raisexx
method get_virt (line 1896) | def get_virt(self): return self.virt
method set_virt (line 1897) | def set_virt(self, virt): self.virt = virt
method get_readable (line 1898) | def get_readable(self): return self.readable
method set_readable (line 1899) | def set_readable(self, readable): self.readable = readable
method get_prot (line 1900) | def get_prot(self): return self.prot
method set_prot (line 1901) | def set_prot(self, prot): self.prot = prot
method get_explicit (line 1902) | def get_explicit(self): return self.explicit
method set_explicit (line 1903) | def set_explicit(self, explicit): self.explicit = explicit
method get_new (line 1904) | def get_new(self): return self.new
method set_new (line 1905) | def set_new(self, new): self.new = new
method get_final (line 1906) | def get_final(self): return self.final
method set_final (line 1907) | def set_final(self, final): self.final = final
method get_writable (line 1908) | def get_writable(self): return self.writable
method set_writable (line 1909) | def set_writable(self, writable): self.writable = writable
method get_add (line 1910) | def get_add(self): return self.add
method set_add (line 1911) | def set_add(self, add): self.add = add
method get_static (line 1912) | def get_static(self): return self.static
method set_static (line 1913) | def set_static(self, static): self.static = static
method get_remove (line 1914) | def get_remove(self): return self.remove
method set_remove (line 1915) | def set_remove(self, remove): self.remove = remove
method get_sealed (line 1916) | def get_sealed(self): return self.sealed
method set_sealed (line 1917) | def set_sealed(self, sealed): self.sealed = sealed
method get_mutable (line 1918) | def get_mutable(self): return self.mutable
method set_mutable (line 1919) | def set_mutable(self, mutable): self.mutable = mutable
method get_gettable (line 1920) | def get_gettable(self): return self.gettable
method set_gettable (line 1921) | def set_gettable(self, gettable): self.gettable = gettable
method get_inline (line 1922) | def get_inline(self): return self.inline
method set_inline (line 1923) | def set_inline(self, inline): self.inline = inline
method get_settable (line 1924) | def get_settable(self): return self.settable
method set_settable (line 1925) | def set_settable(self, settable): self.settable = settable
method get_id (line 1926) | def get_id(self): return self.id
method set_id (line 1927) | def set_id(self, id): self.id = id
method export (line 1928) | def export(self, outfile, level, namespace_='', name_='memberdefType',...
method exportAttributes (line 1939) | def exportAttributes(self, outfile, level, namespace_='', name_='membe...
method exportChildren (line 1982) | def exportChildren(self, outfile, level, namespace_='', name_='memberd...
method hasContent_ (line 2029) | def hasContent_(self):
method exportLiteral (line 2055) | def exportLiteral(self, outfile, level, name_='memberdefType'):
method exportLiteralAttributes (line 2060) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 2124) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 2257) | def build(self, node_):
method buildAttributes (line 2263) | def buildAttributes(self, attrs):
method buildChildren (line 2306) | def buildChildren(self, child_, nodeName_):
class definition (line 2416) | class definition(GeneratedsSuper):
method __init__ (line 2419) | def __init__(self, valueOf_=''):
method factory (line 2421) | def factory(*args_, **kwargs_):
method getValueOf_ (line 2427) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 2428) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 2429) | def export(self, outfile, level, namespace_='', name_='definition', na...
method exportAttributes (line 2440) | def exportAttributes(self, outfile, level, namespace_='', name_='defin...
method exportChildren (line 2442) | def exportChildren(self, outfile, level, namespace_='', name_='definit...
method hasContent_ (line 2450) | def hasContent_(self):
method exportLiteral (line 2457) | def exportLiteral(self, outfile, level, name_='definition'):
method exportLiteralAttributes (line 2462) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 2464) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 2467) | def build(self, node_):
method buildAttributes (line 2474) | def buildAttributes(self, attrs):
method buildChildren (line 2476) | def buildChildren(self, child_, nodeName_):
class argsstring (line 2484) | class argsstring(GeneratedsSuper):
method __init__ (line 2487) | def __init__(self, valueOf_=''):
method factory (line 2489) | def factory(*args_, **kwargs_):
method getValueOf_ (line 2495) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 2496) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 2497) | def export(self, outfile, level, namespace_='', name_='argsstring', na...
method exportAttributes (line 2508) | def exportAttributes(self, outfile, level, namespace_='', name_='argss...
method exportChildren (line 2510) | def exportChildren(self, outfile, level, namespace_='', name_='argsstr...
method hasContent_ (line 2518) | def hasContent_(self):
method exportLiteral (line 2525) | def exportLiteral(self, outfile, level, name_='argsstring'):
method exportLiteralAttributes (line 2530) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 2532) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 2535) | def build(self, node_):
method buildAttributes (line 2542) | def buildAttributes(self, attrs):
method buildChildren (line 2544) | def buildChildren(self, child_, nodeName_):
class read (line 2552) | class read(GeneratedsSuper):
method __init__ (line 2555) | def __init__(self, valueOf_=''):
method factory (line 2557) | def factory(*args_, **kwargs_):
method getValueOf_ (line 2563) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 2564) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 2565) | def export(self, outfile, level, namespace_='', name_='read', namespac...
method exportAttributes (line 2576) | def exportAttributes(self, outfile, level, namespace_='', name_='read'):
method exportChildren (line 2578) | def exportChildren(self, outfile, level, namespace_='', name_='read'):
method hasContent_ (line 2586) | def hasContent_(self):
method exportLiteral (line 2593) | def exportLiteral(self, outfile, level, name_='read'):
method exportLiteralAttributes (line 2598) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 2600) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 2603) | def build(self, node_):
method buildAttributes (line 2610) | def buildAttributes(self, attrs):
method buildChildren (line 2612) | def buildChildren(self, child_, nodeName_):
class write (line 2620) | class write(GeneratedsSuper):
method __init__ (line 2623) | def __init__(self, valueOf_=''):
method factory (line 2625) | def factory(*args_, **kwargs_):
method getValueOf_ (line 2631) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 2632) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 2633) | def export(self, outfile, level, namespace_='', name_='write', namespa...
method exportAttributes (line 2644) | def exportAttributes(self, outfile, level, namespace_='', name_='write'):
method exportChildren (line 2646) | def exportChildren(self, outfile, level, namespace_='', name_='write'):
method hasContent_ (line 2654) | def hasContent_(self):
method exportLiteral (line 2661) | def exportLiteral(self, outfile, level, name_='write'):
method exportLiteralAttributes (line 2666) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 2668) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 2671) | def build(self, node_):
method buildAttributes (line 2678) | def buildAttributes(self, attrs):
method buildChildren (line 2680) | def buildChildren(self, child_, nodeName_):
class bitfield (line 2688) | class bitfield(GeneratedsSuper):
method __init__ (line 2691) | def __init__(self, valueOf_=''):
method factory (line 2693) | def factory(*args_, **kwargs_):
method getValueOf_ (line 2699) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 2700) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 2701) | def export(self, outfile, level, namespace_='', name_='bitfield', name...
method exportAttributes (line 2712) | def exportAttributes(self, outfile, level, namespace_='', name_='bitfi...
method exportChildren (line 2714) | def exportChildren(self, outfile, level, namespace_='', name_='bitfiel...
method hasContent_ (line 2722) | def hasContent_(self):
method exportLiteral (line 2729) | def exportLiteral(self, outfile, level, name_='bitfield'):
method exportLiteralAttributes (line 2734) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 2736) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 2739) | def build(self, node_):
method buildAttributes (line 2746) | def buildAttributes(self, attrs):
method buildChildren (line 2748) | def buildChildren(self, child_, nodeName_):
class descriptionType (line 2756) | class descriptionType(GeneratedsSuper):
method __init__ (line 2759) | def __init__(self, title=None, para=None, sect1=None, internal=None, m...
method factory (line 2768) | def factory(*args_, **kwargs_):
method get_title (line 2774) | def get_title(self): return self.title
method set_title (line 2775) | def set_title(self, title): self.title = title
method get_para (line 2776) | def get_para(self): return self.para
method set_para (line 2777) | def set_para(self, para): self.para = para
method add_para (line 2778) | def add_para(self, value): self.para.append(value)
method insert_para (line 2779) | def insert_para(self, index, value): self.para[index] = value
method get_sect1 (line 2780) | def get_sect1(self): return self.sect1
method set_sect1 (line 2781) | def set_sect1(self, sect1): self.sect1 = sect1
method add_sect1 (line 2782) | def add_sect1(self, value): self.sect1.append(value)
method insert_sect1 (line 2783) | def insert_sect1(self, index, value): self.sect1[index] = value
method get_internal (line 2784) | def get_internal(self): return self.internal
method set_internal (line 2785) | def set_internal(self, internal): self.internal = internal
method export (line 2786) | def export(self, outfile, level, namespace_='', name_='descriptionType...
method exportAttributes (line 2793) | def exportAttributes(self, outfile, level, namespace_='', name_='descr...
method exportChildren (line 2795) | def exportChildren(self, outfile, level, namespace_='', name_='descrip...
method hasContent_ (line 2798) | def hasContent_(self):
method exportLiteral (line 2808) | def exportLiteral(self, outfile, level, name_='descriptionType'):
method exportLiteralAttributes (line 2813) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 2815) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 2840) | def build(self, node_):
method buildAttributes (line 2846) | def buildAttributes(self, attrs):
method buildChildren (line 2848) | def buildChildren(self, child_, nodeName_):
class enumvalueType (line 2884) | class enumvalueType(GeneratedsSuper):
method __init__ (line 2887) | def __init__(self, prot=None, id=None, name=None, initializer=None, br...
method factory (line 2898) | def factory(*args_, **kwargs_):
method get_name (line 2904) | def get_name(self): return self.name
method set_name (line 2905) | def set_name(self, name): self.name = name
method get_initializer (line 2906) | def get_initializer(self): return self.initializer
method set_initializer (line 2907) | def set_initializer(self, initializer): self.initializer = initializer
method get_briefdescription (line 2908) | def get_briefdescription(self): return self.briefdescription
method set_briefdescription (line 2909) | def set_briefdescription(self, briefdescription): self.briefdescriptio...
method get_detaileddescription (line 2910) | def get_detaileddescription(self): return self.detaileddescription
method set_detaileddescription (line 2911) | def set_detaileddescription(self, detaileddescription): self.detailedd...
method get_prot (line 2912) | def get_prot(self): return self.prot
method set_prot (line 2913) | def set_prot(self, prot): self.prot = prot
method get_id (line 2914) | def get_id(self): return self.id
method set_id (line 2915) | def set_id(self, id): self.id = id
method export (line 2916) | def export(self, outfile, level, namespace_='', name_='enumvalueType',...
method exportAttributes (line 2923) | def exportAttributes(self, outfile, level, namespace_='', name_='enumv...
method exportChildren (line 2928) | def exportChildren(self, outfile, level, namespace_='', name_='enumval...
method hasContent_ (line 2931) | def hasContent_(self):
method exportLiteral (line 2941) | def exportLiteral(self, outfile, level, name_='enumvalueType'):
method exportLiteralAttributes (line 2946) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 2953) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 2978) | def build(self, node_):
method buildAttributes (line 2984) | def buildAttributes(self, attrs):
method buildChildren (line 2989) | def buildChildren(self, child_, nodeName_):
class templateparamlistType (line 3027) | class templateparamlistType(GeneratedsSuper):
method __init__ (line 3030) | def __init__(self, param=None):
method factory (line 3035) | def factory(*args_, **kwargs_):
method get_param (line 3041) | def get_param(self): return self.param
method set_param (line 3042) | def set_param(self, param): self.param = param
method add_param (line 3043) | def add_param(self, value): self.param.append(value)
method insert_param (line 3044) | def insert_param(self, index, value): self.param[index] = value
method export (line 3045) | def export(self, outfile, level, namespace_='', name_='templateparamli...
method exportAttributes (line 3056) | def exportAttributes(self, outfile, level, namespace_='', name_='templ...
method exportChildren (line 3058) | def exportChildren(self, outfile, level, namespace_='', name_='templat...
method hasContent_ (line 3061) | def hasContent_(self):
method exportLiteral (line 3068) | def exportLiteral(self, outfile, level, name_='templateparamlistType'):
method exportLiteralAttributes (line 3073) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 3075) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 3088) | def build(self, node_):
method buildAttributes (line 3094) | def buildAttributes(self, attrs):
method buildChildren (line 3096) | def buildChildren(self, child_, nodeName_):
class paramType (line 3105) | class paramType(GeneratedsSuper):
method __init__ (line 3108) | def __init__(self, type_=None, declname=None, defname=None, array=None...
method factory (line 3115) | def factory(*args_, **kwargs_):
method get_type (line 3121) | def get_type(self): return self.type_
method set_type (line 3122) | def set_type(self, type_): self.type_ = type_
method get_declname (line 3123) | def get_declname(self): return self.declname
method set_declname (line 3124) | def set_declname(self, declname): self.declname = declname
method get_defname (line 3125) | def get_defname(self): return self.defname
method set_defname (line 3126) | def set_defname(self, defname): self.defname = defname
method get_array (line 3127) | def get_array(self): return self.array
method set_array (line 3128) | def set_array(self, array): self.array = array
method get_defval (line 3129) | def get_defval(self): return self.defval
method set_defval (line 3130) | def set_defval(self, defval): self.defval = defval
method get_briefdescription (line 3131) | def get_briefdescription(self): return self.briefdescription
method set_briefdescription (line 3132) | def set_briefdescription(self, briefdescription): self.briefdescriptio...
method export (line 3133) | def export(self, outfile, level, namespace_='', name_='paramType', nam...
method exportAttributes (line 3144) | def exportAttributes(self, outfile, level, namespace_='', name_='param...
method exportChildren (line 3146) | def exportChildren(self, outfile, level, namespace_='', name_='paramTy...
method hasContent_ (line 3162) | def hasContent_(self):
method exportLiteral (line 3174) | def exportLiteral(self, outfile, level, name_='paramType'):
method exportLiteralAttributes (line 3179) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 3181) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 3206) | def build(self, node_):
method buildAttributes (line 3212) | def buildAttributes(self, attrs):
method buildChildren (line 3214) | def buildChildren(self, child_, nodeName_):
class declname (line 3251) | class declname(GeneratedsSuper):
method __init__ (line 3254) | def __init__(self, valueOf_=''):
method factory (line 3256) | def factory(*args_, **kwargs_):
method getValueOf_ (line 3262) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 3263) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 3264) | def export(self, outfile, level, namespace_='', name_='declname', name...
method exportAttributes (line 3275) | def exportAttributes(self, outfile, level, namespace_='', name_='decln...
method exportChildren (line 3277) | def exportChildren(self, outfile, level, namespace_='', name_='declnam...
method hasContent_ (line 3285) | def hasContent_(self):
method exportLiteral (line 3292) | def exportLiteral(self, outfile, level, name_='declname'):
method exportLiteralAttributes (line 3297) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 3299) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 3302) | def build(self, node_):
method buildAttributes (line 3309) | def buildAttributes(self, attrs):
method buildChildren (line 3311) | def buildChildren(self, child_, nodeName_):
class defname (line 3319) | class defname(GeneratedsSuper):
method __init__ (line 3322) | def __init__(self, valueOf_=''):
method factory (line 3324) | def factory(*args_, **kwargs_):
method getValueOf_ (line 3330) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 3331) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 3332) | def export(self, outfile, level, namespace_='', name_='defname', names...
method exportAttributes (line 3343) | def exportAttributes(self, outfile, level, namespace_='', name_='defna...
method exportChildren (line 3345) | def exportChildren(self, outfile, level, namespace_='', name_='defname'):
method hasContent_ (line 3353) | def hasContent_(self):
method exportLiteral (line 3360) | def exportLiteral(self, outfile, level, name_='defname'):
method exportLiteralAttributes (line 3365) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 3367) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 3370) | def build(self, node_):
method buildAttributes (line 3377) | def buildAttributes(self, attrs):
method buildChildren (line 3379) | def buildChildren(self, child_, nodeName_):
class array (line 3387) | class array(GeneratedsSuper):
method __init__ (line 3390) | def __init__(self, valueOf_=''):
method factory (line 3392) | def factory(*args_, **kwargs_):
method getValueOf_ (line 3398) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 3399) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 3400) | def export(self, outfile, level, namespace_='', name_='array', namespa...
method exportAttributes (line 3411) | def exportAttributes(self, outfile, level, namespace_='', name_='array'):
method exportChildren (line 3413) | def exportChildren(self, outfile, level, namespace_='', name_='array'):
method hasContent_ (line 3421) | def hasContent_(self):
method exportLiteral (line 3428) | def exportLiteral(self, outfile, level, name_='array'):
method exportLiteralAttributes (line 3433) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 3435) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 3438) | def build(self, node_):
method buildAttributes (line 3445) | def buildAttributes(self, attrs):
method buildChildren (line 3447) | def buildChildren(self, child_, nodeName_):
class linkedTextType (line 3455) | class linkedTextType(GeneratedsSuper):
method __init__ (line 3458) | def __init__(self, ref=None, mixedclass_=None, content_=None):
method factory (line 3467) | def factory(*args_, **kwargs_):
method get_ref (line 3473) | def get_ref(self): return self.ref
method set_ref (line 3474) | def set_ref(self, ref): self.ref = ref
method add_ref (line 3475) | def add_ref(self, value): self.ref.append(value)
method insert_ref (line 3476) | def insert_ref(self, index, value): self.ref[index] = value
method export (line 3477) | def export(self, outfile, level, namespace_='', name_='linkedTextType'...
method exportAttributes (line 3484) | def exportAttributes(self, outfile, level, namespace_='', name_='linke...
method exportChildren (line 3486) | def exportChildren(self, outfile, level, namespace_='', name_='linkedT...
method hasContent_ (line 3489) | def hasContent_(self):
method exportLiteral (line 3496) | def exportLiteral(self, outfile, level, name_='linkedTextType'):
method exportLiteralAttributes (line 3501) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 3503) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 3510) | def build(self, node_):
method buildAttributes (line 3516) | def buildAttributes(self, attrs):
method buildChildren (line 3518) | def buildChildren(self, child_, nodeName_):
class graphType (line 3533) | class graphType(GeneratedsSuper):
method __init__ (line 3536) | def __init__(self, node=None):
method factory (line 3541) | def factory(*args_, **kwargs_):
method get_node (line 3547) | def get_node(self): return self.node
method set_node (line 3548) | def set_node(self, node): self.node = node
method add_node (line 3549) | def add_node(self, value): self.node.append(value)
method insert_node (line 3550) | def insert_node(self, index, value): self.node[index] = value
method export (line 3551) | def export(self, outfile, level, namespace_='', name_='graphType', nam...
method exportAttributes (line 3562) | def exportAttributes(self, outfile, level, namespace_='', name_='graph...
method exportChildren (line 3564) | def exportChildren(self, outfile, level, namespace_='', name_='graphTy...
method hasContent_ (line 3567) | def hasContent_(self):
method exportLiteral (line 3574) | def exportLiteral(self, outfile, level, name_='graphType'):
method exportLiteralAttributes (line 3579) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 3581) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 3594) | def build(self, node_):
method buildAttributes (line 3600) | def buildAttributes(self, attrs):
method buildChildren (line 3602) | def buildChildren(self, child_, nodeName_):
class nodeType (line 3611) | class nodeType(GeneratedsSuper):
method __init__ (line 3614) | def __init__(self, id=None, label=None, link=None, childnode=None):
method factory (line 3622) | def factory(*args_, **kwargs_):
method get_label (line 3628) | def get_label(self): return self.label
method set_label (line 3629) | def set_label(self, label): self.label = label
method get_link (line 3630) | def get_link(self): return self.link
method set_link (line 3631) | def set_link(self, link): self.link = link
method get_childnode (line 3632) | def get_childnode(self): return self.childnode
method set_childnode (line 3633) | def set_childnode(self, childnode): self.childnode = childnode
method add_childnode (line 3634) | def add_childnode(self, value): self.childnode.append(value)
method insert_childnode (line 3635) | def insert_childnode(self, index, value): self.childnode[index] = value
method get_id (line 3636) | def get_id(self): return self.id
method set_id (line 3637) | def set_id(self, id): self.id = id
method export (line 3638) | def export(self, outfile, level, namespace_='', name_='nodeType', name...
method exportAttributes (line 3649) | def exportAttributes(self, outfile, level, namespace_='', name_='nodeT...
method exportChildren (line 3652) | def exportChildren(self, outfile, level, namespace_='', name_='nodeTyp...
method hasContent_ (line 3660) | def hasContent_(self):
method exportLiteral (line 3669) | def exportLiteral(self, outfile, level, name_='nodeType'):
method exportLiteralAttributes (line 3674) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 3678) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 3699) | def build(self, node_):
method buildAttributes (line 3705) | def buildAttributes(self, attrs):
method buildChildren (line 3708) | def buildChildren(self, child_, nodeName_):
class label (line 3728) | class label(GeneratedsSuper):
method __init__ (line 3731) | def __init__(self, valueOf_=''):
method factory (line 3733) | def factory(*args_, **kwargs_):
method getValueOf_ (line 3739) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 3740) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 3741) | def export(self, outfile, level, namespace_='', name_='label', namespa...
method exportAttributes (line 3752) | def exportAttributes(self, outfile, level, namespace_='', name_='label'):
method exportChildren (line 3754) | def exportChildren(self, outfile, level, namespace_='', name_='label'):
method hasContent_ (line 3762) | def hasContent_(self):
method exportLiteral (line 3769) | def exportLiteral(self, outfile, level, name_='label'):
method exportLiteralAttributes (line 3774) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 3776) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 3779) | def build(self, node_):
method buildAttributes (line 3786) | def buildAttributes(self, attrs):
method buildChildren (line 3788) | def buildChildren(self, child_, nodeName_):
class childnodeType (line 3796) | class childnodeType(GeneratedsSuper):
method __init__ (line 3799) | def __init__(self, relation=None, refid=None, edgelabel=None):
method factory (line 3806) | def factory(*args_, **kwargs_):
method get_edgelabel (line 3812) | def get_edgelabel(self): return self.edgelabel
method set_edgelabel (line 3813) | def set_edgelabel(self, edgelabel): self.edgelabel = edgelabel
method add_edgelabel (line 3814) | def add_edgelabel(self, value): self.edgelabel.append(value)
method insert_edgelabel (line 3815) | def insert_edgelabel(self, index, value): self.edgelabel[index] = value
method get_relation (line 3816) | def get_relation(self): return self.relation
method set_relation (line 3817) | def set_relation(self, relation): self.relation = relation
method get_refid (line 3818) | def get_refid(self): return self.refid
method set_refid (line 3819) | def set_refid(self, refid): self.refid = refid
method export (line 3820) | def export(self, outfile, level, namespace_='', name_='childnodeType',...
method exportAttributes (line 3831) | def exportAttributes(self, outfile, level, namespace_='', name_='child...
method exportChildren (line 3836) | def exportChildren(self, outfile, level, namespace_='', name_='childno...
method hasContent_ (line 3840) | def hasContent_(self):
method exportLiteral (line 3847) | def exportLiteral(self, outfile, level, name_='childnodeType'):
method exportLiteralAttributes (line 3852) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 3859) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 3869) | def build(self, node_):
method buildAttributes (line 3875) | def buildAttributes(self, attrs):
method buildChildren (line 3880) | def buildChildren(self, child_, nodeName_):
class edgelabel (line 3890) | class edgelabel(GeneratedsSuper):
method __init__ (line 3893) | def __init__(self, valueOf_=''):
method factory (line 3895) | def factory(*args_, **kwargs_):
method getValueOf_ (line 3901) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 3902) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 3903) | def export(self, outfile, level, namespace_='', name_='edgelabel', nam...
method exportAttributes (line 3914) | def exportAttributes(self, outfile, level, namespace_='', name_='edgel...
method exportChildren (line 3916) | def exportChildren(self, outfile, level, namespace_='', name_='edgelab...
method hasContent_ (line 3924) | def hasContent_(self):
method exportLiteral (line 3931) | def exportLiteral(self, outfile, level, name_='edgelabel'):
method exportLiteralAttributes (line 3936) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 3938) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 3941) | def build(self, node_):
method buildAttributes (line 3948) | def buildAttributes(self, attrs):
method buildChildren (line 3950) | def buildChildren(self, child_, nodeName_):
class linkType (line 3958) | class linkType(GeneratedsSuper):
method __init__ (line 3961) | def __init__(self, refid=None, external=None, valueOf_=''):
method factory (line 3965) | def factory(*args_, **kwargs_):
method get_refid (line 3971) | def get_refid(self): return self.refid
method set_refid (line 3972) | def set_refid(self, refid): self.refid = refid
method get_external (line 3973) | def get_external(self): return self.external
method set_external (line 3974) | def set_external(self, external): self.external = external
method getValueOf_ (line 3975) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 3976) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 3977) | def export(self, outfile, level, namespace_='', name_='linkType', name...
method exportAttributes (line 3988) | def exportAttributes(self, outfile, level, namespace_='', name_='linkT...
method exportChildren (line 3993) | def exportChildren(self, outfile, level, namespace_='', name_='linkTyp...
method hasContent_ (line 4001) | def hasContent_(self):
method exportLiteral (line 4008) | def exportLiteral(self, outfile, level, name_='linkType'):
method exportLiteralAttributes (line 4013) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 4020) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 4023) | def build(self, node_):
method buildAttributes (line 4030) | def buildAttributes(self, attrs):
method buildChildren (line 4035) | def buildChildren(self, child_, nodeName_):
class listingType (line 4043) | class listingType(GeneratedsSuper):
method __init__ (line 4046) | def __init__(self, codeline=None):
method factory (line 4051) | def factory(*args_, **kwargs_):
method get_codeline (line 4057) | def get_codeline(self): return self.codeline
method set_codeline (line 4058) | def set_codeline(self, codeline): self.codeline = codeline
method add_codeline (line 4059) | def add_codeline(self, value): self.codeline.append(value)
method insert_codeline (line 4060) | def insert_codeline(self, index, value): self.codeline[index] = value
method export (line 4061) | def export(self, outfile, level, namespace_='', name_='listingType', n...
method exportAttributes (line 4072) | def exportAttributes(self, outfile, level, namespace_='', name_='listi...
method exportChildren (line 4074) | def exportChildren(self, outfile, level, namespace_='', name_='listing...
method hasContent_ (line 4077) | def hasContent_(self):
method exportLiteral (line 4084) | def exportLiteral(self, outfile, level, name_='listingType'):
method exportLiteralAttributes (line 4089) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 4091) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 4104) | def build(self, node_):
method buildAttributes (line 4110) | def buildAttributes(self, attrs):
method buildChildren (line 4112) | def buildChildren(self, child_, nodeName_):
class codelineType (line 4121) | class codelineType(GeneratedsSuper):
method __init__ (line 4124) | def __init__(self, external=None, lineno=None, refkind=None, refid=Non...
method factory (line 4133) | def factory(*args_, **kwargs_):
method get_highlight (line 4139) | def get_highlight(self): return self.highlight
method set_highlight (line 4140) | def set_highlight(self, highlight): self.highlight = highlight
method add_highlight (line 4141) | def add_highlight(self, value): self.highlight.append(value)
method insert_highlight (line 4142) | def insert_highlight(self, index, value): self.highlight[index] = value
method get_external (line 4143) | def get_external(self): return self.external
method set_external (line 4144) | def set_external(self, external): self.external = external
method get_lineno (line 4145) | def get_lineno(self): return self.lineno
method set_lineno (line 4146) | def set_lineno(self, lineno): self.lineno = lineno
method get_refkind (line 4147) | def get_refkind(self): return self.refkind
method set_refkind (line 4148) | def set_refkind(self, refkind): self.refkind = refkind
method get_refid (line 4149) | def get_refid(self): return self.refid
method set_refid (line 4150) | def set_refid(self, refid): self.refid = refid
method export (line 4151) | def export(self, outfile, level, namespace_='', name_='codelineType', ...
method exportAttributes (line 4162) | def exportAttributes(self, outfile, level, namespace_='', name_='codel...
method exportChildren (line 4171) | def exportChildren(self, outfile, level, namespace_='', name_='codelin...
method hasContent_ (line 4174) | def hasContent_(self):
method exportLiteral (line 4181) | def exportLiteral(self, outfile, level, name_='codelineType'):
method exportLiteralAttributes (line 4186) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 4199) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 4212) | def build(self, node_):
method buildAttributes (line 4218) | def buildAttributes(self, attrs):
method buildChildren (line 4230) | def buildChildren(self, child_, nodeName_):
class highlightType (line 4239) | class highlightType(GeneratedsSuper):
method __init__ (line 4242) | def __init__(self, classxx=None, sp=None, ref=None, mixedclass_=None, ...
method factory (line 4252) | def factory(*args_, **kwargs_):
method get_sp (line 4258) | def get_sp(self): return self.sp
method set_sp (line 4259) | def set_sp(self, sp): self.sp = sp
method add_sp (line 4260) | def add_sp(self, value): self.sp.append(value)
method insert_sp (line 4261) | def insert_sp(self, index, value): self.sp[index] = value
method get_ref (line 4262) | def get_ref(self): return self.ref
method set_ref (line 4263) | def set_ref(self, ref): self.ref = ref
method add_ref (line 4264) | def add_ref(self, value): self.ref.append(value)
method insert_ref (line 4265) | def insert_ref(self, index, value): self.ref[index] = value
method get_class (line 4266) | def get_class(self): return self.classxx
method set_class (line 4267) | def set_class(self, classxx): self.classxx = classxx
method export (line 4268) | def export(self, outfile, level, namespace_='', name_='highlightType',...
method exportAttributes (line 4275) | def exportAttributes(self, outfile, level, namespace_='', name_='highl...
method exportChildren (line 4278) | def exportChildren(self, outfile, level, namespace_='', name_='highlig...
method hasContent_ (line 4281) | def hasContent_(self):
method exportLiteral (line 4289) | def exportLiteral(self, outfile, level, name_='highlightType'):
method exportLiteralAttributes (line 4294) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 4298) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 4311) | def build(self, node_):
method buildAttributes (line 4317) | def buildAttributes(self, attrs):
method buildChildren (line 4320) | def buildChildren(self, child_, nodeName_):
class sp (line 4344) | class sp(GeneratedsSuper):
method __init__ (line 4347) | def __init__(self, valueOf_=''):
method factory (line 4349) | def factory(*args_, **kwargs_):
method getValueOf_ (line 4355) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 4356) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 4357) | def export(self, outfile, level, namespace_='', name_='sp', namespaced...
method exportAttributes (line 4368) | def exportAttributes(self, outfile, level, namespace_='', name_='sp'):
method exportChildren (line 4370) | def exportChildren(self, outfile, level, namespace_='', name_='sp'):
method hasContent_ (line 4378) | def hasContent_(self):
method exportLiteral (line 4385) | def exportLiteral(self, outfile, level, name_='sp'):
method exportLiteralAttributes (line 4390) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 4392) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 4395) | def build(self, node_):
method buildAttributes (line 4402) | def buildAttributes(self, attrs):
method buildChildren (line 4404) | def buildChildren(self, child_, nodeName_):
class referenceType (line 4412) | class referenceType(GeneratedsSuper):
method __init__ (line 4415) | def __init__(self, endline=None, startline=None, refid=None, compoundr...
method factory (line 4428) | def factory(*args_, **kwargs_):
method get_endline (line 4434) | def get_endline(self): return self.endline
method set_endline (line 4435) | def set_endline(self, endline): self.endline = endline
method get_startline (line 4436) | def get_startline(self): return self.startline
method set_startline (line 4437) | def set_startline(self, startline): self.startline = startline
method get_refid (line 4438) | def get_refid(self): return self.refid
method set_refid (line 4439) | def set_refid(self, refid): self.refid = refid
method get_compoundref (line 4440) | def get_compoundref(self): return self.compoundref
method set_compoundref (line 4441) | def set_compoundref(self, compoundref): self.compoundref = compoundref
method getValueOf_ (line 4442) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 4443) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 4444) | def export(self, outfile, level, namespace_='', name_='referenceType',...
method exportAttributes (line 4451) | def exportAttributes(self, outfile, level, namespace_='', name_='refer...
method exportChildren (line 4460) | def exportChildren(self, outfile, level, namespace_='', name_='referen...
method hasContent_ (line 4468) | def hasContent_(self):
method exportLiteral (line 4475) | def exportLiteral(self, outfile, level, name_='referenceType'):
method exportLiteralAttributes (line 4480) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 4493) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 4496) | def build(self, node_):
method buildAttributes (line 4503) | def buildAttributes(self, attrs):
method buildChildren (line 4518) | def buildChildren(self, child_, nodeName_):
class locationType (line 4530) | class locationType(GeneratedsSuper):
method __init__ (line 4533) | def __init__(self, bodystart=None, line=None, bodyend=None, bodyfile=N...
method factory (line 4540) | def factory(*args_, **kwargs_):
method get_bodystart (line 4546) | def get_bodystart(self): return self.bodystart
method set_bodystart (line 4547) | def set_bodystart(self, bodystart): self.bodystart = bodystart
method get_line (line 4548) | def get_line(self): return self.line
method set_line (line 4549) | def set_line(self, line): self.line = line
method get_bodyend (line 4550) | def get_bodyend(self): return self.bodyend
method set_bodyend (line 4551) | def set_bodyend(self, bodyend): self.bodyend = bodyend
method get_bodyfile (line 4552) | def get_bodyfile(self): return self.bodyfile
method set_bodyfile (line 4553) | def set_bodyfile(self, bodyfile): self.bodyfile = bodyfile
method get_file (line 4554) | def get_file(self): return self.file
method set_file (line 4555) | def set_file(self, file): self.file = file
method getValueOf_ (line 4556) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 4557) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 4558) | def export(self, outfile, level, namespace_='', name_='locationType', ...
method exportAttributes (line 4569) | def exportAttributes(self, outfile, level, namespace_='', name_='locat...
method exportChildren (line 4580) | def exportChildren(self, outfile, level, namespace_='', name_='locatio...
method hasContent_ (line 4588) | def hasContent_(self):
method exportLiteral (line 4595) | def exportLiteral(self, outfile, level, name_='locationType'):
method exportLiteralAttributes (line 4600) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 4616) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 4619) | def build(self, node_):
method buildAttributes (line 4626) | def buildAttributes(self, attrs):
method buildChildren (line 4646) | def buildChildren(self, child_, nodeName_):
class docSect1Type (line 4654) | class docSect1Type(GeneratedsSuper):
method __init__ (line 4657) | def __init__(self, id=None, title=None, para=None, sect2=None, interna...
method factory (line 4667) | def factory(*args_, **kwargs_):
method get_title (line 4673) | def get_title(self): return self.title
method set_title (line 4674) | def set_title(self, title): self.title = title
method get_para (line 4675) | def get_para(self): return self.para
method set_para (line 4676) | def set_para(self, para): self.para = para
method add_para (line 4677) | def add_para(self, value): self.para.append(value)
method insert_para (line 4678) | def insert_para(self, index, value): self.para[index] = value
method get_sect2 (line 4679) | def get_sect2(self): return self.sect2
method set_sect2 (line 4680) | def set_sect2(self, sect2): self.sect2 = sect2
method add_sect2 (line 4681) | def add_sect2(self, value): self.sect2.append(value)
method insert_sect2 (line 4682) | def insert_sect2(self, index, value): self.sect2[index] = value
method get_internal (line 4683) | def get_internal(self): return self.internal
method set_internal (line 4684) | def set_internal(self, internal): self.internal = internal
method get_id (line 4685) | def get_id(self): return self.id
method set_id (line 4686) | def set_id(self, id): self.id = id
method export (line 4687) | def export(self, outfile, level, namespace_='', name_='docSect1Type', ...
method exportAttributes (line 4694) | def exportAttributes(self, outfile, level, namespace_='', name_='docSe...
method exportChildren (line 4697) | def exportChildren(self, outfile, level, namespace_='', name_='docSect...
method hasContent_ (line 4700) | def hasContent_(self):
method exportLiteral (line 4710) | def exportLiteral(self, outfile, level, name_='docSect1Type'):
method exportLiteralAttributes (line 4715) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 4719) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 4744) | def build(self, node_):
method buildAttributes (line 4750) | def buildAttributes(self, attrs):
method buildChildren (line 4753) | def buildChildren(self, child_, nodeName_):
class docSect2Type (line 4789) | class docSect2Type(GeneratedsSuper):
method __init__ (line 4792) | def __init__(self, id=None, title=None, para=None, sect3=None, interna...
method factory (line 4802) | def factory(*args_, **kwargs_):
method get_title (line 4808) | def get_title(self): return self.title
method set_title (line 4809) | def set_title(self, title): self.title = title
method get_para (line 4810) | def get_para(self): return self.para
method set_para (line 4811) | def set_para(self, para): self.para = para
method add_para (line 4812) | def add_para(self, value): self.para.append(value)
method insert_para (line 4813) | def insert_para(self, index, value): self.para[index] = value
method get_sect3 (line 4814) | def get_sect3(self): return self.sect3
method set_sect3 (line 4815) | def set_sect3(self, sect3): self.sect3 = sect3
method add_sect3 (line 4816) | def add_sect3(self, value): self.sect3.append(value)
method insert_sect3 (line 4817) | def insert_sect3(self, index, value): self.sect3[index] = value
method get_internal (line 4818) | def get_internal(self): return self.internal
method set_internal (line 4819) | def set_internal(self, internal): self.internal = internal
method get_id (line 4820) | def get_id(self): return self.id
method set_id (line 4821) | def set_id(self, id): self.id = id
method export (line 4822) | def export(self, outfile, level, namespace_='', name_='docSect2Type', ...
method exportAttributes (line 4829) | def exportAttributes(self, outfile, level, namespace_='', name_='docSe...
method exportChildren (line 4832) | def exportChildren(self, outfile, level, namespace_='', name_='docSect...
method hasContent_ (line 4835) | def hasContent_(self):
method exportLiteral (line 4845) | def exportLiteral(self, outfile, level, name_='docSect2Type'):
method exportLiteralAttributes (line 4850) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 4854) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 4879) | def build(self, node_):
method buildAttributes (line 4885) | def buildAttributes(self, attrs):
method buildChildren (line 4888) | def buildChildren(self, child_, nodeName_):
class docSect3Type (line 4924) | class docSect3Type(GeneratedsSuper):
method __init__ (line 4927) | def __init__(self, id=None, title=None, para=None, sect4=None, interna...
method factory (line 4937) | def factory(*args_, **kwargs_):
method get_title (line 4943) | def get_title(self): return self.title
method set_title (line 4944) | def set_title(self, title): self.title = title
method get_para (line 4945) | def get_para(self): return self.para
method set_para (line 4946) | def set_para(self, para): self.para = para
method add_para (line 4947) | def add_para(self, value): self.para.append(value)
method insert_para (line 4948) | def insert_para(self, index, value): self.para[index] = value
method get_sect4 (line 4949) | def get_sect4(self): return self.sect4
method set_sect4 (line 4950) | def set_sect4(self, sect4): self.sect4 = sect4
method add_sect4 (line 4951) | def add_sect4(self, value): self.sect4.append(value)
method insert_sect4 (line 4952) | def insert_sect4(self, index, value): self.sect4[index] = value
method get_internal (line 4953) | def get_internal(self): return self.internal
method set_internal (line 4954) | def set_internal(self, internal): self.internal = internal
method get_id (line 4955) | def get_id(self): return self.id
method set_id (line 4956) | def set_id(self, id): self.id = id
method export (line 4957) | def export(self, outfile, level, namespace_='', name_='docSect3Type', ...
method exportAttributes (line 4964) | def exportAttributes(self, outfile, level, namespace_='', name_='docSe...
method exportChildren (line 4967) | def exportChildren(self, outfile, level, namespace_='', name_='docSect...
method hasContent_ (line 4970) | def hasContent_(self):
method exportLiteral (line 4980) | def exportLiteral(self, outfile, level, name_='docSect3Type'):
method exportLiteralAttributes (line 4985) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 4989) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 5014) | def build(self, node_):
method buildAttributes (line 5020) | def buildAttributes(self, attrs):
method buildChildren (line 5023) | def buildChildren(self, child_, nodeName_):
class docSect4Type (line 5059) | class docSect4Type(GeneratedsSuper):
method __init__ (line 5062) | def __init__(self, id=None, title=None, para=None, internal=None, mixe...
method factory (line 5072) | def factory(*args_, **kwargs_):
method get_title (line 5078) | def get_title(self): return self.title
method set_title (line 5079) | def set_title(self, title): self.title = title
method get_para (line 5080) | def get_para(self): return self.para
method set_para (line 5081) | def set_para(self, para): self.para = para
method add_para (line 5082) | def add_para(self, value): self.para.append(value)
method insert_para (line 5083) | def insert_para(self, index, value): self.para[index] = value
method get_internal (line 5084) | def get_internal(self): return self.internal
method set_internal (line 5085) | def set_internal(self, internal): self.internal = internal
method get_id (line 5086) | def get_id(self): return self.id
method set_id (line 5087) | def set_id(self, id): self.id = id
method export (line 5088) | def export(self, outfile, level, namespace_='', name_='docSect4Type', ...
method exportAttributes (line 5095) | def exportAttributes(self, outfile, level, namespace_='', name_='docSe...
method exportChildren (line 5098) | def exportChildren(self, outfile, level, namespace_='', name_='docSect...
method hasContent_ (line 5101) | def hasContent_(self):
method exportLiteral (line 5110) | def exportLiteral(self, outfile, level, name_='docSect4Type'):
method exportLiteralAttributes (line 5115) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 5119) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 5138) | def build(self, node_):
method buildAttributes (line 5144) | def buildAttributes(self, attrs):
method buildChildren (line 5147) | def buildChildren(self, child_, nodeName_):
class docInternalType (line 5176) | class docInternalType(GeneratedsSuper):
method __init__ (line 5179) | def __init__(self, para=None, sect1=None, mixedclass_=None, content_=N...
method factory (line 5188) | def factory(*args_, **kwargs_):
method get_para (line 5194) | def get_para(self): return self.para
method set_para (line 5195) | def set_para(self, para): self.para = para
method add_para (line 5196) | def add_para(self, value): self.para.append(value)
method insert_para (line 5197) | def insert_para(self, index, value): self.para[index] = value
method get_sect1 (line 5198) | def get_sect1(self): return self.sect1
method set_sect1 (line 5199) | def set_sect1(self, sect1): self.sect1 = sect1
method add_sect1 (line 5200) | def add_sect1(self, value): self.sect1.append(value)
method insert_sect1 (line 5201) | def insert_sect1(self, index, value): self.sect1[index] = value
method export (line 5202) | def export(self, outfile, level, namespace_='', name_='docInternalType...
method exportAttributes (line 5209) | def exportAttributes(self, outfile, level, namespace_='', name_='docIn...
method exportChildren (line 5211) | def exportChildren(self, outfile, level, namespace_='', name_='docInte...
method hasContent_ (line 5214) | def hasContent_(self):
method exportLiteral (line 5222) | def exportLiteral(self, outfile, level, name_='docInternalType'):
method exportLiteralAttributes (line 5227) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 5229) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 5242) | def build(self, node_):
method buildAttributes (line 5248) | def buildAttributes(self, attrs):
method buildChildren (line 5250) | def buildChildren(self, child_, nodeName_):
class docInternalS1Type (line 5272) | class docInternalS1Type(GeneratedsSuper):
method __init__ (line 5275) | def __init__(self, para=None, sect2=None, mixedclass_=None, content_=N...
method factory (line 5284) | def factory(*args_, **kwargs_):
method get_para (line 5290) | def get_para(self): return self.para
method set_para (line 5291) | def set_para(self, para): self.para = para
method add_para (line 5292) | def add_para(self, value): self.para.append(value)
method insert_para (line 5293) | def insert_para(self, index, value): self.para[index] = value
method get_sect2 (line 5294) | def get_sect2(self): return self.sect2
method set_sect2 (line 5295) | def set_sect2(self, sect2): self.sect2 = sect2
method add_sect2 (line 5296) | def add_sect2(self, value): self.sect2.append(value)
method insert_sect2 (line 5297) | def insert_sect2(self, index, value): self.sect2[index] = value
method export (line 5298) | def export(self, outfile, level, namespace_='', name_='docInternalS1Ty...
method exportAttributes (line 5305) | def exportAttributes(self, outfile, level, namespace_='', name_='docIn...
method exportChildren (line 5307) | def exportChildren(self, outfile, level, namespace_='', name_='docInte...
method hasContent_ (line 5310) | def hasContent_(self):
method exportLiteral (line 5318) | def exportLiteral(self, outfile, level, name_='docInternalS1Type'):
method exportLiteralAttributes (line 5323) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 5325) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 5338) | def build(self, node_):
method buildAttributes (line 5344) | def buildAttributes(self, attrs):
method buildChildren (line 5346) | def buildChildren(self, child_, nodeName_):
class docInternalS2Type (line 5368) | class docInternalS2Type(GeneratedsSuper):
method __init__ (line 5371) | def __init__(self, para=None, sect3=None, mixedclass_=None, content_=N...
method factory (line 5380) | def factory(*args_, **kwargs_):
method get_para (line 5386) | def get_para(self): return self.para
method set_para (line 5387) | def set_para(self, para): self.para = para
method add_para (line 5388) | def add_para(self, value): self.para.append(value)
method insert_para (line 5389) | def insert_para(self, index, value): self.para[index] = value
method get_sect3 (line 5390) | def get_sect3(self): return self.sect3
method set_sect3 (line 5391) | def set_sect3(self, sect3): self.sect3 = sect3
method add_sect3 (line 5392) | def add_sect3(self, value): self.sect3.append(value)
method insert_sect3 (line 5393) | def insert_sect3(self, index, value): self.sect3[index] = value
method export (line 5394) | def export(self, outfile, level, namespace_='', name_='docInternalS2Ty...
method exportAttributes (line 5401) | def exportAttributes(self, outfile, level, namespace_='', name_='docIn...
method exportChildren (line 5403) | def exportChildren(self, outfile, level, namespace_='', name_='docInte...
method hasContent_ (line 5406) | def hasContent_(self):
method exportLiteral (line 5414) | def exportLiteral(self, outfile, level, name_='docInternalS2Type'):
method exportLiteralAttributes (line 5419) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 5421) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 5434) | def build(self, node_):
method buildAttributes (line 5440) | def buildAttributes(self, attrs):
method buildChildren (line 5442) | def buildChildren(self, child_, nodeName_):
class docInternalS3Type (line 5464) | class docInternalS3Type(GeneratedsSuper):
method __init__ (line 5467) | def __init__(self, para=None, sect3=None, mixedclass_=None, content_=N...
method factory (line 5476) | def factory(*args_, **kwargs_):
method get_para (line 5482) | def get_para(self): return self.para
method set_para (line 5483) | def set_para(self, para): self.para = para
method add_para (line 5484) | def add_para(self, value): self.para.append(value)
method insert_para (line 5485) | def insert_para(self, index, value): self.para[index] = value
method get_sect3 (line 5486) | def get_sect3(self): return self.sect3
method set_sect3 (line 5487) | def set_sect3(self, sect3): self.sect3 = sect3
method add_sect3 (line 5488) | def add_sect3(self, value): self.sect3.append(value)
method insert_sect3 (line 5489) | def insert_sect3(self, index, value): self.sect3[index] = value
method export (line 5490) | def export(self, outfile, level, namespace_='', name_='docInternalS3Ty...
method exportAttributes (line 5497) | def exportAttributes(self, outfile, level, namespace_='', name_='docIn...
method exportChildren (line 5499) | def exportChildren(self, outfile, level, namespace_='', name_='docInte...
method hasContent_ (line 5502) | def hasContent_(self):
method exportLiteral (line 5510) | def exportLiteral(self, outfile, level, name_='docInternalS3Type'):
method exportLiteralAttributes (line 5515) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 5517) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 5530) | def build(self, node_):
method buildAttributes (line 5536) | def buildAttributes(self, attrs):
method buildChildren (line 5538) | def buildChildren(self, child_, nodeName_):
class docInternalS4Type (line 5560) | class docInternalS4Type(GeneratedsSuper):
method __init__ (line 5563) | def __init__(self, para=None, mixedclass_=None, content_=None):
method factory (line 5572) | def factory(*args_, **kwargs_):
method get_para (line 5578) | def get_para(self): return self.para
method set_para (line 5579) | def set_para(self, para): self.para = para
method add_para (line 5580) | def add_para(self, value): self.para.append(value)
method insert_para (line 5581) | def insert_para(self, index, value): self.para[index] = value
method export (line 5582) | def export(self, outfile, level, namespace_='', name_='docInternalS4Ty...
method exportAttributes (line 5589) | def exportAttributes(self, outfile, level, namespace_='', name_='docIn...
method exportChildren (line 5591) | def exportChildren(self, outfile, level, namespace_='', name_='docInte...
method hasContent_ (line 5594) | def hasContent_(self):
method exportLiteral (line 5601) | def exportLiteral(self, outfile, level, name_='docInternalS4Type'):
method exportLiteralAttributes (line 5606) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 5608) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 5615) | def build(self, node_):
method buildAttributes (line 5621) | def buildAttributes(self, attrs):
method buildChildren (line 5623) | def buildChildren(self, child_, nodeName_):
class docTitleType (line 5638) | class docTitleType(GeneratedsSuper):
method __init__ (line 5641) | def __init__(self, valueOf_='', mixedclass_=None, content_=None):
method factory (line 5650) | def factory(*args_, **kwargs_):
method getValueOf_ (line 5656) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 5657) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 5658) | def export(self, outfile, level, namespace_='', name_='docTitleType', ...
method exportAttributes (line 5665) | def exportAttributes(self, outfile, level, namespace_='', name_='docTi...
method exportChildren (line 5667) | def exportChildren(self, outfile, level, namespace_='', name_='docTitl...
method hasContent_ (line 5675) | def hasContent_(self):
method exportLiteral (line 5682) | def exportLiteral(self, outfile, level, name_='docTitleType'):
method exportLiteralAttributes (line 5687) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 5689) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 5692) | def build(self, node_):
method buildAttributes (line 5699) | def buildAttributes(self, attrs):
method buildChildren (line 5701) | def buildChildren(self, child_, nodeName_):
class docParaType (line 5713) | class docParaType(GeneratedsSuper):
method __init__ (line 5716) | def __init__(self, valueOf_='', mixedclass_=None, content_=None):
method factory (line 5725) | def factory(*args_, **kwargs_):
method getValueOf_ (line 5731) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 5732) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 5733) | def export(self, outfile, level, namespace_='', name_='docParaType', n...
method exportAttributes (line 5740) | def exportAttributes(self, outfile, level, namespace_='', name_='docPa...
method exportChildren (line 5742) | def exportChildren(self, outfile, level, namespace_='', name_='docPara...
method hasContent_ (line 5750) | def hasContent_(self):
method exportLiteral (line 5757) | def exportLiteral(self, outfile, level, name_='docParaType'):
method exportLiteralAttributes (line 5762) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 5764) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 5767) | def build(self, node_):
method buildAttributes (line 5774) | def buildAttributes(self, attrs):
method buildChildren (line 5776) | def buildChildren(self, child_, nodeName_):
class docMarkupType (line 5788) | class docMarkupType(GeneratedsSuper):
method __init__ (line 5791) | def __init__(self, valueOf_='', mixedclass_=None, content_=None):
method factory (line 5800) | def factory(*args_, **kwargs_):
method getValueOf_ (line 5806) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 5807) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 5808) | def export(self, outfile, level, namespace_='', name_='docMarkupType',...
method exportAttributes (line 5815) | def exportAttributes(self, outfile, level, namespace_='', name_='docMa...
method exportChildren (line 5817) | def exportChildren(self, outfile, level, namespace_='', name_='docMark...
method hasContent_ (line 5825) | def hasContent_(self):
method exportLiteral (line 5832) | def exportLiteral(self, outfile, level, name_='docMarkupType'):
method exportLiteralAttributes (line 5837) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 5839) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 5842) | def build(self, node_):
method buildAttributes (line 5849) | def buildAttributes(self, attrs):
method buildChildren (line 5851) | def buildChildren(self, child_, nodeName_):
class docURLLink (line 5863) | class docURLLink(GeneratedsSuper):
method __init__ (line 5866) | def __init__(self, url=None, valueOf_='', mixedclass_=None, content_=N...
method factory (line 5876) | def factory(*args_, **kwargs_):
method get_url (line 5882) | def get_url(self): return self.url
method set_url (line 5883) | def set_url(self, url): self.url = url
method getValueOf_ (line 5884) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 5885) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 5886) | def export(self, outfile, level, namespace_='', name_='docURLLink', na...
method exportAttributes (line 5893) | def exportAttributes(self, outfile, level, namespace_='', name_='docUR...
method exportChildren (line 5896) | def exportChildren(self, outfile, level, namespace_='', name_='docURLL...
method hasContent_ (line 5904) | def hasContent_(self):
method exportLiteral (line 5911) | def exportLiteral(self, outfile, level, name_='docURLLink'):
method exportLiteralAttributes (line 5916) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 5920) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 5923) | def build(self, node_):
method buildAttributes (line 5930) | def buildAttributes(self, attrs):
method buildChildren (line 5933) | def buildChildren(self, child_, nodeName_):
class docAnchorType (line 5945) | class docAnchorType(GeneratedsSuper):
method __init__ (line 5948) | def __init__(self, id=None, valueOf_='', mixedclass_=None, content_=No...
method factory (line 5958) | def factory(*args_, **kwargs_):
method get_id (line 5964) | def get_id(self): return self.id
method set_id (line 5965) | def set_id(self, id): self.id = id
method getValueOf_ (line 5966) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 5967) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 5968) | def export(self, outfile, level, namespace_='', name_='docAnchorType',...
method exportAttributes (line 5975) | def exportAttributes(self, outfile, level, namespace_='', name_='docAn...
method exportChildren (line 5978) | def exportChildren(self, outfile, level, namespace_='', name_='docAnch...
method hasContent_ (line 5986) | def hasContent_(self):
method exportLiteral (line 5993) | def exportLiteral(self, outfile, level, name_='docAnchorType'):
method exportLiteralAttributes (line 5998) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 6002) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 6005) | def build(self, node_):
method buildAttributes (line 6012) | def buildAttributes(self, attrs):
method buildChildren (line 6015) | def buildChildren(self, child_, nodeName_):
class docFormulaType (line 6027) | class docFormulaType(GeneratedsSuper):
method __init__ (line 6030) | def __init__(self, id=None, valueOf_='', mixedclass_=None, content_=No...
method factory (line 6040) | def factory(*args_, **kwargs_):
method get_id (line 6046) | def get_id(self): return self.id
method set_id (line 6047) | def set_id(self, id): self.id = id
method getValueOf_ (line 6048) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 6049) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 6050) | def export(self, outfile, level, namespace_='', name_='docFormulaType'...
method exportAttributes (line 6057) | def exportAttributes(self, outfile, level, namespace_='', name_='docFo...
method exportChildren (line 6060) | def exportChildren(self, outfile, level, namespace_='', name_='docForm...
method hasContent_ (line 6068) | def hasContent_(self):
method exportLiteral (line 6075) | def exportLiteral(self, outfile, level, name_='docFormulaType'):
method exportLiteralAttributes (line 6080) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 6084) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 6087) | def build(self, node_):
method buildAttributes (line 6094) | def buildAttributes(self, attrs):
method buildChildren (line 6097) | def buildChildren(self, child_, nodeName_):
class docIndexEntryType (line 6109) | class docIndexEntryType(GeneratedsSuper):
method __init__ (line 6112) | def __init__(self, primaryie=None, secondaryie=None):
method factory (line 6115) | def factory(*args_, **kwargs_):
method get_primaryie (line 6121) | def get_primaryie(self): return self.primaryie
method set_primaryie (line 6122) | def set_primaryie(self, primaryie): self.primaryie = primaryie
method get_secondaryie (line 6123) | def get_secondaryie(self): return self.secondaryie
method set_secondaryie (line 6124) | def set_secondaryie(self, secondaryie): self.secondaryie = secondaryie
method export (line 6125) | def export(self, outfile, level, namespace_='', name_='docIndexEntryTy...
method exportAttributes (line 6136) | def exportAttributes(self, outfile, level, namespace_='', name_='docIn...
method exportChildren (line 6138) | def exportChildren(self, outfile, level, namespace_='', name_='docInde...
method hasContent_ (line 6145) | def hasContent_(self):
method exportLiteral (line 6153) | def exportLiteral(self, outfile, level, name_='docIndexEntryType'):
method exportLiteralAttributes (line 6158) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 6160) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 6165) | def build(self, node_):
method buildAttributes (line 6171) | def buildAttributes(self, attrs):
method buildChildren (line 6173) | def buildChildren(self, child_, nodeName_):
class docListType (line 6189) | class docListType(GeneratedsSuper):
method __init__ (line 6192) | def __init__(self, listitem=None):
method factory (line 6197) | def factory(*args_, **kwargs_):
method get_listitem (line 6203) | def get_listitem(self): return self.listitem
method set_listitem (line 6204) | def set_listitem(self, listitem): self.listitem = listitem
method add_listitem (line 6205) | def add_listitem(self, value): self.listitem.append(value)
method insert_listitem (line 6206) | def insert_listitem(self, index, value): self.listitem[index] = value
method export (line 6207) | def export(self, outfile, level, namespace_='', name_='docListType', n...
method exportAttributes (line 6218) | def exportAttributes(self, outfile, level, namespace_='', name_='docLi...
method exportChildren (line 6220) | def exportChildren(self, outfile, level, namespace_='', name_='docList...
method hasContent_ (line 6223) | def hasContent_(self):
method exportLiteral (line 6230) | def exportLiteral(self, outfile, level, name_='docListType'):
method exportLiteralAttributes (line 6235) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 6237) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 6250) | def build(self, node_):
method buildAttributes (line 6256) | def buildAttributes(self, attrs):
method buildChildren (line 6258) | def buildChildren(self, child_, nodeName_):
class docListItemType (line 6267) | class docListItemType(GeneratedsSuper):
method __init__ (line 6270) | def __init__(self, para=None):
method factory (line 6275) | def factory(*args_, **kwargs_):
method get_para (line 6281) | def get_para(self): return self.para
method set_para (line 6282) | def set_para(self, para): self.para = para
method add_para (line 6283) | def add_para(self, value): self.para.append(value)
method insert_para (line 6284) | def insert_para(self, index, value): self.para[index] = value
method export (line 6285) | def export(self, outfile, level, namespace_='', name_='docListItemType...
method exportAttributes (line 6296) | def exportAttributes(self, outfile, level, namespace_='', name_='docLi...
method exportChildren (line 6298) | def exportChildren(self, outfile, level, namespace_='', name_='docList...
method hasContent_ (line 6301) | def hasContent_(self):
method exportLiteral (line 6308) | def exportLiteral(self, outfile, level, name_='docListItemType'):
method exportLiteralAttributes (line 6313) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 6315) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 6328) | def build(self, node_):
method buildAttributes (line 6334) | def buildAttributes(self, attrs):
method buildChildren (line 6336) | def buildChildren(self, child_, nodeName_):
class docSimpleSectType (line 6345) | class docSimpleSectType(GeneratedsSuper):
method __init__ (line 6348) | def __init__(self, kind=None, title=None, para=None):
method factory (line 6355) | def factory(*args_, **kwargs_):
method get_title (line 6361) | def get_title(self): return self.title
method set_title (line 6362) | def set_title(self, title): self.title = title
method get_para (line 6363) | def get_para(self): return self.para
method set_para (line 6364) | def set_para(self, para): self.para = para
method add_para (line 6365) | def add_para(self, value): self.para.append(value)
method insert_para (line 6366) | def insert_para(self, index, value): self.para[index] = value
method get_kind (line 6367) | def get_kind(self): return self.kind
method set_kind (line 6368) | def set_kind(self, kind): self.kind = kind
method export (line 6369) | def export(self, outfile, level, namespace_='', name_='docSimpleSectTy...
method exportAttributes (line 6380) | def exportAttributes(self, outfile, level, namespace_='', name_='docSi...
method exportChildren (line 6383) | def exportChildren(self, outfile, level, namespace_='', name_='docSimp...
method hasContent_ (line 6388) | def hasContent_(self):
method exportLiteral (line 6396) | def exportLiteral(self, outfile, level, name_='docSimpleSectType'):
method exportLiteralAttributes (line 6401) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 6405) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 6424) | def build(self, node_):
method buildAttributes (line 6430) | def buildAttributes(self, attrs):
method buildChildren (line 6433) | def buildChildren(self, child_, nodeName_):
class docVarListEntryType (line 6447) | class docVarListEntryType(GeneratedsSuper):
method __init__ (line 6450) | def __init__(self, term=None):
method factory (line 6452) | def factory(*args_, **kwargs_):
method get_term (line 6458) | def get_term(self): return self.term
method set_term (line 6459) | def set_term(self, term): self.term = term
method export (line 6460) | def export(self, outfile, level, namespace_='', name_='docVarListEntry...
method exportAttributes (line 6471) | def exportAttributes(self, outfile, level, namespace_='', name_='docVa...
method exportChildren (line 6473) | def exportChildren(self, outfile, level, namespace_='', name_='docVarL...
method hasContent_ (line 6476) | def hasContent_(self):
method exportLiteral (line 6483) | def exportLiteral(self, outfile, level, name_='docVarListEntryType'):
method exportLiteralAttributes (line 6488) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 6490) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 6497) | def build(self, node_):
method buildAttributes (line 6503) | def buildAttributes(self, attrs):
method buildChildren (line 6505) | def buildChildren(self, child_, nodeName_):
class docVariableListType (line 6514) | class docVariableListType(GeneratedsSuper):
method __init__ (line 6517) | def __init__(self, valueOf_=''):
method factory (line 6519) | def factory(*args_, **kwargs_):
method getValueOf_ (line 6525) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 6526) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 6527) | def export(self, outfile, level, namespace_='', name_='docVariableList...
method exportAttributes (line 6538) | def exportAttributes(self, outfile, level, namespace_='', name_='docVa...
method exportChildren (line 6540) | def exportChildren(self, outfile, level, namespace_='', name_='docVari...
method hasContent_ (line 6548) | def hasContent_(self):
method exportLiteral (line 6555) | def exportLiteral(self, outfile, level, name_='docVariableListType'):
method exportLiteralAttributes (line 6560) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 6562) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 6565) | def build(self, node_):
method buildAttributes (line 6572) | def buildAttributes(self, attrs):
method buildChildren (line 6574) | def buildChildren(self, child_, nodeName_):
class docRefTextType (line 6582) | class docRefTextType(GeneratedsSuper):
method __init__ (line 6585) | def __init__(self, refid=None, kindref=None, external=None, valueOf_='...
method factory (line 6597) | def factory(*args_, **kwargs_):
method get_refid (line 6603) | def get_refid(self): return self.refid
method set_refid (line 6604) | def set_refid(self, refid): self.refid = refid
method get_kindref (line 6605) | def get_kindref(self): return self.kindref
method set_kindref (line 6606) | def set_kindref(self, kindref): self.kindref = kindref
method get_external (line 6607) | def get_external(self): return self.external
method set_external (line 6608) | def set_external(self, external): self.external = external
method getValueOf_ (line 6609) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 6610) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 6611) | def export(self, outfile, level, namespace_='', name_='docRefTextType'...
method exportAttributes (line 6618) | def exportAttributes(self, outfile, level, namespace_='', name_='docRe...
method exportChildren (line 6625) | def exportChildren(self, outfile, level, namespace_='', name_='docRefT...
method hasContent_ (line 6633) | def hasContent_(self):
method exportLiteral (line 6640) | def exportLiteral(self, outfile, level, name_='docRefTextType'):
method exportLiteralAttributes (line 6645) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 6655) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 6658) | def build(self, node_):
method buildAttributes (line 6665) | def buildAttributes(self, attrs):
method buildChildren (line 6672) | def buildChildren(self, child_, nodeName_):
class docTableType (line 6684) | class docTableType(GeneratedsSuper):
method __init__ (line 6687) | def __init__(self, rows=None, cols=None, row=None, caption=None):
method factory (line 6695) | def factory(*args_, **kwargs_):
method get_row (line 6701) | def get_row(self): return self.row
method set_row (line 6702) | def set_row(self, row): self.row = row
method add_row (line 6703) | def add_row(self, value): self.row.append(value)
method insert_row (line 6704) | def insert_row(self, index, value): self.row[index] = value
method get_caption (line 6705) | def get_caption(self): return self.caption
method set_caption (line 6706) | def set_caption(self, caption): self.caption = caption
method get_rows (line 6707) | def get_rows(self): return self.rows
method set_rows (line 6708) | def set_rows(self, rows): self.rows = rows
method get_cols (line 6709) | def get_cols(self): return self.cols
method set_cols (line 6710) | def set_cols(self, cols): self.cols = cols
method export (line 6711) | def export(self, outfile, level, namespace_='', name_='docTableType', ...
method exportAttributes (line 6722) | def exportAttributes(self, outfile, level, namespace_='', name_='docTa...
method exportChildren (line 6727) | def exportChildren(self, outfile, level, namespace_='', name_='docTabl...
method hasContent_ (line 6732) | def hasContent_(self):
method exportLiteral (line 6740) | def exportLiteral(self, outfile, level, name_='docTableType'):
method exportLiteralAttributes (line 6745) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 6752) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 6771) | def build(self, node_):
method buildAttributes (line 6777) | def buildAttributes(self, attrs):
method buildChildren (line 6788) | def buildChildren(self, child_, nodeName_):
class docRowType (line 6802) | class docRowType(GeneratedsSuper):
method __init__ (line 6805) | def __init__(self, entry=None):
method factory (line 6810) | def factory(*args_, **kwargs_):
method get_entry (line 6816) | def get_entry(self): return self.entry
method set_entry (line 6817) | def set_entry(self, entry): self.entry = entry
method add_entry (line 6818) | def add_entry(self, value): self.entry.append(value)
method insert_entry (line 6819) | def insert_entry(self, index, value): self.entry[index] = value
method export (line 6820) | def export(self, outfile, level, namespace_='', name_='docRowType', na...
method exportAttributes (line 6831) | def exportAttributes(self, outfile, level, namespace_='', name_='docRo...
method exportChildren (line 6833) | def exportChildren(self, outfile, level, namespace_='', name_='docRowT...
method hasContent_ (line 6836) | def hasContent_(self):
method exportLiteral (line 6843) | def exportLiteral(self, outfile, level, name_='docRowType'):
method exportLiteralAttributes (line 6848) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 6850) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 6863) | def build(self, node_):
method buildAttributes (line 6869) | def buildAttributes(self, attrs):
method buildChildren (line 6871) | def buildChildren(self, child_, nodeName_):
class docEntryType (line 6880) | class docEntryType(GeneratedsSuper):
method __init__ (line 6883) | def __init__(self, thead=None, para=None):
method factory (line 6889) | def factory(*args_, **kwargs_):
method get_para (line 6895) | def get_para(self): return self.para
method set_para (line 6896) | def set_para(self, para): self.para = para
method add_para (line 6897) | def add_para(self, value): self.para.append(value)
method insert_para (line 6898) | def insert_para(self, index, value): self.para[index] = value
method get_thead (line 6899) | def get_thead(self): return self.thead
method set_thead (line 6900) | def set_thead(self, thead): self.thead = thead
method export (line 6901) | def export(self, outfile, level, namespace_='', name_='docEntryType', ...
method exportAttributes (line 6912) | def exportAttributes(self, outfile, level, namespace_='', name_='docEn...
method exportChildren (line 6915) | def exportChildren(self, outfile, level, namespace_='', name_='docEntr...
method hasContent_ (line 6918) | def hasContent_(self):
method exportLiteral (line 6925) | def exportLiteral(self, outfile, level, name_='docEntryType'):
method exportLiteralAttributes (line 6930) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 6934) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 6947) | def build(self, node_):
method buildAttributes (line 6953) | def buildAttributes(self, attrs):
method buildChildren (line 6956) | def buildChildren(self, child_, nodeName_):
class docCaptionType (line 6965) | class docCaptionType(GeneratedsSuper):
method __init__ (line 6968) | def __init__(self, valueOf_='', mixedclass_=None, content_=None):
method factory (line 6977) | def factory(*args_, **kwargs_):
method getValueOf_ (line 6983) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 6984) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 6985) | def export(self, outfile, level, namespace_='', name_='docCaptionType'...
method exportAttributes (line 6992) | def exportAttributes(self, outfile, level, namespace_='', name_='docCa...
method exportChildren (line 6994) | def exportChildren(self, outfile, level, namespace_='', name_='docCapt...
method hasContent_ (line 7002) | def hasContent_(self):
method exportLiteral (line 7009) | def exportLiteral(self, outfile, level, name_='docCaptionType'):
method exportLiteralAttributes (line 7014) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 7016) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 7019) | def build(self, node_):
method buildAttributes (line 7026) | def buildAttributes(self, attrs):
method buildChildren (line 7028) | def buildChildren(self, child_, nodeName_):
class docHeadingType (line 7040) | class docHeadingType(GeneratedsSuper):
method __init__ (line 7043) | def __init__(self, level=None, valueOf_='', mixedclass_=None, content_...
method factory (line 7053) | def factory(*args_, **kwargs_):
method get_level (line 7059) | def get_level(self): return self.level
method set_level (line 7060) | def set_level(self, level): self.level = level
method getValueOf_ (line 7061) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 7062) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 7063) | def export(self, outfile, level, namespace_='', name_='docHeadingType'...
method exportAttributes (line 7070) | def exportAttributes(self, outfile, level, namespace_='', name_='docHe...
method exportChildren (line 7073) | def exportChildren(self, outfile, level, namespace_='', name_='docHead...
method hasContent_ (line 7081) | def hasContent_(self):
method exportLiteral (line 7088) | def exportLiteral(self, outfile, level, name_='docHeadingType'):
method exportLiteralAttributes (line 7093) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 7097) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 7100) | def build(self, node_):
method buildAttributes (line 7107) | def buildAttributes(self, attrs):
method buildChildren (line 7113) | def buildChildren(self, child_, nodeName_):
class docImageType (line 7125) | class docImageType(GeneratedsSuper):
method __init__ (line 7128) | def __init__(self, width=None, type_=None, name=None, height=None, val...
method factory (line 7141) | def factory(*args_, **kwargs_):
method get_width (line 7147) | def get_width(self): return self.width
method set_width (line 7148) | def set_width(self, width): self.width = width
method get_type (line 7149) | def get_type(self): return self.type_
method set_type (line 7150) | def set_type(self, type_): self.type_ = type_
method get_name (line 7151) | def get_name(self): return self.name
method set_name (line 7152) | def set_name(self, name): self.name = name
method get_height (line 7153) | def get_height(self): return self.height
method set_height (line 7154) | def set_height(self, height): self.height = height
method getValueOf_ (line 7155) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 7156) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 7157) | def export(self, outfile, level, namespace_='', name_='docImageType', ...
method exportAttributes (line 7164) | def exportAttributes(self, outfile, level, namespace_='', name_='docIm...
method exportChildren (line 7173) | def exportChildren(self, outfile, level, namespace_='', name_='docImag...
method hasContent_ (line 7181) | def hasContent_(self):
method exportLiteral (line 7188) | def exportLiteral(self, outfile, level, name_='docImageType'):
method exportLiteralAttributes (line 7193) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 7206) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 7209) | def build(self, node_):
method buildAttributes (line 7216) | def buildAttributes(self, attrs):
method buildChildren (line 7225) | def buildChildren(self, child_, nodeName_):
class docDotFileType (line 7237) | class docDotFileType(GeneratedsSuper):
method __init__ (line 7240) | def __init__(self, name=None, valueOf_='', mixedclass_=None, content_=...
method factory (line 7250) | def factory(*args_, **kwargs_):
method get_name (line 7256) | def get_name(self): return self.name
method set_name (line 7257) | def set_name(self, name): self.name = name
method getValueOf_ (line 7258) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 7259) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 7260) | def export(self, outfile, level, namespace_='', name_='docDotFileType'...
method exportAttributes (line 7267) | def exportAttributes(self, outfile, level, namespace_='', name_='docDo...
method exportChildren (line 7270) | def exportChildren(self, outfile, level, namespace_='', name_='docDotF...
method hasContent_ (line 7278) | def hasContent_(self):
method exportLiteral (line 7285) | def exportLiteral(self, outfile, level, name_='docDotFileType'):
method exportLiteralAttributes (line 7290) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 7294) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 7297) | def build(self, node_):
method buildAttributes (line 7304) | def buildAttributes(self, attrs):
method buildChildren (line 7307) | def buildChildren(self, child_, nodeName_):
class docTocItemType (line 7319) | class docTocItemType(GeneratedsSuper):
method __init__ (line 7322) | def __init__(self, id=None, valueOf_='', mixedclass_=None, content_=No...
method factory (line 7332) | def factory(*args_, **kwargs_):
method get_id (line 7338) | def get_id(self): return self.id
method set_id (line 7339) | def set_id(self, id): self.id = id
method getValueOf_ (line 7340) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 7341) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 7342) | def export(self, outfile, level, namespace_='', name_='docTocItemType'...
method exportAttributes (line 7349) | def exportAttributes(self, outfile, level, namespace_='', name_='docTo...
method exportChildren (line 7352) | def exportChildren(self, outfile, level, namespace_='', name_='docTocI...
method hasContent_ (line 7360) | def hasContent_(self):
method exportLiteral (line 7367) | def exportLiteral(self, outfile, level, name_='docTocItemType'):
method exportLiteralAttributes (line 7372) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 7376) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 7379) | def build(self, node_):
method buildAttributes (line 7386) | def buildAttributes(self, attrs):
method buildChildren (line 7389) | def buildChildren(self, child_, nodeName_):
class docTocListType (line 7401) | class docTocListType(GeneratedsSuper):
method __init__ (line 7404) | def __init__(self, tocitem=None):
method factory (line 7409) | def factory(*args_, **kwargs_):
method get_tocitem (line 7415) | def get_tocitem(self): return self.tocitem
method set_tocitem (line 7416) | def set_tocitem(self, tocitem): self.tocitem = tocitem
method add_tocitem (line 7417) | def add_tocitem(self, value): self.tocitem.append(value)
method insert_tocitem (line 7418) | def insert_tocitem(self, index, value): self.tocitem[index] = value
method export (line 7419) | def export(self, outfile, level, namespace_='', name_='docTocListType'...
method exportAttributes (line 7430) | def exportAttributes(self, outfile, level, namespace_='', name_='docTo...
method exportChildren (line 7432) | def exportChildren(self, outfile, level, namespace_='', name_='docTocL...
method hasContent_ (line 7435) | def hasContent_(self):
method exportLiteral (line 7442) | def exportLiteral(self, outfile, level, name_='docTocListType'):
method exportLiteralAttributes (line 7447) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 7449) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 7462) | def build(self, node_):
method buildAttributes (line 7468) | def buildAttributes(self, attrs):
method buildChildren (line 7470) | def buildChildren(self, child_, nodeName_):
class docLanguageType (line 7479) | class docLanguageType(GeneratedsSuper):
method __init__ (line 7482) | def __init__(self, langid=None, para=None):
method factory (line 7488) | def factory(*args_, **kwargs_):
method get_para (line 7494) | def get_para(self): return self.para
method set_para (line 7495) | def set_para(self, para): self.para = para
method add_para (line 7496) | def add_para(self, value): self.para.append(value)
method insert_para (line 7497) | def insert_para(self, index, value): self.para[index] = value
method get_langid (line 7498) | def get_langid(self): return self.langid
method set_langid (line 7499) | def set_langid(self, langid): self.langid = langid
method export (line 7500) | def export(self, outfile, level, namespace_='', name_='docLanguageType...
method exportAttributes (line 7511) | def exportAttributes(self, outfile, level, namespace_='', name_='docLa...
method exportChildren (line 7514) | def exportChildren(self, outfile, level, namespace_='', name_='docLang...
method hasContent_ (line 7517) | def hasContent_(self):
method exportLiteral (line 7524) | def exportLiteral(self, outfile, level, name_='docLanguageType'):
method exportLiteralAttributes (line 7529) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 7533) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 7546) | def build(self, node_):
method buildAttributes (line 7552) | def buildAttributes(self, attrs):
method buildChildren (line 7555) | def buildChildren(self, child_, nodeName_):
class docParamListType (line 7564) | class docParamListType(GeneratedsSuper):
method __init__ (line 7567) | def __init__(self, kind=None, parameteritem=None):
method factory (line 7573) | def factory(*args_, **kwargs_):
method get_parameteritem (line 7579) | def get_parameteritem(self): return self.parameteritem
method set_parameteritem (line 7580) | def set_parameteritem(self, parameteritem): self.parameteritem = param...
method add_parameteritem (line 7581) | def add_parameteritem(self, value): self.parameteritem.append(value)
method insert_parameteritem (line 7582) | def insert_parameteritem(self, index, value): self.parameteritem[index...
method get_kind (line 7583) | def get_kind(self): return self.kind
method set_kind (line 7584) | def set_kind(self, kind): self.kind = kind
method export (line 7585) | def export(self, outfile, level, namespace_='', name_='docParamListTyp...
method exportAttributes (line 7596) | def exportAttributes(self, outfile, level, namespace_='', name_='docPa...
method exportChildren (line 7599) | def exportChildren(self, outfile, level, namespace_='', name_='docPara...
method hasContent_ (line 7602) | def hasContent_(self):
method exportLiteral (line 7609) | def exportLiteral(self, outfile, level, name_='docParamListType'):
method exportLiteralAttributes (line 7614) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 7618) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 7631) | def build(self, node_):
method buildAttributes (line 7637) | def buildAttributes(self, attrs):
method buildChildren (line 7640) | def buildChildren(self, child_, nodeName_):
class docParamListItem (line 7649) | class docParamListItem(GeneratedsSuper):
method __init__ (line 7652) | def __init__(self, parameternamelist=None, parameterdescription=None):
method factory (line 7658) | def factory(*args_, **kwargs_):
method get_parameternamelist (line 7664) | def get_parameternamelist(self): return self.parameternamelist
method set_parameternamelist (line 7665) | def set_parameternamelist(self, parameternamelist): self.parametername...
method add_parameternamelist (line 7666) | def add_parameternamelist(self, value): self.parameternamelist.append(...
method insert_parameternamelist (line 7667) | def insert_parameternamelist(self, index, value): self.parameternameli...
method get_parameterdescription (line 7668) | def get_parameterdescription(self): return self.parameterdescription
method set_parameterdescription (line 7669) | def set_parameterdescription(self, parameterdescription): self.paramet...
method export (line 7670) | def export(self, outfile, level, namespace_='', name_='docParamListIte...
method exportAttributes (line 7681) | def exportAttributes(self, outfile, level, namespace_='', name_='docPa...
method exportChildren (line 7683) | def exportChildren(self, outfile, level, namespace_='', name_='docPara...
method hasContent_ (line 7688) | def hasContent_(self):
method exportLiteral (line 7696) | def exportLiteral(self, outfile, level, name_='docParamListItem'):
method exportLiteralAttributes (line 7701) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 7703) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 7722) | def build(self, node_):
method buildAttributes (line 7728) | def buildAttributes(self, attrs):
method buildChildren (line 7730) | def buildChildren(self, child_, nodeName_):
class docParamNameList (line 7744) | class docParamNameList(GeneratedsSuper):
method __init__ (line 7747) | def __init__(self, parametername=None):
method factory (line 7752) | def factory(*args_, **kwargs_):
method get_parametername (line 7758) | def get_parametername(self): return self.parametername
method set_parametername (line 7759) | def set_parametername(self, parametername): self.parametername = param...
method add_parametername (line 7760) | def add_parametername(self, value): self.parametername.append(value)
method insert_parametername (line 7761) | def insert_parametername(self, index, value): self.parametername[index...
method export (line 7762) | def export(self, outfile, level, namespace_='', name_='docParamNameLis...
method exportAttributes (line 7773) | def exportAttributes(self, outfile, level, namespace_='', name_='docPa...
method exportChildren (line 7775) | def exportChildren(self, outfile, level, namespace_='', name_='docPara...
method hasContent_ (line 7778) | def hasContent_(self):
method exportLiteral (line 7785) | def exportLiteral(self, outfile, level, name_='docParamNameList'):
method exportLiteralAttributes (line 7790) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 7792) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 7805) | def build(self, node_):
method buildAttributes (line 7811) | def buildAttributes(self, attrs):
method buildChildren (line 7813) | def buildChildren(self, child_, nodeName_):
class docParamName (line 7822) | class docParamName(GeneratedsSuper):
method __init__ (line 7825) | def __init__(self, direction=None, ref=None, mixedclass_=None, content...
method factory (line 7835) | def factory(*args_, **kwargs_):
method get_ref (line 7841) | def get_ref(self): return self.ref
method set_ref (line 7842) | def set_ref(self, ref): self.ref = ref
method get_direction (line 7843) | def get_direction(self): return self.direction
method set_direction (line 7844) | def set_direction(self, direction): self.direction = direction
method export (line 7845) | def export(self, outfile, level, namespace_='', name_='docParamName', ...
method exportAttributes (line 7852) | def exportAttributes(self, outfile, level, namespace_='', name_='docPa...
method exportChildren (line 7855) | def exportChildren(self, outfile, level, namespace_='', name_='docPara...
method hasContent_ (line 7858) | def hasContent_(self):
method exportLiteral (line 7865) | def exportLiteral(self, outfile, level, name_='docParamName'):
method exportLiteralAttributes (line 7870) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 7874) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 7881) | def build(self, node_):
method buildAttributes (line 7887) | def buildAttributes(self, attrs):
method buildChildren (line 7890) | def buildChildren(self, child_, nodeName_):
class docXRefSectType (line 7905) | class docXRefSectType(GeneratedsSuper):
method __init__ (line 7908) | def __init__(self, id=None, xreftitle=None, xrefdescription=None):
method factory (line 7915) | def factory(*args_, **kwargs_):
method get_xreftitle (line 7921) | def get_xreftitle(self): return self.xreftitle
method set_xreftitle (line 7922) | def set_xreftitle(self, xreftitle): self.xreftitle = xreftitle
method add_xreftitle (line 7923) | def add_xreftitle(self, value): self.xreftitle.append(value)
method insert_xreftitle (line 7924) | def insert_xreftitle(self, index, value): self.xreftitle[index] = value
method get_xrefdescription (line 7925) | def get_xrefdescription(self): return self.xrefdescription
method set_xrefdescription (line 7926) | def set_xrefdescription(self, xrefdescription): self.xrefdescription =...
method get_id (line 7927) | def get_id(self): return self.id
method set_id (line 7928) | def set_id(self, id): self.id = id
method export (line 7929) | def export(self, outfile, level, namespace_='', name_='docXRefSectType...
method exportAttributes (line 7940) | def exportAttributes(self, outfile, level, namespace_='', name_='docXR...
method exportChildren (line 7943) | def exportChildren(self, outfile, level, namespace_='', name_='docXRef...
method hasContent_ (line 7949) | def hasContent_(self):
method exportLiteral (line 7957) | def exportLiteral(self, outfile, level, name_='docXRefSectType'):
method exportLiteralAttributes (line 7962) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 7966) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 7982) | def build(self, node_):
method buildAttributes (line 7988) | def buildAttributes(self, attrs):
method buildChildren (line 7991) | def buildChildren(self, child_, nodeName_):
class docCopyType (line 8006) | class docCopyType(GeneratedsSuper):
method __init__ (line 8009) | def __init__(self, link=None, para=None, sect1=None, internal=None):
method factory (line 8020) | def factory(*args_, **kwargs_):
method get_para (line 8026) | def get_para(self): return self.para
method set_para (line 8027) | def set_para(self, para): self.para = para
method add_para (line 8028) | def add_para(self, value): self.para.append(value)
method insert_para (line 8029) | def insert_para(self, index, value): self.para[index] = value
method get_sect1 (line 8030) | def get_sect1(self): return self.sect1
method set_sect1 (line 8031) | def set_sect1(self, sect1): self.sect1 = sect1
method add_sect1 (line 8032) | def add_sect1(self, value): self.sect1.append(value)
method insert_sect1 (line 8033) | def insert_sect1(self, index, value): self.sect1[index] = value
method get_internal (line 8034) | def get_internal(self): return self.internal
method set_internal (line 8035) | def set_internal(self, internal): self.internal = internal
method get_link (line 8036) | def get_link(self): return self.link
method set_link (line 8037) | def set_link(self, link): self.link = link
method export (line 8038) | def export(self, outfile, level, namespace_='', name_='docCopyType', n...
method exportAttributes (line 8049) | def exportAttributes(self, outfile, level, namespace_='', name_='docCo...
method exportChildren (line 8052) | def exportChildren(self, outfile, level, namespace_='', name_='docCopy...
method hasContent_ (line 8059) | def hasContent_(self):
method exportLiteral (line 8068) | def exportLiteral(self, outfile, level, name_='docCopyType'):
method exportLiteralAttributes (line 8073) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 8077) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 8108) | def build(self, node_):
method buildAttributes (line 8114) | def buildAttributes(self, attrs):
method buildChildren (line 8117) | def buildChildren(self, child_, nodeName_):
class docCharType (line 8136) | class docCharType(GeneratedsSuper):
method __init__ (line 8139) | def __init__(self, char=None, valueOf_=''):
method factory (line 8142) | def factory(*args_, **kwargs_):
method get_char (line 8148) | def get_char(self): return self.char
method set_char (line 8149) | def set_char(self, char): self.char = char
method getValueOf_ (line 8150) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 8151) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 8152) | def export(self, outfile, level, namespace_='', name_='docCharType', n...
method exportAttributes (line 8163) | def exportAttributes(self, outfile, level, namespace_='', name_='docCh...
method exportChildren (line 8166) | def exportChildren(self, outfile, level, namespace_='', name_='docChar...
method hasContent_ (line 8174) | def hasContent_(self):
method exportLiteral (line 8181) | def exportLiteral(self, outfile, level, name_='docCharType'):
method exportLiteralAttributes (line 8186) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 8190) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 8193) | def build(self, node_):
method buildAttributes (line 8200) | def buildAttributes(self, attrs):
method buildChildren (line 8203) | def buildChildren(self, child_, nodeName_):
class docEmptyType (line 8211) | class docEmptyType(GeneratedsSuper):
method __init__ (line 8214) | def __init__(self, valueOf_=''):
method factory (line 8216) | def factory(*args_, **kwargs_):
method getValueOf_ (line 8222) | def getValueOf_(self): return self.valueOf_
method setValueOf_ (line 8223) | def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_
method export (line 8224) | def export(self, outfile, level, namespace_='', name_='docEmptyType', ...
method exportAttributes (line 8235) | def exportAttributes(self, outfile, level, namespace_='', name_='docEm...
method exportChildren (line 8237) | def exportChildren(self, outfile, level, namespace_='', name_='docEmpt...
method hasContent_ (line 8245) | def hasContent_(self):
method exportLiteral (line 8252) | def exportLiteral(self, outfile, level, name_='docEmptyType'):
method exportLiteralAttributes (line 8257) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 8259) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 8262) | def build(self, node_):
method buildAttributes (line 8269) | def buildAttributes(self, attrs):
method buildChildren (line 8271) | def buildChildren(self, child_, nodeName_):
function usage (line 8285) | def usage():
function parse (line 8290) | def parse(inFileName):
function parseString (line 8303) | def parseString(inString):
function parseLiteral (line 8316) | def parseLiteral(inFileName):
function main (line 8330) | def main():
FILE: docs/doxygen/doxyxml/generated/index.py
class DoxygenTypeSub (line 15) | class DoxygenTypeSub(supermod.DoxygenType):
method __init__ (line 16) | def __init__(self, version=None, compound=None):
method find_compounds_and_members (line 19) | def find_compounds_and_members(self, details):
class CompoundTypeSub (line 39) | class CompoundTypeSub(supermod.CompoundType):
method __init__ (line 40) | def __init__(self, kind=None, refid=None, name='', member=None):
method find_members (line 43) | def find_members(self, details):
class MemberTypeSub (line 60) | class MemberTypeSub(supermod.MemberType):
method __init__ (line 62) | def __init__(self, kind=None, refid=None, name=''):
function parse (line 69) | def parse(inFilename):
FILE: docs/doxygen/doxyxml/generated/indexsuper.py
class GeneratedsSuper (line 24) | class GeneratedsSuper:
method format_string (line 25) | def format_string(self, input_data, input_name=''):
method format_integer (line 27) | def format_integer(self, input_data, input_name=''):
method format_float (line 29) | def format_float(self, input_data, input_name=''):
method format_double (line 31) | def format_double(self, input_data, input_name=''):
method format_boolean (line 33) | def format_boolean(self, input_data, input_name=''):
function showIndent (line 62) | def showIndent(outfile, level):
function quote_xml (line 66) | def quote_xml(inStr):
function quote_attrib (line 74) | def quote_attrib(inStr):
function quote_python (line 89) | def quote_python(inStr):
class MixedContainer (line 105) | class MixedContainer:
method __init__ (line 120) | def __init__(self, category, content_type, name, value):
method getCategory (line 125) | def getCategory(self):
method getContenttype (line 127) | def getContenttype(self, content_type):
method getValue (line 129) | def getValue(self):
method getName (line 131) | def getName(self):
method export (line 133) | def export(self, outfile, level, name, namespace):
method exportSimple (line 140) | def exportSimple(self, outfile, level, name):
method exportLiteral (line 151) | def exportLiteral(self, outfile, level, name):
class _MemberSpec (line 169) | class _MemberSpec(object):
method __init__ (line 170) | def __init__(self, name='', data_type='', container=0):
method set_name (line 174) | def set_name(self, name): self.name = name
method get_name (line 175) | def get_name(self): return self.name
method set_data_type (line 176) | def set_data_type(self, data_type): self.data_type = data_type
method get_data_type (line 177) | def get_data_type(self): return self.data_type
method set_container (line 178) | def set_container(self, container): self.container = container
method get_container (line 179) | def get_container(self): return self.container
class DoxygenType (line 186) | class DoxygenType(GeneratedsSuper):
method __init__ (line 189) | def __init__(self, version=None, compound=None):
method factory (line 195) | def factory(*args_, **kwargs_):
method get_compound (line 201) | def get_compound(self): return self.compound
method set_compound (line 202) | def set_compound(self, compound): self.compound = compound
method add_compound (line 203) | def add_compound(self, value): self.compound.append(value)
method insert_compound (line 204) | def insert_compound(self, index, value): self.compound[index] = value
method get_version (line 205) | def get_version(self): return self.version
method set_version (line 206) | def set_version(self, version): self.version = version
method export (line 207) | def export(self, outfile, level, namespace_='', name_='DoxygenType', n...
method exportAttributes (line 218) | def exportAttributes(self, outfile, level, namespace_='', name_='Doxyg...
method exportChildren (line 220) | def exportChildren(self, outfile, level, namespace_='', name_='Doxygen...
method hasContent_ (line 223) | def hasContent_(self):
method exportLiteral (line 230) | def exportLiteral(self, outfile, level, name_='DoxygenType'):
method exportLiteralAttributes (line 235) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 239) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 252) | def build(self, node_):
method buildAttributes (line 258) | def buildAttributes(self, attrs):
method buildChildren (line 261) | def buildChildren(self, child_, nodeName_):
class CompoundType (line 270) | class CompoundType(GeneratedsSuper):
method __init__ (line 273) | def __init__(self, kind=None, refid=None, name=None, member=None):
method factory (line 281) | def factory(*args_, **kwargs_):
method get_name (line 287) | def get_name(self): return self.name
method set_name (line 288) | def set_name(self, name): self.name = name
method get_member (line 289) | def get_member(self): return self.member
method set_member (line 290) | def set_member(self, member): self.member = member
method add_member (line 291) | def add_member(self, value): self.member.append(value)
method insert_member (line 292) | def insert_member(self, index, value): self.member[index] = value
method get_kind (line 293) | def get_kind(self): return self.kind
method set_kind (line 294) | def set_kind(self, kind): self.kind = kind
method get_refid (line 295) | def get_refid(self): return self.refid
method set_refid (line 296) | def set_refid(self, refid): self.refid = refid
method export (line 297) | def export(self, outfile, level, namespace_='', name_='CompoundType', ...
method exportAttributes (line 308) | def exportAttributes(self, outfile, level, namespace_='', name_='Compo...
method exportChildren (line 311) | def exportChildren(self, outfile, level, namespace_='', name_='Compoun...
method hasContent_ (line 317) | def hasContent_(self):
method exportLiteral (line 325) | def exportLiteral(self, outfile, level, name_='CompoundType'):
method exportLiteralAttributes (line 330) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 337) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 352) | def build(self, node_):
method buildAttributes (line 358) | def buildAttributes(self, attrs):
method buildChildren (line 363) | def buildChildren(self, child_, nodeName_):
class MemberType (line 378) | class MemberType(GeneratedsSuper):
method __init__ (line 381) | def __init__(self, kind=None, refid=None, name=None):
method factory (line 385) | def factory(*args_, **kwargs_):
method get_name (line 391) | def get_name(self): return self.name
method set_name (line 392) | def set_name(self, name): self.name = name
method get_kind (line 393) | def get_kind(self): return self.kind
method set_kind (line 394) | def set_kind(self, kind): self.kind = kind
method get_refid (line 395) | def get_refid(self): return self.refid
method set_refid (line 396) | def set_refid(self, refid): self.refid = refid
method export (line 397) | def export(self, outfile, level, namespace_='', name_='MemberType', na...
method exportAttributes (line 408) | def exportAttributes(self, outfile, level, namespace_='', name_='Membe...
method exportChildren (line 411) | def exportChildren(self, outfile, level, namespace_='', name_='MemberT...
method hasContent_ (line 415) | def hasContent_(self):
method exportLiteral (line 422) | def exportLiteral(self, outfile, level, name_='MemberType'):
method exportLiteralAttributes (line 427) | def exportLiteralAttributes(self, outfile, level, name_):
method exportLiteralChildren (line 434) | def exportLiteralChildren(self, outfile, level, name_):
method build (line 437) | def build(self, node_):
method buildAttributes (line 443) | def buildAttributes(self, attrs):
method buildChildren (line 448) | def buildChildren(self, child_, nodeName_):
function usage (line 464) | def usage():
function parse (line 469) | def parse(inFileName):
function parseString (line 482) | def parseString(inString):
function parseLiteral (line 495) | def parseLiteral(inFileName):
function main (line 509) | def main():
FILE: docs/doxygen/doxyxml/text.py
function is_string (line 25) | def is_string(txt):
function description (line 35) | def description(obj):
function description_bit (line 40) | def description_bit(obj):
FILE: docs/doxygen/swig_doc.py
function py_name (line 38) | def py_name(name):
function make_name (line 42) | def make_name(name):
class Block (line 47) | class Block(object):
method includes (line 53) | def includes(cls, item):
function utoascii (line 62) | def utoascii(text):
function combine_descriptions (line 73) | def combine_descriptions(obj):
function make_entry (line 88) | def make_entry(obj, name=None, templ="{description}", description=None):
function make_func_entry (line 114) | def make_func_entry(func, name=None, description=None, params=None):
function make_class_entry (line 136) | def make_class_entry(klass, description=None):
function make_block_entry (line 148) | def make_block_entry(di, block):
function make_swig_interface_file (line 184) | def make_swig_interface_file(di, swigdocfilename, custom_output=None):
FILE: include/dsss/dsss_decoder_cc.h
function namespace (line 28) | namespace gr {
FILE: include/dsss/dsss_encoder_bb.h
function namespace (line 28) | namespace gr {
FILE: lib/dsss_decoder_cc_impl.cc
type gr (line 34) | namespace gr {
type dsss (line 35) | namespace dsss {
FILE: lib/dsss_decoder_cc_impl.h
function namespace (line 29) | namespace gr {
FILE: lib/dsss_encoder_bb_impl.cc
type gr (line 28) | namespace gr {
type dsss (line 29) | namespace dsss {
FILE: lib/dsss_encoder_bb_impl.h
function namespace (line 26) | namespace gr {
FILE: lib/qa_dsss.h
function class (line 31) | class __GR_ATTR_EXPORT qa_dsss
FILE: lib/test_dsss.cc
function main (line 34) | int
FILE: python/build_utils.py
function log_output_name (line 56) | def log_output_name (name):
function open_and_log_name (line 63) | def open_and_log_name (name, dir):
function expand_template (line 72) | def expand_template (d, template_filename, extra = ""):
function output_glue (line 86) | def output_glue (dirname):
function output_makefile_fragment (line 90) | def output_makefile_fragment ():
function output_ifile_include (line 103) | def output_ifile_include (dirname):
function output_subfrag (line 117) | def output_subfrag (f, ext):
function extract_extension (line 125) | def extract_extension (template_name):
function open_src (line 133) | def open_src (name, mode):
function do_substitution (line 137) | def do_substitution (d, in_file, out_file):
function is_complex (line 172) | def is_complex (code3):
function standard_dict (line 179) | def standard_dict (name, code3, package='gr'):
function standard_dict2 (line 197) | def standard_dict2 (name, code3, package):
function standard_impl_dict2 (line 211) | def standard_impl_dict2 (name, code3, package):
FILE: python/build_utils_codes.py
function i_code (line 22) | def i_code (code3):
function o_code (line 25) | def o_code (code3):
function tap_code (line 31) | def tap_code (code3):
function i_type (line 37) | def i_type (code3):
function o_type (line 40) | def o_type (code3):
function tap_type (line 43) | def tap_type (code3):
FILE: python/qa_dsss_decoder_cc.py
class qa_dsss_decoder_cc (line 25) | class qa_dsss_decoder_cc (gr_unittest.TestCase):
method setUp (line 27) | def setUp (self):
method tearDown (line 30) | def tearDown (self):
method test_001_t (line 33) | def test_001_t (self):
FILE: python/qa_dsss_encoder_bb.py
function py_encode (line 28) | def py_encode(data, code):
class qa_dsss_encoder_bb (line 35) | class qa_dsss_encoder_bb (gr_unittest.TestCase):
method setUp (line 37) | def setUp (self):
method tearDown (line 40) | def tearDown (self):
method test_001_dsss_encoder_bb (line 43) | def test_001_dsss_encoder_bb (self):
Condensed preview — 60 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (800K chars).
[
{
"path": ".gitignore",
"chars": 46,
"preview": "\\#*\n.\\#*\n*~\n*.pyc\nbuild\nexamples/top_block.py\n"
},
{
"path": "CMakeLists.txt",
"chars": 5865,
"preview": "# Copyright 2011,2012 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; "
},
{
"path": "README.md",
"chars": 164,
"preview": "Direct Sequence Spread Spectrum blocks for GNU Radio\n\nNote: This code is not maintained. A fork with bug fixes can be fo"
},
{
"path": "apps/CMakeLists.txt",
"chars": 852,
"preview": "# Copyright 2011 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; you c"
},
{
"path": "cmake/Modules/CMakeParseArgumentsCopy.cmake",
"chars": 5891,
"preview": "# CMAKE_PARSE_ARGUMENTS(<prefix> <options> <one_value_keywords> <multi_value_keywords> args...)\n#\n# CMAKE_PARSE_ARGUMENT"
},
{
"path": "cmake/Modules/FindCppUnit.cmake",
"chars": 971,
"preview": "# http://www.cmake.org/pipermail/cmake/2006-October/011446.html\n# Modified to use pkg config and use standard var names\n"
},
{
"path": "cmake/Modules/FindGnuradioRuntime.cmake",
"chars": 1149,
"preview": "INCLUDE(FindPkgConfig)\nPKG_CHECK_MODULES(PC_GNURADIO_RUNTIME gnuradio-runtime)\n\nif(PC_GNURADIO_RUNTIME_FOUND)\n # look f"
},
{
"path": "cmake/Modules/GrMiscUtils.cmake",
"chars": 8698,
"preview": "# Copyright 2010-2011 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; "
},
{
"path": "cmake/Modules/GrPlatform.cmake",
"chars": 1675,
"preview": "# Copyright 2011 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; you c"
},
{
"path": "cmake/Modules/GrPython.cmake",
"chars": 9179,
"preview": "# Copyright 2010-2011 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; "
},
{
"path": "cmake/Modules/GrSwig.cmake",
"chars": 8679,
"preview": "# Copyright 2010-2011 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; "
},
{
"path": "cmake/Modules/GrTest.cmake",
"chars": 5570,
"preview": "# Copyright 2010-2011 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; "
},
{
"path": "cmake/Modules/dsssConfig.cmake",
"chars": 731,
"preview": "INCLUDE(FindPkgConfig)\nPKG_CHECK_MODULES(PC_DSSS dsss)\n\nFIND_PATH(\n DSSS_INCLUDE_DIRS\n NAMES dsss/api.h\n HINTS "
},
{
"path": "cmake/cmake_uninstall.cmake.in",
"chars": 1370,
"preview": "# http://www.vtk.org/Wiki/CMake_FAQ#Can_I_do_.22make_uninstall.22_with_CMake.3F\n\nIF(NOT EXISTS \"@CMAKE_CURRENT_BINARY_DI"
},
{
"path": "docs/CMakeLists.txt",
"chars": 1385,
"preview": "# Copyright 2011 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; you c"
},
{
"path": "docs/README.dsss",
"chars": 373,
"preview": "This is the dsss-write-a-block package meant as a guide to building\nout-of-tree packages. To use the dsss blocks, the Py"
},
{
"path": "docs/doxygen/CMakeLists.txt",
"chars": 2013,
"preview": "# Copyright 2011 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; you c"
},
{
"path": "docs/doxygen/Doxyfile.in",
"chars": 62979,
"preview": "# Doxyfile 1.5.7.1\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org"
},
{
"path": "docs/doxygen/Doxyfile.swig_doc.in",
"chars": 63375,
"preview": "# Doxyfile 1.6.1\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org) "
},
{
"path": "docs/doxygen/doxyxml/__init__.py",
"chars": 2474,
"preview": "#\n# Copyright 2010 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; you"
},
{
"path": "docs/doxygen/doxyxml/base.py",
"chars": 6794,
"preview": "#\n# Copyright 2010 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; you"
},
{
"path": "docs/doxygen/doxyxml/doxyindex.py",
"chars": 6551,
"preview": "#\n# Copyright 2010 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; you"
},
{
"path": "docs/doxygen/doxyxml/generated/__init__.py",
"chars": 235,
"preview": "\"\"\"\nContains generated files produced by generateDS.py.\n\nThese do the real work of parsing the doxygen xml files but the"
},
{
"path": "docs/doxygen/doxyxml/generated/compound.py",
"chars": 20296,
"preview": "#!/usr/bin/env python\n\n\"\"\"\nGenerated Mon Feb 9 19:08:05 2009 by generateDS.py.\n\"\"\"\n\nfrom string import lower as str_low"
},
{
"path": "docs/doxygen/doxyxml/generated/compoundsuper.py",
"chars": 359948,
"preview": "#!/usr/bin/env python\n\n#\n# Generated Thu Jun 11 18:44:25 2009 by generateDS.py.\n#\n\nimport sys\nimport getopt\nfrom string "
},
{
"path": "docs/doxygen/doxyxml/generated/index.py",
"chars": 1871,
"preview": "#!/usr/bin/env python\n\n\"\"\"\nGenerated Mon Feb 9 19:08:05 2009 by generateDS.py.\n\"\"\"\n\nfrom xml.dom import minidom\n\nimport"
},
{
"path": "docs/doxygen/doxyxml/generated/indexsuper.py",
"chars": 19286,
"preview": "#!/usr/bin/env python\n\n#\n# Generated Thu Jun 11 18:43:54 2009 by generateDS.py.\n#\n\nimport sys\nimport getopt\nfrom string "
},
{
"path": "docs/doxygen/doxyxml/text.py",
"chars": 1832,
"preview": "#\n# Copyright 2010 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; you"
},
{
"path": "docs/doxygen/other/group_defs.dox",
"chars": 205,
"preview": "/*!\n * \\defgroup block GNU Radio DSSS C++ Signal Processing Blocks\n * \\brief All C++ blocks that can be used from the DS"
},
{
"path": "docs/doxygen/other/main_page.dox",
"chars": 269,
"preview": "/*! \\mainpage\n\nWelcome to the GNU Radio DSSS Block\n\nThis is the intro page for the Doxygen manual generated for the DSSS"
},
{
"path": "docs/doxygen/swig_doc.py",
"chars": 8657,
"preview": "#\n# Copyright 2010,2011 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software"
},
{
"path": "examples/dsss_decoder.grc",
"chars": 20855,
"preview": "<?xml version='1.0' encoding='ASCII'?>\n<flow_graph>\n <timestamp>Wed Jun 12 15:22:45 2013</timestamp>\n <block>\n <key"
},
{
"path": "examples/dsss_decoder2.grc",
"chars": 10736,
"preview": "<?xml version='1.0' encoding='ASCII'?>\n<flow_graph>\n <timestamp>Thu Jun 13 11:49:34 2013</timestamp>\n <block>\n <key"
},
{
"path": "examples/dsss_decoder_exp.grc",
"chars": 28648,
"preview": "<?xml version='1.0' encoding='ASCII'?>\n<flow_graph>\n <timestamp>Wed May 15 15:32:08 2013</timestamp>\n <block>\n <key"
},
{
"path": "examples/dsss_decoder_rx.grc",
"chars": 29840,
"preview": "<?xml version='1.0' encoding='ASCII'?>\n<flow_graph>\n <timestamp>Thu Jun 13 14:21:14 2013</timestamp>\n <block>\n <key"
},
{
"path": "examples/dsss_decoder_tx.grc",
"chars": 19125,
"preview": "<?xml version='1.0' encoding='ASCII'?>\n<flow_graph>\n <timestamp>Thu Jun 13 12:05:41 2013</timestamp>\n <block>\n <key"
},
{
"path": "examples/dsss_encoder.grc",
"chars": 9770,
"preview": "<?xml version='1.0' encoding='ASCII'?>\n<flow_graph>\n <timestamp>Mon Jun 17 15:17:08 2013</timestamp>\n <block>\n <key"
},
{
"path": "grc/CMakeLists.txt",
"chars": 891,
"preview": "# Copyright 2011 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; you c"
},
{
"path": "grc/dsss_dsss_decoder_cc.xml",
"chars": 603,
"preview": "<?xml version=\"1.0\"?>\n<block>\n <name>dsss_decoder_cc</name>\n <key>dsss_dsss_decoder_cc</key>\n <category>dsss</categor"
},
{
"path": "grc/dsss_dsss_encoder_bb.xml",
"chars": 441,
"preview": "<block>\n <name>dsss_encoder_bb</name>\n <key>dsss_dsss_encoder_bb</key>\n <category>dsss</category>\n <import>import ds"
},
{
"path": "include/dsss/CMakeLists.txt",
"chars": 1055,
"preview": "# Copyright 2011,2012 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; "
},
{
"path": "include/dsss/api.h",
"chars": 1043,
"preview": "/*\n * Copyright 2011 Free Software Foundation, Inc.\n *\n * This file is part of GNU Radio\n *\n * GNU Radio is free softwar"
},
{
"path": "include/dsss/dsss_decoder_cc.h",
"chars": 1860,
"preview": "/* -*- c++ -*- */\n/* \n * Copyright 2014 Eric de Groot (edegroot@email.arizona.edu).\n * \n * This is free software; you ca"
},
{
"path": "include/dsss/dsss_encoder_bb.h",
"chars": 1783,
"preview": "/* -*- c++ -*- */\n/* \n * Copyright 2014 Eric de Groot (edegroot@email.arizona.edu).\n * \n * This is free software; you ca"
},
{
"path": "lib/CMakeLists.txt",
"chars": 2628,
"preview": "# Copyright 2011,2012 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; "
},
{
"path": "lib/dsss_decoder_cc_impl.cc",
"chars": 5068,
"preview": "/* -*- c++ -*- */\n/* \n * Copyright 2014 Eric de Groot (edegroot@email.arizona.edu).\n * \n * This is free software; you ca"
},
{
"path": "lib/dsss_decoder_cc_impl.h",
"chars": 1970,
"preview": "/* -*- c++ -*- */\n/* \n * Copyright 2014 Eric de Groot (edegroot@email.arizona.edu).\n * \n * This is free software; you ca"
},
{
"path": "lib/dsss_encoder_bb_impl.cc",
"chars": 3080,
"preview": "/* -*- c++ -*- */\n/* \n * Copyright 2014 Eric de Groot (edegroot@email.arizona.edu).\n * \n * This is free software; you ca"
},
{
"path": "lib/dsss_encoder_bb_impl.h",
"chars": 1683,
"preview": "/* -*- c++ -*- */\n/* \n * Copyright 2014 Eric de Groot (edegroot@email.arizona.edu).\n * \n * This is free software; you ca"
},
{
"path": "lib/qa_dsss.cc",
"chars": 1103,
"preview": "/*\n * Copyright 2012 Free Software Foundation, Inc.\n *\n * This file is part of GNU Radio\n *\n * GNU Radio is free softwar"
},
{
"path": "lib/qa_dsss.h",
"chars": 1151,
"preview": "/* -*- c++ -*- */\n/*\n * Copyright 2012 Free Software Foundation, Inc.\n *\n * This file is part of GNU Radio\n *\n * GNU Rad"
},
{
"path": "lib/test_dsss.cc",
"chars": 1389,
"preview": "/* -*- c++ -*- */\n/*\n * Copyright 2012 Free Software Foundation, Inc.\n *\n * This file is part of GNU Radio\n *\n * GNU Rad"
},
{
"path": "python/CMakeLists.txt",
"chars": 1763,
"preview": "# Copyright 2011 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; you c"
},
{
"path": "python/__init__.py",
"chars": 1791,
"preview": "#\n# Copyright 2008,2009 Free Software Foundation, Inc.\n#\n# This application is free software; you can redistribute it an"
},
{
"path": "python/build_utils.py",
"chars": 7237,
"preview": "#\n# Copyright 2004,2009,2012 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free sof"
},
{
"path": "python/build_utils_codes.py",
"chars": 1391,
"preview": "#\n# Copyright 2004 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; you"
},
{
"path": "python/qa_dsss_decoder_cc.py",
"chars": 1643,
"preview": "#!/usr/bin/env python\n# \n# Copyright 2013 <+YOU OR YOUR COMPANY+>.\n# \n# This is free software; you can redistribute it a"
},
{
"path": "python/qa_dsss_encoder_bb.py",
"chars": 2061,
"preview": "#!/usr/bin/env python\n# \n# Copyright 2013 <+YOU OR YOUR COMPANY+>.\n# \n# This is free software; you can redistribute it a"
},
{
"path": "swig/CMakeLists.txt",
"chars": 2475,
"preview": "# Copyright 2011 Free Software Foundation, Inc.\n#\n# This file is part of GNU Radio\n#\n# GNU Radio is free software; you c"
},
{
"path": "swig/dsss_swig.i",
"chars": 379,
"preview": "/* -*- c++ -*- */\n\n#define DSSS_API\n\n%include \"gnuradio.i\"\t\t\t// the common stuff\n\n//load generated python docstrings\n%in"
}
]
About this extraction
This page contains the full source code of the ericdegroot/gr-dsss GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 60 files (754.7 KB), approximately 194.3k tokens, and a symbol index with 1989 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.