From 38324af84a4b61a9f682030840dc0840143b1ba5 Mon Sep 17 00:00:00 2001 From: Date: Thu, 12 Oct 2017 11:28:15 +1300 Subject: [PATCH 01/10] Fix bug on x64 where CS code wrapping truncates pointer types to int --- MummyCsharpShadowLayerGenerator.cxx | 40 +++++++++++++++++++---------- 1 file changed, 26 insertions(+), 14 deletions(-) diff --git a/MummyCsharpShadowLayerGenerator.cxx b/MummyCsharpShadowLayerGenerator.cxx index bb99a94..3275d1a 100644 --- a/MummyCsharpShadowLayerGenerator.cxx +++ b/MummyCsharpShadowLayerGenerator.cxx @@ -429,23 +429,23 @@ gxsys_stl::string /* MummyCsharpShadowLayerGenerator:: */ GetVariantTypeString(c // if (IsObject(nested_type)) { - s = "I4"; + s = "PTR"; } else if (IsChar(nested_type)) { - s = "I4"; + s = "PTR"; } else if (IsVoid(nested_type)) { - s = "I4"; + s = "PTR"; } else if (cable::Type::FundamentalTypeId == nested_type->GetTypeId()) { - s = "I4"; + s = "PTR"; } else if (cable::Type::PointerTypeId == nested_type->GetTypeId()) { - s = "I4 /* pointer */"; + s = "PTR"; } else { @@ -514,23 +514,23 @@ gxsys_stl::string /* MummyCsharpShadowLayerGenerator:: */ GetVariantTypeCastingS // if (IsObject(nested_type)) { - s = "(int) "; + s = "(uintptr_t) "; } else if (IsChar(nested_type)) { - s = "(int) "; + s = "(uintptr_t) "; } else if (IsVoid(nested_type)) { - s = "(int) "; + s = "(uintptr_t) "; } else if (cable::Type::FundamentalTypeId == nested_type->GetTypeId()) { - s = "(int) "; + s = "(uintptr_t) "; } else if (cable::Type::PointerTypeId == nested_type->GetTypeId()) { - s = "(int) /* pointer */"; + s = "(uintptr_t) /* pointer */"; } else { @@ -809,20 +809,27 @@ void MummyCsharpShadowLayerGenerator::EmitClassImplementationForShadowLayer(gxsy Emit(os, vargs.c_str()); Emit(os, ");\n"); + cable::Type *paramType = (*mit)->GetFunctionType()->GetArgument(argi); + std::string paramTypeName = GetVariantTypeString(paramType); + EmitIndent(os, 3); Emit(os, "V_VT("); Emit(os, vargs.c_str()); Emit(os, ") = VT_"); - Emit(os, GetVariantTypeString((*mit)->GetFunctionType()->GetArgument(argi)).c_str()); + Emit(os, paramTypeName.c_str()); Emit(os, ";\n"); EmitIndent(os, 3); Emit(os, "V_"); - Emit(os, GetVariantTypeString((*mit)->GetFunctionType()->GetArgument(argi)).c_str()); + if (paramTypeName == "PTR") + { + paramTypeName = "UINT_" + paramTypeName; + } + Emit(os, paramTypeName.c_str()); Emit(os, "("); Emit(os, vargs.c_str()); Emit(os, ") = "); - Emit(os, GetVariantTypeCastingString((*mit)->GetFunctionType()->GetArgument(argi)).c_str()); + Emit(os, GetVariantTypeCastingString(paramType).c_str()); Emit(os, GetArgName((*mit)->GetFunctionType(), argi)); Emit(os, ";\n"); @@ -878,7 +885,12 @@ void MummyCsharpShadowLayerGenerator::EmitClassImplementationForShadowLayer(gxsy Emit(os, "rv = ("); Emit(os, retType->GetCxxType().GetName().c_str()); Emit(os, ") V_"); - Emit(os, GetVariantTypeString(retType).c_str()); + std::string returnTypeName = GetVariantTypeString(retType); + if (returnTypeName == "PTR") + { + returnTypeName = "UINT_" + returnTypeName; + } + Emit(os, returnTypeName.c_str()); Emit(os, "(&msl_result);\n"); EmitIndent(os, 4); Emit(os, "}\n"); From 132a47b10acb129aed2fdef1f45edd878c0928d7 Mon Sep 17 00:00:00 2001 From: Date: Thu, 12 Oct 2017 11:31:07 +1300 Subject: [PATCH 02/10] Update cmake files to use castxml executable for XML generation --- .../wrappers/csharpmummy/CMakeLists.txt | 22 ++++++++++++--- MummyCMakeMacros.cmake | 28 ++++++++++++++----- MummyTesting/HandCrafted/CMakeLists.txt | 20 +++++++++++-- MummyTesting/Simple/CMakeLists.txt | 20 +++++++++++-- MummyTesting/SuppressWarnings/CMakeLists.txt | 21 +++++++++++--- 5 files changed, 90 insertions(+), 21 deletions(-) diff --git a/Examples/Vehicles/wrappers/csharpmummy/CMakeLists.txt b/Examples/Vehicles/wrappers/csharpmummy/CMakeLists.txt index 602082d..7f621b5 100644 --- a/Examples/Vehicles/wrappers/csharpmummy/CMakeLists.txt +++ b/Examples/Vehicles/wrappers/csharpmummy/CMakeLists.txt @@ -63,6 +63,22 @@ MACRO(WRAP_KIT kit lang ext) SET(${kit}_${lang}_wrapper_source_files "") SET(${kit}_${lang}_wrapper_source_files_cmake "") SET(${kit}_EL_SOURCES "") + +IF(${gccxml_EXECUTABLE} MATCHES "castxml") + SET(executable_output -o ${CMAKE_CURRENT_BINARY_DIR}) + + IF(MSVC) + SET(castxml_options -fms-compatibility -fms-extensions -fmsc-version=${MSVC_VERSION} --castxml-cc-msvc ${CMAKE_CXX_COMPILER}) + ELSE(MSVC) + SET(castxml_options --castxml-cc-gnu ${CMAKE_CXX_COMPILER}) + ENDIF(MSVC) + + SET(executable_options --castxml-start _cable_ --castxml-gccxml ${castxml_options} -D__CASTXML__) +ELSE(${gccxml_EXECUTABLE} MATCHES "castxml") + SET(executable_output -fxml=${CMAKE_CURRENT_BINARY_DIR}) + SET(executable_options -fxml-start=_cable_ --gccxml-compiler ${CMAKE_CXX_COMPILER}) +ENDIF(${gccxml_EXECUTABLE} MATCHES "castxml") + FOREACH(cxxclass ${class_list}) SET(header "${cxxclass}.h") @@ -78,15 +94,13 @@ MACRO(WRAP_KIT kit lang ext) IF(EXISTS "${${kit}_include_dirs}/${cxxclass}.h") SET(header_fullpath "${${kit}_include_dirs}/${cxxclass}.h") ENDIF(EXISTS "${${kit}_include_dirs}/${cxxclass}.h") - ADD_CUSTOM_COMMAND( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/xml/${cxxclass}.xml COMMAND ${gccxml_EXECUTABLE} ARGS - -fxml=${CMAKE_CURRENT_BINARY_DIR}/xml/${cxxclass}.xml - -fxml-start=_cable_ + ${executable_output}/xml/${cxxclass}.xml + ${executable_options} ${gccxml_include_args} -DCABLE_CONFIGURATION - --gccxml-compiler ${CMAKE_CXX_COMPILER} ${CMAKE_CURRENT_BINARY_DIR}/xml/${cxxclass}_gccxml.cxx DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/xml/${cxxclass}_gccxml.cxx diff --git a/MummyCMakeMacros.cmake b/MummyCMakeMacros.cmake index 83d8aa8..19bfb49 100644 --- a/MummyCMakeMacros.cmake +++ b/MummyCMakeMacros.cmake @@ -303,6 +303,21 @@ MACRO(WRAP_CLASSES_FOR_CSHARP wcfc_WrappedLibName wcfc_DependentTargets wcfc_Dep SET(wcfc_ExportLayerFiles "") SET(wcfc_GccxmlIncludes "") +IF(${gccxml_EXECUTABLE} MATCHES "castxml") + SET(executable_output -o ${wcfc_BinDir}) + + IF(MSVC) + SET(castxml_options -fms-compatibility -fms-extensions -fmsc-version=${MSVC_VERSION} --castxml-cc-msvc ${CMAKE_CXX_COMPILER}) + ELSE(MSVC) + SET(castxml_options --castxml-cc-gnu ${CMAKE_CXX_COMPILER}) + ENDIF(MSVC) + + SET(executable_options --castxml-start _cable_ --castxml-gccxml ${castxml_options} -D__CASTXML__) +ELSE(${gccxml_EXECUTABLE} MATCHES "castxml") + SET(executable_output -fxml=${wcfc_BinDir}) + SET(executable_options -fxml-start=_cable_ --gccxml-compiler ${CMAKE_CXX_COMPILER}) +ENDIF(${gccxml_EXECUTABLE} MATCHES "castxml") + FOREACH(instruction ${ARGN}) IF("${instruction}" MATCHES "(.+),(.+)") STRING(REGEX REPLACE "(.+),(.+)" "\\1" wcfc_Class "${instruction}") @@ -319,7 +334,7 @@ MACRO(WRAP_CLASSES_FOR_CSHARP wcfc_WrappedLibName wcfc_DependentTargets wcfc_Dep SET(wcfc_ClassName "${wcfc_Class}") ENDIF("${wcfc_Class}" MATCHES "^.*::([^:]+)$") - SET(wcfc_GccxmlFile "${wcfc_BinDir}/xml/${wcfc_FileBaseName}.xml") + SET(wcfc_GccxmlFile "/xml/${wcfc_FileBaseName}.xml") SET(wcfc_CsharpFile "${wcfc_BinDir}/csharp/${wcfc_FileBaseName}.cs") SET(wcfc_ExportLayerFile "${wcfc_BinDir}/export-layer/${wcfc_FileBaseName}EL.cxx") @@ -330,14 +345,13 @@ MACRO(WRAP_CLASSES_FOR_CSHARP wcfc_WrappedLibName wcfc_DependentTargets wcfc_Dep ) ADD_CUSTOM_COMMAND( - OUTPUT ${wcfc_GccxmlFile} + OUTPUT ${wcfc_BinDir}${wcfc_GccxmlFile} COMMAND ${gccxml_EXECUTABLE} ARGS - -fxml=${wcfc_GccxmlFile} - -fxml-start=_cable_ + ${executable_output}${wcfc_GccxmlFile} + ${executable_options} ${wcfc_GccxmlIncludes} -DCABLE_CONFIGURATION - --gccxml-compiler ${CMAKE_CXX_COMPILER} ${wcfc_BinDir}/xml/${wcfc_FileBaseName}_gccxml.cxx DEPENDS ${wcfc_BinDir}/xml/${wcfc_FileBaseName}_gccxml.cxx @@ -350,12 +364,12 @@ MACRO(WRAP_CLASSES_FOR_CSHARP wcfc_WrappedLibName wcfc_DependentTargets wcfc_Dep COMMAND ${mummy_EXECUTABLE} ARGS --settings-file ${wcfc_BinDir}/xml/${wcfc_WrappedLibName}.MummySettings.xml - --gccxml-file ${wcfc_GccxmlFile} + --gccxml-file ${wcfc_BinDir}${wcfc_GccxmlFile} --csharp-file ${wcfc_CsharpFile} --export-layer-file ${wcfc_ExportLayerFile} DEPENDS ${wcfc_BinDir}/xml/${wcfc_WrappedLibName}.MummySettings.xml - ${wcfc_GccxmlFile} + ${wcfc_BinDir}${wcfc_GccxmlFile} ${mummy_EXECUTABLE} ) diff --git a/MummyTesting/HandCrafted/CMakeLists.txt b/MummyTesting/HandCrafted/CMakeLists.txt index 947c580..73fafa4 100644 --- a/MummyTesting/HandCrafted/CMakeLists.txt +++ b/MummyTesting/HandCrafted/CMakeLists.txt @@ -38,15 +38,29 @@ CONFIGURE_FILE( @ONLY ) +IF(${gccxml_EXECUTABLE} MATCHES "castxml") + SET(executable_output -o ${gccxml_output}) + + IF(MSVC) + SET(castxml_options -fms-compatibility -fms-extensions -fmsc-version=${MSVC_VERSION} --castxml-cc-msvc ${CMAKE_CXX_COMPILER}) + ELSE(MSVC) + SET(castxml_options --castxml-cc-gnu ${CMAKE_CXX_COMPILER}) + ENDIF(MSVC) + + SET(executable_options --castxml-start _cable_ --castxml-gccxml ${castxml_options} -D__CASTXML__) +ELSE(${gccxml_EXECUTABLE} MATCHES "castxml") + SET(executable_output -fxml=${gccxml_output}) + SET(executable_options -fxml-start=_cable_ --gccxml-compiler ${CMAKE_CXX_COMPILER}) +ENDIF(${gccxml_EXECUTABLE} MATCHES "castxml") + ADD_CUSTOM_COMMAND( OUTPUT ${gccxml_output} COMMAND ${gccxml_EXECUTABLE} ARGS - -fxml=${gccxml_output} - -fxml-start=_cable_ + ${executable_output} + ${executable_options} -I${CMAKE_CURRENT_SOURCE_DIR} -DCABLE_CONFIGURATION - --gccxml-compiler ${CMAKE_CXX_COMPILER} ${CMAKE_CURRENT_BINARY_DIR}/simple_gccxml.cxx DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/simple_gccxml.cxx diff --git a/MummyTesting/Simple/CMakeLists.txt b/MummyTesting/Simple/CMakeLists.txt index 831ef12..66a908c 100644 --- a/MummyTesting/Simple/CMakeLists.txt +++ b/MummyTesting/Simple/CMakeLists.txt @@ -44,15 +44,29 @@ CONFIGURE_FILE( @ONLY ) +IF(${gccxml_EXECUTABLE} MATCHES "castxml") + SET(executable_output -o ${gccxml_output}) + + IF(MSVC) + SET(castxml_options -fms-compatibility -fms-extensions -fmsc-version=${MSVC_VERSION} --castxml-cc-msvc ${CMAKE_CXX_COMPILER}) + ELSE(MSVC) + SET(castxml_options --castxml-cc-gnu ${CMAKE_CXX_COMPILER}) + ENDIF(MSVC) + + SET(executable_options --castxml-start _cable_ --castxml-gccxml ${castxml_options} -D__CASTXML__) +ELSE(${gccxml_EXECUTABLE} MATCHES "castxml") + SET(executable_output -fxml=${gccxml_output}) + SET(executable_options -fxml-start=_cable_ --gccxml-compiler ${CMAKE_CXX_COMPILER}) +ENDIF(${gccxml_EXECUTABLE} MATCHES "castxml") + ADD_CUSTOM_COMMAND( OUTPUT ${gccxml_output} COMMAND ${gccxml_EXECUTABLE} ARGS - -fxml=${gccxml_output} - -fxml-start=_cable_ + ${executable_output} + ${executable_options} -I${CMAKE_CURRENT_SOURCE_DIR} -DCABLE_CONFIGURATION - --gccxml-compiler ${CMAKE_CXX_COMPILER} ${CMAKE_CURRENT_BINARY_DIR}/simple_gccxml.cxx DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/simple_gccxml.cxx diff --git a/MummyTesting/SuppressWarnings/CMakeLists.txt b/MummyTesting/SuppressWarnings/CMakeLists.txt index 47323e7..ca68095 100644 --- a/MummyTesting/SuppressWarnings/CMakeLists.txt +++ b/MummyTesting/SuppressWarnings/CMakeLists.txt @@ -34,15 +34,29 @@ CONFIGURE_FILE( @ONLY ) +IF(${gccxml_EXECUTABLE} MATCHES "castxml") + SET(executable_output -o ${gccxml_output}) + + IF(MSVC) + SET(castxml_options -fms-compatibility -fms-extensions -fmsc-version=${MSVC_VERSION} --castxml-cc-msvc ${CMAKE_CXX_COMPILER}) + ELSE(MSVC) + SET(castxml_options --castxml-cc-gnu ${CMAKE_CXX_COMPILER}) + ENDIF(MSVC) + + SET(executable_options --castxml-start _cable_ --castxml-gccxml ${castxml_options} -D__CASTXML__) +ELSE(${gccxml_EXECUTABLE} MATCHES "castxml") + SET(executable_output -fxml=${gccxml_output}) + SET(executable_options -fxml-start=_cable_ --gccxml-compiler ${CMAKE_CXX_COMPILER}) +ENDIF(${gccxml_EXECUTABLE} MATCHES "castxml") + ADD_CUSTOM_COMMAND( OUTPUT ${gccxml_output} COMMAND ${gccxml_EXECUTABLE} ARGS - -fxml=${gccxml_output} - -fxml-start=_cable_ + ${executable_output} + ${executable_options} -I${CMAKE_CURRENT_SOURCE_DIR} -DCABLE_CONFIGURATION - --gccxml-compiler ${CMAKE_CXX_COMPILER} ${CMAKE_CURRENT_BINARY_DIR}/${MTprefix}_gccxml.cxx DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${MTprefix}_gccxml.cxx @@ -57,7 +71,6 @@ ADD_CUSTOM_COMMAND( OUTPUT ${mummy_csharp_output} ${mummy_exportlayer_output} COMMAND ${mummy_EXECUTABLE} ARGS - --verbose --suppress-warnings 6008 --settings-file ${mummy_settings} --gccxml-file ${gccxml_output} From b17993e93b11e3f417b296768d719df7028a65c2 Mon Sep 17 00:00:00 2001 From: Date: Thu, 12 Oct 2017 11:39:38 +1300 Subject: [PATCH 03/10] Introduce __CASTXML__ compiler directive to differentiate between castxml and gccxml annotation output text Add HasAnnotation() to simplify detecting/extracting annotations Handle more cable fundamental types in ReturnTypeMatchesHintType() --- Examples/Vehicles/base/InlineWrapperHints.h | 9 +++- MummyCsharpGenerator.cxx | 34 +++++++++----- MummyUtilities.cxx | 50 ++++++++++++++------- MummyUtilities.h | 3 ++ 4 files changed, 66 insertions(+), 30 deletions(-) diff --git a/Examples/Vehicles/base/InlineWrapperHints.h b/Examples/Vehicles/base/InlineWrapperHints.h index 23c9310..2a0454c 100644 --- a/Examples/Vehicles/base/InlineWrapperHints.h +++ b/Examples/Vehicles/base/InlineWrapperHints.h @@ -14,9 +14,14 @@ // Source for that documentation is in "GXFront/gxDocumentation.cxx" // #ifdef IWH_USE_GCCXML_ATTRIBUTE -#define gxa(x) __attribute((gccxml(#x))) + #define gxa(x) __attribute((gccxml(#x))) #else -#define gxa(x) + //if being "built" with castxml, use the annotate attribute: + #ifdef __CASTXML__ + #define gxa(x) __attribute((annotate(#x))) + #else + #define gxa(x) + #endif #endif //---------------------------------------------------------------------------- diff --git a/MummyCsharpGenerator.cxx b/MummyCsharpGenerator.cxx index 67d6c50..956ccae 100644 --- a/MummyCsharpGenerator.cxx +++ b/MummyCsharpGenerator.cxx @@ -461,9 +461,19 @@ bool ReturnTypeMatchesHintType( // Values of 'type' currently present in the VTK hints file are: // if (utype == "301") { ftid = cxx::FundamentalType::Float; } + else if (utype == "303") { ftid = cxx::FundamentalType::Char; } else if (utype == "304") { ftid = cxx::FundamentalType::Int; } + else if (utype == "305") { ftid = cxx::FundamentalType::ShortInt; } + else if (utype == "306") { ftid = cxx::FundamentalType::LongInt; } else if (utype == "307") { ftid = cxx::FundamentalType::Double; } + else if (utype == "313") { ftid = cxx::FundamentalType::UnsignedChar; } + else if (utype == "314") { ftid = cxx::FundamentalType::UnsignedInt; } + else if (utype == "315") { ftid = cxx::FundamentalType::UnsignedShortInt; } + else if (utype == "316") { ftid = cxx::FundamentalType::UnsignedLongInt; } else if (utype == "30A") { ftid = cxx::FundamentalType::Int; } // vtkIdType (could be 32 or 64 bit...) + else if (utype == "30B") { ftid = cxx::FundamentalType::LongLongInt; } // vtkIdType (could be 32 or 64 bit...) + else if (utype == "30D") { ftid = cxx::FundamentalType::SignedChar; } + else if (utype == "31B") { ftid = cxx::FundamentalType::UnsignedLongLongInt; } else if (utype == "2307") { ftid = cxx::FundamentalType::Double; } // 0x2307 == double* + something? if (cxx::FundamentalType::NumberOfTypes == ftid) @@ -927,7 +937,7 @@ bool MummyCsharpGenerator::MethodWrappableAsEvent(const cable::Method* m, const if (cable::Function::FunctionId == m->GetFunctionId() || cable::Function::MethodId == m->GetFunctionId()) { - wrappableAsEvent = HasAttribute(m, "gccxml(iwhEvent)"); + wrappableAsEvent = HasAnnotation(m, "iwhEvent"); } } } @@ -961,7 +971,7 @@ bool MummyCsharpGenerator::MethodIsWrappable(const cable::Method* m, const cable if (m && wrappable) { hasDeprecatedAttribute = HasAttribute(m, "deprecated"); - hasExcludeAttribute = HasAttribute(m, "gccxml(iwhExclude)"); + hasExcludeAttribute = HasAnnotation(m, "iwhExclude"); if (hasDeprecatedAttribute || hasExcludeAttribute) { @@ -1010,7 +1020,7 @@ bool MummyCsharpGenerator::MethodIsWrappable(const cable::Method* m, const cable else if (hasExcludeAttribute) { LogWarning(mw_CouldNotWrap, << m->GetNameOfClass() << " '" << m->GetName() - << "' could not be wrapped because it is marked with the 'gccxml(iwhExclude)' attribute..." << gxsys_ios::endl); + << "' could not be wrapped because it is marked with the 'iwhExclude' annotation..." << gxsys_ios::endl); } else if (isExcludedViaBtxEtx) { @@ -1232,7 +1242,7 @@ gxsys_stl::string MummyCsharpGenerator::GetPInvokeTypeString(const cable::Type * case cable::Type::ReferenceTypeId: { - cable::Type *nested_type = cable::ReferenceType::SafeDownCast(t)->GetTarget(); + nested_type = cable::ReferenceType::SafeDownCast(t)->GetTarget(); cable::Type::TypeIdType nested_type_id = nested_type->GetTypeId(); s = "ERROR_ReferenceTypeId_not_yet_implemented_for_nested_type"; @@ -1373,7 +1383,7 @@ gxsys_stl::string MummyCsharpGenerator::GetCSharpTypeString(const cable::Type *t case cable::Type::ReferenceTypeId: { - cable::Type *nested_type = cable::ReferenceType::SafeDownCast(t)->GetTarget(); + nested_type = cable::ReferenceType::SafeDownCast(t)->GetTarget(); cable::Type::TypeIdType nested_type_id = nested_type->GetTypeId(); s = "ERROR_ReferenceTypeId_not_yet_implemented_for_nested_type"; @@ -1660,7 +1670,7 @@ bool MummyCsharpGenerator::MethodReturnValueIsCounted(const cable::Class *c, con return true; } - if (HasAttribute(m, "gccxml(iwhCounted)")) + if (HasAnnotation(m, "iwhCounted")) { return true; } @@ -3509,7 +3519,7 @@ void MummyCsharpGenerator::EmitCSharpWrapperClassAsStruct(gxsys_ios::ostream &os gxsys_stl::string fieldType; gxsys_stl::vector docblock; bool isPartial = this->GetSettings()->GetPartialClass(c); - bool fieldAccess = !HasAttribute(c, "gccxml(iwhNoFieldAccess)"); + bool fieldAccess = !HasAnnotation(c, "iwhNoFieldAccess"); // First iterate and collect all the fields in a local vector: // @@ -3879,7 +3889,7 @@ bool MummyCsharpGenerator::ValidateWrappedMethods( "'Getter' method '" << m->GetName() << "' has arguments. Should it?"); } - if (!iwhPropGetExempt && !HasAttribute(m, "gccxml(iwhPropGet)")) + if (!iwhPropGetExempt && !HasAnnotation(m, "iwhPropGet")) { if (!voidReturn && 0==cArgs) { @@ -3904,7 +3914,7 @@ bool MummyCsharpGenerator::ValidateWrappedMethods( { // It's a "setter" : warn if it's missing the iwhPropSet hint: // - if (!HasAttribute(m, "gccxml(iwhPropSet)")) + if (!HasAnnotation(m, "iwhPropSet")) { if (voidReturn && 1==cArgs) { @@ -3946,8 +3956,8 @@ void MummyCsharpGenerator::BuildPropGetsAndSetsMap( for (mit = wrapped_methods.begin(); mit != wrapped_methods.end(); ++mit) { - addingPropGet = HasAttribute(*mit, "gccxml(iwhPropGet)"); - addingPropSet = addingPropGet ? false : HasAttribute(*mit, "gccxml(iwhPropSet)"); + addingPropGet = HasAnnotation(*mit, "iwhPropGet"); + addingPropSet = addingPropGet ? false : HasAnnotation(*mit, "iwhPropSet"); if (addingPropGet || addingPropSet) { @@ -4632,7 +4642,7 @@ void MummyCsharpGenerator::EmitCSharpWrapperClass(gxsys_ios::ostream &os, const bool isDelegate = false; gxsys_stl::string tname(t->GetName()); - //isDelegate = HasAttribute(t, "gccxml(iwhDelegate)"); + //isDelegate = HasAnnotation(t, "iwhDelegate"); cable::PointerType *pt = cable::PointerType::SafeDownCast(t->GetType()); cable::FunctionType *ft = 0; diff --git a/MummyUtilities.cxx b/MummyUtilities.cxx index d4f6272..340a59b 100644 --- a/MummyUtilities.cxx +++ b/MummyUtilities.cxx @@ -37,6 +37,14 @@ #include "string.h" // strlen +#ifdef IWH_USE_GCCXML_ATTRIBUTE +const std::string ANNOTATION_TEXT = "gccxml"; +#else +const std::string ANNOTATION_TEXT = "annotate"; +#endif + +const std::string ANNOTATION_FORMAT("%s(%s"); +const std::string ANNOTATION_REGULAR_EXPRESSION_FORMAT("(%s\\(%s)([^\\)]*)(\\))"); //---------------------------------------------------------------------------- void Trace(const char *s) @@ -160,16 +168,13 @@ bool HasMapToType(const cable::Type *t) { if (IsObject(t)) { - return HasAttribute(cable::ClassType::SafeDownCast(t)->GetClass(), - "gccxml(iwhMapToType"); + return HasAnnotation(cable::ClassType::SafeDownCast(t)->GetClass(),"iwhMapToType"); } if ((cable::Type::ReferenceTypeId == t->GetTypeId()) && IsObject(cable::ReferenceType::SafeDownCast(t)->GetTarget())) { - return HasAttribute(cable::ClassType::SafeDownCast( - cable::ReferenceType::SafeDownCast(t)->GetTarget())->GetClass(), - "gccxml(iwhMapToType"); + return HasAnnotation(cable::ClassType::SafeDownCast(cable::ReferenceType::SafeDownCast(t)->GetTarget())->GetClass(),"iwhMapToType"); } return false; @@ -566,29 +571,42 @@ bool HasAttribute(const cable::SourceObject *o, const char *attr) return false; } +//---------------------------------------------------------------------------- +bool HasAnnotation(const gxsys_stl::string& atts, const gxsys_stl::string& tag) +{ + if (atts != "") + { + char* text = new char[ANNOTATION_FORMAT.length() + ANNOTATION_TEXT.length() + tag.length()]; + sprintf(text, ANNOTATION_FORMAT.c_str(), ANNOTATION_TEXT.c_str(), tag.c_str()); + return (gxsys_stl::string::npos != atts.find(text)); + } + + return false; +} + +//---------------------------------------------------------------------------- +bool HasAnnotation(const cable::SourceObject *o, const gxsys_stl::string& tag) +{ + gxsys_stl::string atts(o->GetAttributes()); + return HasAnnotation(atts, tag); +} //---------------------------------------------------------------------------- bool IsUtilityClass(const cable::Class *c) { - return HasAttribute(c, "gccxml(iwhUtility)"); + return HasAnnotation(c, "iwhUtility"); } - //---------------------------------------------------------------------------- gxsys_stl::string ExtractAttribute(const gxsys_stl::string& atts, const gxsys_stl::string& attBase) { gxsys_stl::string extracted; - bool hasAtt = false; - - if (gxsys_stl::string::npos != atts.find(gxsys_stl::string("gccxml(") + attBase)) - { - hasAtt = true; - } - - if (hasAtt) + if (HasAnnotation(atts, attBase)) { + char* text = new char[ANNOTATION_REGULAR_EXPRESSION_FORMAT.length() + ANNOTATION_TEXT.length() + attBase.length()]; + sprintf(text, ANNOTATION_REGULAR_EXPRESSION_FORMAT.c_str(), ANNOTATION_TEXT.c_str(), attBase.c_str()); gxsys::RegularExpression re; - re.compile((gxsys_stl::string("(gccxml\\(")+attBase+")([^\\)]*)(\\))").c_str()); + re.compile(text); if (re.find(atts.c_str())) { extracted = re.match(2); diff --git a/MummyUtilities.h b/MummyUtilities.h index 3d38ed5..c594bd7 100644 --- a/MummyUtilities.h +++ b/MummyUtilities.h @@ -23,6 +23,8 @@ #include "gxsys/ios/iosfwd" #include "gxsys/stl/string" +extern const std::string ANNOTATION_TEXT; + namespace cable { class Class; @@ -88,5 +90,6 @@ bool ShouldEmitComment(const char *comment); gxsys_stl::string EncodeStringForXml(const char *s); void EmitDocumentationBlock(gxsys_ios::ostream &os, const gxsys_stl::vector& block, const unsigned int indent, bool isClassDoc = false); gxsys_stl::string ExtractDerivedName(const char *s, const cable::Named *n, bool verbose); +bool HasAnnotation(const cable::SourceObject *o, const gxsys_stl::string& tag); #endif From 5e2e8f1c92c169eaaa4e5798a39a58d9e1a2d84a Mon Sep 17 00:00:00 2001 From: toddm Date: Thu, 12 Oct 2017 22:32:00 +1300 Subject: [PATCH 04/10] Only wrap enumerations with class scope, if the owner class is wrappable --- MummyCsharpGenerator.cxx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/MummyCsharpGenerator.cxx b/MummyCsharpGenerator.cxx index 956ccae..34376db 100644 --- a/MummyCsharpGenerator.cxx +++ b/MummyCsharpGenerator.cxx @@ -764,11 +764,18 @@ bool MummyCsharpGenerator::FundamentalTypeIsWrappable(const cable::Type* t) bool MummyCsharpGenerator::TypeIsWrappable(const cable::Type* t) { bool wrappable = false; + cable::Class* c; switch (t->GetTypeId()) { case cable::Type::EnumerationTypeId: wrappable = true; + c = cable::Class::SafeDownCast(cable::EnumerationType::SafeDownCast(t)->GetEnumeration()->GetContext()); + if (c) + { + //if the enumeration has class scope, then the class must be wrappable too + wrappable = ClassIsWrappable(c); + } break; case cable::Type::FundamentalTypeId: From 6b62256abd17f028e75c1c174b96322fa080bd3e Mon Sep 17 00:00:00 2001 From: Todd Martin Date: Fri, 13 Oct 2017 09:17:16 +1300 Subject: [PATCH 05/10] Use decent variable name --- MummyCsharpGenerator.cxx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/MummyCsharpGenerator.cxx b/MummyCsharpGenerator.cxx index 34376db..272bf36 100644 --- a/MummyCsharpGenerator.cxx +++ b/MummyCsharpGenerator.cxx @@ -764,17 +764,17 @@ bool MummyCsharpGenerator::FundamentalTypeIsWrappable(const cable::Type* t) bool MummyCsharpGenerator::TypeIsWrappable(const cable::Type* t) { bool wrappable = false; - cable::Class* c; + cable::Class* enum_class; switch (t->GetTypeId()) { case cable::Type::EnumerationTypeId: wrappable = true; - c = cable::Class::SafeDownCast(cable::EnumerationType::SafeDownCast(t)->GetEnumeration()->GetContext()); - if (c) + enum_class = cable::Class::SafeDownCast(cable::EnumerationType::SafeDownCast(t)->GetEnumeration()->GetContext()); + if (enum_class) { //if the enumeration has class scope, then the class must be wrappable too - wrappable = ClassIsWrappable(c); + wrappable = ClassIsWrappable(enum_class); } break; From 10b3a5e65d307c51014843aa3017e5d1377e6ea2 Mon Sep 17 00:00:00 2001 From: Todd Martin Date: Fri, 13 Oct 2017 19:50:00 +1300 Subject: [PATCH 06/10] Fix C# code generation for fundamental array types --- MummyCsharpGenerator.cxx | 158 +++++++++++++++++++++------------------ MummyCsharpGenerator.h | 4 +- 2 files changed, 87 insertions(+), 75 deletions(-) diff --git a/MummyCsharpGenerator.cxx b/MummyCsharpGenerator.cxx index 272bf36..8152e72 100644 --- a/MummyCsharpGenerator.cxx +++ b/MummyCsharpGenerator.cxx @@ -295,77 +295,86 @@ bool MummyCsharpGenerator::IsReservedMethodName(const gxsys_stl::string &name) name == "ToString"); } +//---------------------------------------------------------------------------- +gxsys_stl::string MummyCsharpGenerator::GetFundamentalTypeString(const cxx::FundamentalType::Id typeId, bool isArray) +{ + gxsys_stl::string s; + + switch (typeId) + { + case cxx::FundamentalType::Char: + case cxx::FundamentalType::UnsignedChar: + s = "byte"; + break; + + case cxx::FundamentalType::UnsignedShortInt: + s = isArray ? GetFundamentalTypeString(cxx::FundamentalType::ShortInt) : "ushort"; + break; + + case cxx::FundamentalType::UnsignedInt: + case cxx::FundamentalType::UnsignedLongInt: + s = isArray ? GetFundamentalTypeString(cxx::FundamentalType::Int) : "uint"; + break; + + case cxx::FundamentalType::SignedChar: + s = isArray ? GetFundamentalTypeString(cxx::FundamentalType::UnsignedChar) : "sbyte"; + break; + + case cxx::FundamentalType::ShortInt: + s = "short"; + break; + + case cxx::FundamentalType::Int: + case cxx::FundamentalType::LongInt: + s = "int"; + break; + + case cxx::FundamentalType::Bool: + s = "bool"; + break; + + case cxx::FundamentalType::Float: + s = "float"; + break; + + case cxx::FundamentalType::Double: + s = "double"; + break; + + case cxx::FundamentalType::Void: + s = "void"; + break; + + case cxx::FundamentalType::UnsignedLongLongInt: + s = isArray ? GetFundamentalTypeString(cxx::FundamentalType::LongLongInt) : "ulong"; + break; + + case cxx::FundamentalType::LongLongInt: + s = "long"; + break; + + //case cxx::FundamentalType::WChar_t: + //case cxx::FundamentalType::LongDouble: + //case cxx::FundamentalType::ComplexFloat: + //case cxx::FundamentalType::ComplexDouble: + //case cxx::FundamentalType::ComplexLongDouble: + //case cxx::FundamentalType::NumberOfTypes: + + default: + break; + } + + return s; +} //---------------------------------------------------------------------------- -gxsys_stl::string MummyCsharpGenerator::GetFundamentalTypeString(const cable::Type *t) +gxsys_stl::string MummyCsharpGenerator::GetFundamentalTypeString(const cable::Type *t, bool isArray) { gxsys_stl::string s; if (cable::Type::FundamentalTypeId == t->GetTypeId()) { - switch (cxx::FundamentalType::SafeDownCast(t->GetCxxType().GetType())->GetId()) - { - case cxx::FundamentalType::UnsignedChar: - s = "byte"; - break; - - case cxx::FundamentalType::UnsignedShortInt: - s = "ushort"; - break; - - case cxx::FundamentalType::UnsignedInt: - case cxx::FundamentalType::UnsignedLongInt: - s = "uint"; - break; - - case cxx::FundamentalType::SignedChar: - case cxx::FundamentalType::Char: - s = "sbyte"; - break; - - case cxx::FundamentalType::ShortInt: - s = "short"; - break; - - case cxx::FundamentalType::Int: - case cxx::FundamentalType::LongInt: - s = "int"; - break; - - case cxx::FundamentalType::Bool: - s = "bool"; - break; - - case cxx::FundamentalType::Float: - s = "float"; - break; - - case cxx::FundamentalType::Double: - s = "double"; - break; - - case cxx::FundamentalType::Void: - s = "void"; - break; - - case cxx::FundamentalType::UnsignedLongLongInt: - s = "ulong"; - break; - - case cxx::FundamentalType::LongLongInt: - s = "long"; - break; - - //case cxx::FundamentalType::WChar_t: - //case cxx::FundamentalType::LongDouble: - //case cxx::FundamentalType::ComplexFloat: - //case cxx::FundamentalType::ComplexDouble: - //case cxx::FundamentalType::ComplexLongDouble: - //case cxx::FundamentalType::NumberOfTypes: - - default: - break; - } + s = GetFundamentalTypeString(cxx::FundamentalType::SafeDownCast(t->GetCxxType().GetType())->GetId(), isArray); } if (s == "") @@ -1151,7 +1160,7 @@ gxsys_stl::string MummyCsharpGenerator::GetPInvokeTypeString(const cable::Type * break; case cable::Type::FundamentalTypeId: - s = GetFundamentalTypeString(t); + s = GetFundamentalTypeString(t, isArray); // C# byte maps automatically to C++ bool via PInvoke // @@ -1325,7 +1334,7 @@ gxsys_stl::string MummyCsharpGenerator::GetCSharpTypeString(const cable::Type *t break; case cable::Type::FundamentalTypeId: - s = GetFundamentalTypeString(t); + s = GetFundamentalTypeString(t, isArray); break; case cable::Type::ArrayTypeId: @@ -1345,7 +1354,7 @@ gxsys_stl::string MummyCsharpGenerator::GetCSharpTypeString(const cable::Type *t { s = GetCSharpTypeString(nested_type, forReturn, isArray); } - else if (IsChar(nested_type)) + else if (IsChar(nested_type) && !isArray) { s = "string"; } @@ -2748,7 +2757,8 @@ void MummyCsharpGenerator::EmitCSharpMethodBody(gxsys_ios::ostream &os, unsigned if (!voidReturn) { - if (retArraySize != "") + bool isArray = (retArraySize != ""); + if (isArray) { Emit(os, rvpType.c_str()); Emit(os, " rvp = "); // rvp == return value pointer @@ -2776,13 +2786,13 @@ void MummyCsharpGenerator::EmitCSharpMethodBody(gxsys_ios::ostream &os, unsigned Emit(os, rvType.c_str()); Emit(os, " rv = "); // rv == return value } - } - // Open any special marshalling blocks required: - // - if (IsCharPointer(retType)) - { - Emit(os, "Marshal.PtrToStringAnsi("); + // Open any special marshalling blocks required: + // + if (IsCharPointer(retType) && !isArray) + { + Emit(os, "Marshal.PtrToStringAnsi("); + } } // Call the DllImport function: diff --git a/MummyCsharpGenerator.h b/MummyCsharpGenerator.h index 43ae231..ebb81cd 100644 --- a/MummyCsharpGenerator.h +++ b/MummyCsharpGenerator.h @@ -29,7 +29,7 @@ class MummyCsharpGenerator : public MummyGenerator virtual bool IsKeyword(const char *p); virtual bool IsReservedMethodName(const gxsys_stl::string &name); - virtual gxsys_stl::string GetFundamentalTypeString(const cable::Type *t); + virtual gxsys_stl::string GetFundamentalTypeString(const cable::Type *t, bool isArray); virtual gxsys_stl::string GetWrappedMethodName(const cable::Method *m); virtual gxsys_stl::string GetMethodArgumentArraySize(const cable::Class *c, const cable::Method *m, const cable::FunctionType *ft, unsigned int i); virtual gxsys_stl::string GetMethodSignature(const cable::Class *c, const cable::Method *m); @@ -105,6 +105,8 @@ class MummyCsharpGenerator : public MummyGenerator MummyCsharpGenerator(const MummyCsharpGenerator&); //Not implemented MummyCsharpGenerator& operator=(const MummyCsharpGenerator&); //Not implemented + + gxsys_stl::string GetFundamentalTypeString(const cxx::FundamentalType::Id typeId, bool isArray = false); }; #endif From a3ccb5b38c9c6df5d8df938b46b34e52e18cade8 Mon Sep 17 00:00:00 2001 From: Todd Martin Date: Fri, 13 Oct 2017 19:50:00 +1300 Subject: [PATCH 07/10] Fix C# code generation for fundamental array types --- MummyCsharpGenerator.cxx | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/MummyCsharpGenerator.cxx b/MummyCsharpGenerator.cxx index 8152e72..6f0f421 100644 --- a/MummyCsharpGenerator.cxx +++ b/MummyCsharpGenerator.cxx @@ -2755,9 +2755,9 @@ void MummyCsharpGenerator::EmitCSharpMethodBody(gxsys_ios::ostream &os, unsigned // EmitIndent(os, indent); + bool isArray = (retArraySize != ""); if (!voidReturn) { - bool isArray = (retArraySize != ""); if (isArray) { Emit(os, rvpType.c_str()); @@ -2786,15 +2786,15 @@ void MummyCsharpGenerator::EmitCSharpMethodBody(gxsys_ios::ostream &os, unsigned Emit(os, rvType.c_str()); Emit(os, " rv = "); // rv == return value } - - // Open any special marshalling blocks required: - // - if (IsCharPointer(retType) && !isArray) - { - Emit(os, "Marshal.PtrToStringAnsi("); - } } + // Open any special marshalling blocks required: + // + if (!isArray && IsCharPointer(retType)) + { + Emit(os, "Marshal.PtrToStringAnsi("); + } + // Call the DllImport function: // Emit(os, f.c_str()); @@ -3006,7 +3006,7 @@ void MummyCsharpGenerator::EmitCSharpMethodBody(gxsys_ios::ostream &os, unsigned Emit(os, "\n"); } - else if (IsCharPointer(retType)) + else if (!isArray && IsCharPointer(retType)) { Emit(os, ");\n"); } From fb027c0fcccc14cea1417a88e24a93f3d3445d33 Mon Sep 17 00:00:00 2001 From: Todd Martin Date: Sat, 14 Oct 2017 23:36:33 +1300 Subject: [PATCH 08/10] Char and unsigned Char both map to byte in c# --- Examples/Vehicles/wrappers/csharpmummy/ManualTestBlatMobile.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Examples/Vehicles/wrappers/csharpmummy/ManualTestBlatMobile.cs b/Examples/Vehicles/wrappers/csharpmummy/ManualTestBlatMobile.cs index 58d2acc..b9acc99 100644 --- a/Examples/Vehicles/wrappers/csharpmummy/ManualTestBlatMobile.cs +++ b/Examples/Vehicles/wrappers/csharpmummy/ManualTestBlatMobile.cs @@ -50,7 +50,7 @@ public static void TestBlatMobile(BlatMobile b1) b1.VUnsignedInt(0x2222); b1.VUnsignedLong(0x33333333); b1.VUnsignedInt64(0x4444444444444444); - b1.VChar((sbyte)'b'); + b1.VChar((byte)'b'); b1.VShort(0x55); b1.VInt(0x6666); b1.VLong(0x77777777); From 5e4ca4c5a963b605e73269074eee04aaf7ba4ca2 Mon Sep 17 00:00:00 2001 From: Todd Martin Date: Thu, 19 Oct 2017 11:43:46 +1300 Subject: [PATCH 09/10] Remove unnecessary castxml options for msvc --- Examples/Vehicles/wrappers/csharpmummy/CMakeLists.txt | 6 +++--- MummyCMakeMacros.cmake | 6 +++--- MummyTesting/HandCrafted/CMakeLists.txt | 6 +++--- MummyTesting/Simple/CMakeLists.txt | 6 +++--- MummyTesting/SuppressWarnings/CMakeLists.txt | 6 +++--- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/Examples/Vehicles/wrappers/csharpmummy/CMakeLists.txt b/Examples/Vehicles/wrappers/csharpmummy/CMakeLists.txt index 7f621b5..29bae7f 100644 --- a/Examples/Vehicles/wrappers/csharpmummy/CMakeLists.txt +++ b/Examples/Vehicles/wrappers/csharpmummy/CMakeLists.txt @@ -68,12 +68,12 @@ IF(${gccxml_EXECUTABLE} MATCHES "castxml") SET(executable_output -o ${CMAKE_CURRENT_BINARY_DIR}) IF(MSVC) - SET(castxml_options -fms-compatibility -fms-extensions -fmsc-version=${MSVC_VERSION} --castxml-cc-msvc ${CMAKE_CXX_COMPILER}) + SET(compiler msvc) ELSE(MSVC) - SET(castxml_options --castxml-cc-gnu ${CMAKE_CXX_COMPILER}) + SET(compiler gnu) ENDIF(MSVC) - SET(executable_options --castxml-start _cable_ --castxml-gccxml ${castxml_options} -D__CASTXML__) + SET(executable_options --castxml-start _cable_ --castxml-gccxml --castxml-cc-${compiler} ${CMAKE_CXX_COMPILER} -D__CASTXML__) ELSE(${gccxml_EXECUTABLE} MATCHES "castxml") SET(executable_output -fxml=${CMAKE_CURRENT_BINARY_DIR}) SET(executable_options -fxml-start=_cable_ --gccxml-compiler ${CMAKE_CXX_COMPILER}) diff --git a/MummyCMakeMacros.cmake b/MummyCMakeMacros.cmake index 19bfb49..246c0d7 100644 --- a/MummyCMakeMacros.cmake +++ b/MummyCMakeMacros.cmake @@ -307,12 +307,12 @@ IF(${gccxml_EXECUTABLE} MATCHES "castxml") SET(executable_output -o ${wcfc_BinDir}) IF(MSVC) - SET(castxml_options -fms-compatibility -fms-extensions -fmsc-version=${MSVC_VERSION} --castxml-cc-msvc ${CMAKE_CXX_COMPILER}) + SET(compiler msvc) ELSE(MSVC) - SET(castxml_options --castxml-cc-gnu ${CMAKE_CXX_COMPILER}) + SET(compiler gnu) ENDIF(MSVC) - SET(executable_options --castxml-start _cable_ --castxml-gccxml ${castxml_options} -D__CASTXML__) + SET(executable_options --castxml-start _cable_ --castxml-gccxml --castxml-cc-${compiler} ${CMAKE_CXX_COMPILER} -D__CASTXML__) ELSE(${gccxml_EXECUTABLE} MATCHES "castxml") SET(executable_output -fxml=${wcfc_BinDir}) SET(executable_options -fxml-start=_cable_ --gccxml-compiler ${CMAKE_CXX_COMPILER}) diff --git a/MummyTesting/HandCrafted/CMakeLists.txt b/MummyTesting/HandCrafted/CMakeLists.txt index 73fafa4..35b6965 100644 --- a/MummyTesting/HandCrafted/CMakeLists.txt +++ b/MummyTesting/HandCrafted/CMakeLists.txt @@ -42,12 +42,12 @@ IF(${gccxml_EXECUTABLE} MATCHES "castxml") SET(executable_output -o ${gccxml_output}) IF(MSVC) - SET(castxml_options -fms-compatibility -fms-extensions -fmsc-version=${MSVC_VERSION} --castxml-cc-msvc ${CMAKE_CXX_COMPILER}) + SET(compiler msvc) ELSE(MSVC) - SET(castxml_options --castxml-cc-gnu ${CMAKE_CXX_COMPILER}) + SET(compiler gnu) ENDIF(MSVC) - SET(executable_options --castxml-start _cable_ --castxml-gccxml ${castxml_options} -D__CASTXML__) + SET(executable_options --castxml-start _cable_ --castxml-gccxml --castxml-cc-${compiler} ${CMAKE_CXX_COMPILER} -D__CASTXML__) ELSE(${gccxml_EXECUTABLE} MATCHES "castxml") SET(executable_output -fxml=${gccxml_output}) SET(executable_options -fxml-start=_cable_ --gccxml-compiler ${CMAKE_CXX_COMPILER}) diff --git a/MummyTesting/Simple/CMakeLists.txt b/MummyTesting/Simple/CMakeLists.txt index 66a908c..ed60578 100644 --- a/MummyTesting/Simple/CMakeLists.txt +++ b/MummyTesting/Simple/CMakeLists.txt @@ -48,12 +48,12 @@ IF(${gccxml_EXECUTABLE} MATCHES "castxml") SET(executable_output -o ${gccxml_output}) IF(MSVC) - SET(castxml_options -fms-compatibility -fms-extensions -fmsc-version=${MSVC_VERSION} --castxml-cc-msvc ${CMAKE_CXX_COMPILER}) + SET(compiler msvc) ELSE(MSVC) - SET(castxml_options --castxml-cc-gnu ${CMAKE_CXX_COMPILER}) + SET(compiler gnu) ENDIF(MSVC) - SET(executable_options --castxml-start _cable_ --castxml-gccxml ${castxml_options} -D__CASTXML__) + SET(executable_options --castxml-start _cable_ --castxml-gccxml --castxml-cc-${compiler} ${CMAKE_CXX_COMPILER} -D__CASTXML__) ELSE(${gccxml_EXECUTABLE} MATCHES "castxml") SET(executable_output -fxml=${gccxml_output}) SET(executable_options -fxml-start=_cable_ --gccxml-compiler ${CMAKE_CXX_COMPILER}) diff --git a/MummyTesting/SuppressWarnings/CMakeLists.txt b/MummyTesting/SuppressWarnings/CMakeLists.txt index ca68095..517de0b 100644 --- a/MummyTesting/SuppressWarnings/CMakeLists.txt +++ b/MummyTesting/SuppressWarnings/CMakeLists.txt @@ -38,12 +38,12 @@ IF(${gccxml_EXECUTABLE} MATCHES "castxml") SET(executable_output -o ${gccxml_output}) IF(MSVC) - SET(castxml_options -fms-compatibility -fms-extensions -fmsc-version=${MSVC_VERSION} --castxml-cc-msvc ${CMAKE_CXX_COMPILER}) + SET(compiler msvc) ELSE(MSVC) - SET(castxml_options --castxml-cc-gnu ${CMAKE_CXX_COMPILER}) + SET(compiler gnu) ENDIF(MSVC) - SET(executable_options --castxml-start _cable_ --castxml-gccxml ${castxml_options} -D__CASTXML__) + SET(executable_options --castxml-start _cable_ --castxml-gccxml --castxml-cc-${compiler} ${CMAKE_CXX_COMPILER} -D__CASTXML__) ELSE(${gccxml_EXECUTABLE} MATCHES "castxml") SET(executable_output -fxml=${gccxml_output}) SET(executable_options -fxml-start=_cable_ --gccxml-compiler ${CMAKE_CXX_COMPILER}) From ad41ff4d08fb68c1ad81e5670ac8b0c9bc7c4265 Mon Sep 17 00:00:00 2001 From: Todd Martin Date: Wed, 1 Nov 2017 14:27:46 +1300 Subject: [PATCH 10/10] Update Doxygen file --- MummyDoxygen.doxyfile.in | 2620 +++++++++++++++++++++++++++----------- 1 file changed, 1878 insertions(+), 742 deletions(-) diff --git a/MummyDoxygen.doxyfile.in b/MummyDoxygen.doxyfile.in index 3d5c3d3..b210e8b 100644 --- a/MummyDoxygen.doxyfile.in +++ b/MummyDoxygen.doxyfile.in @@ -1,89 +1,122 @@ -# Doxyfile 1.5.4 +# Doxyfile 1.8.13 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project +# doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single 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 (" ") +# 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. +# 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. +# The default value is: UTF-8. 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. +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. PROJECT_NAME = mummy -# 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. +# 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 = @Mummy_VERSION_MAJOR@.@Mummy_VERSION_MINOR@.@Mummy_VERSION_PATCH@ -# 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. +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. 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 = "@CMAKE_CURRENT_BINARY_DIR@/doxygen" -# 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. +# 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 causes +# performance problems for the file system. +# The default value is: NO. 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, Finnish, French, German, Greek, Hungarian, -# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, -# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, -# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = 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. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. 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. +# If the BRIEF_MEMBER_DESC tag is set to YES, 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. +# The default value is: YES. 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 +# If the REPEAT_BRIEF tag is set to YES, 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. +# The default value is: YES. 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" +# 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 and the. ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ @@ -97,420 +130,690 @@ ABBREVIATE_BRIEF = "The $name class" \ an \ the -# 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 +# 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. +# The default value is: NO. 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 +# 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. +# The default value is: NO. 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. +# If the FULL_PATH_NAMES tag is set to YES, 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 +# The default value is: YES. 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. +# 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. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = "@CMAKE_CURRENT_SOURCE_DIR@/" -# 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. +# 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 list of include paths that are normally passed to the compiler +# using the -I flag. -STRIP_FROM_INC_PATH = +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. +# 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. +# The default value is: NO. SHORT_NAMES = @Mummy_DOXYGEN_SHORT_NAMES@ -# 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.) +# 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-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. 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.) +# 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 Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. 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. +# 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 behavior. 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 behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. 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. +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. 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. +# 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. +# The default value is: NO. 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. +# 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. +# Minimum value: 1, maximum value: 16, default value: 4. 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. +# This tag can be used to specify a number of aliases that act 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 = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. -ALIASES = +TCL_SUBST = -# 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. +# 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. +# The default value is: NO. 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. +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_JAVA = 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 +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +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. +# The default value is: NO. + +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 (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. 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: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# 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); +# versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. +# The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. +# The default value is: NO. 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. +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) 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. +# The default value is: NO. SIP_SUPPORT = NO -# 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 +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES 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. +# The default value is: YES. + +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. +# The default value is: NO. 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. +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES 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. +# The default value is: YES. SUBGROUPING = YES -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is -# documented as struct 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 where the coding convention is that all structs are -# typedef'ed and only the typedef is referenced never the struct's name. +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag 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. +# The default value is: NO. TYPEDEF_HIDES_STRUCT = NO +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_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 +# 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 respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. EXTRACT_ALL = YES -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. EXTRACT_PRIVATE = YES -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. 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. +# 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. Does not have any effect +# for Java sources. +# The default value is: YES. 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. +# This flag is only useful for Objective-C code. If 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, only methods in the interface are +# included. +# The default value is: NO. 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. +# 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. +# The default value is: NO. 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. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO 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. +# The default value is: NO. 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. +# 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, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. 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. +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. 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. +# 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, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. 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. +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. 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 +# 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. +# The default value is: system dependent. CASE_SENSE_NAMES = NO -# 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. +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. 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. +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. 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. +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. 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. +# If the SORT_MEMBER_DOCS tag is set to YES 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. +# The default value is: YES. 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. +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. SORT_BRIEF_DOCS = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. +# 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 constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: 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 group names will +# appear in their defined order. +# The default value is: NO. + +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 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. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. 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. +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = 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. +# The default value is: YES. 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. +# 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. +# The default value is: YES. 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. +# 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. +# The default value is: YES. 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. +# 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. +# The default value is: YES. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. -ENABLED_SECTIONS = +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. +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have 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 value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. 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 +# 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. +# The default value is: YES. 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. +# 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 value 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 value 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. For an example see the documentation. -SHOW_DIRECTORIES = NO +FILE_VERSION_FILTER = -# 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 , where is the value of -# the FILE_VERSION_FILTER tag, and 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. +# 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. To 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. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. -FILE_VERSION_FILTER = +CITE_BIB_FILES = #--------------------------------------------------------------------------- -# configuration options related to warning and progress messages +# 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. +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. QUIET = NO -# 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. +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. 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. +# If the WARN_IF_UNDOCUMENTED tag 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. +# The default value is: YES. 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. +# If the WARN_IF_DOC_ERROR tag 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. +# The default value is: YES. 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. +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. 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) +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = 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) +# The default value is: $file:$line: $text. WARN_FORMAT = "$file($line): warning: $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. +# 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 standard +# error (stderr). -WARN_LOGFILE = +WARN_LOGFILE = #--------------------------------------------------------------------------- -# configuration options related to the input files +# 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. +# The INPUT tag is 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. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. INPUT = "@CMAKE_CURRENT_SOURCE_DIR@" -# 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. +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. 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 +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. FILE_PATTERNS = *.c \ *.cc \ @@ -540,800 +843,1633 @@ FILE_PATTERNS = *.c \ *.dox \ *.py -# 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. +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. RECURSIVE = NO -# 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 +# The EXCLUDE tag can be used to specify files and/or directories that should be +# 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. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. -EXCLUDE = +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 +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded # from the input. +# The default value is: NO. 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/* +# 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 = +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 +# 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 +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* -EXCLUDE_SYMBOLS = +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). +# 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 = +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. +# 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. +# 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. +# The default value is: NO. 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). +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be 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: +# +# +# +# where is the value of the INPUT_FILTER tag, and 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. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +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 information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. -IMAGE_PATH = +FILTER_PATTERNS = -# 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 , where -# is the value of the INPUT_FILTER tag, and 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. +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. -INPUT_FILTER = +FILTER_SOURCE_FILES = NO -# 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. +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. -FILTER_PATTERNS = +FILTER_SOURCE_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). +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. -FILTER_SOURCE_FILES = NO +USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- -# configuration options related to source browsing +# 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. If you have enabled CALL_GRAPH or CALLER_GRAPH -# then you must also enable this option. If you don't then doxygen will produce -# a warning and turn it on anyway +# 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 that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. SOURCE_BROWSER = YES -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. 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. +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES (the default) -# then for each documented function all documented -# functions referencing it will be listed. +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. REFERENCED_BY_RELATION = YES -# If the REFERENCES_RELATION tag is set to YES (the default) -# then for each documented function all documented entities -# called/used by that function will be listed. +# 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. +# The default value is: NO. 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. +# If the REFERENCES_LINK_SOURCE tag is set to YES 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. +# The default value is: YES. 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. +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = 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. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. 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. +# If the VERBATIM_HEADERS tag is set the YES 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. +# See also: Section \class. +# The default value is: YES. VERBATIM_HEADERS = YES +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + #--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index +# 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. +# 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. +# The default value is: YES. 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]) +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 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. +# 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 a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. -IGNORE_PREFIX = +IGNORE_PREFIX = #--------------------------------------------------------------------------- -# configuration options related to the HTML output +# Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. +# 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. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. 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. +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. 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 +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a # standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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 left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = +HTML_DYNAMIC_SECTIONS = NO -# 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. +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# 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 (see: http://developer.apple.com/tools/xcode/), 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset 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. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# 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. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = +GENERATE_HTMLHELP = NO -# 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! +# 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. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -HTML_STYLESHEET = +CHM_FILE = -# 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. +# 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. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -HTML_ALIGN_MEMBERS = YES +HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) -# of the generated HTML documentation. +# 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). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -GENERATE_HTMLHELP = NO +GENERATE_CHI = NO -# 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). +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -HTML_DYNAMIC_SECTIONS = NO +CHM_INDEX_ENCODING = -# 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. +# 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. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -CHM_FILE = +BINARY_TOC = NO -# 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. +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -HHC_LOCATION = +TOC_EXPAND = NO -# 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). +# 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +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 Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# 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. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_CHI = NO +DISABLE_INDEX = NO -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. +# 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. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. -BINARY_TOC = NO +GENERATE_TREEVIEW = 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. +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. -TOC_EXPAND = NO +ENUM_VALUES_PER_LINE = 4 -# 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. +# 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. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. -DISABLE_INDEX = NO +TREEVIEW_WIDTH = 250 -# 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. +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. -ENUM_VALUES_PER_LINE = 4 +EXT_LINKS_IN_WINDOW = NO -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. 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. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_TREEVIEW = NO +FORMULA_FONTSIZE = 10 -# 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. +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled 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), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /