UDE Logo Universal Documentation Engine API Reference
User Guides Blog
UDE » API Reference
API Reference Home
▼ Mock SDKs
  • ▼ Mock C# API Reference
    • ▼ Classes
      • core_modeler class
      • core_modelerPINVOKE class
      • GlobalConfig class
      • GlobalLoggerProxy class
      ▼ core_modelerPINVOKE namespace
      • ▼ Classes
        • SWIGExceptionHelper class
        • SWIGPendingException class
        • SWIGStringHelper class
      ▼ CoreModeler namespace
      • ▼ Classes
        • Box class
        • IDrawable class
        • Model class
        • Point3Dd class
        • Point3Df class
        • Point3Di class
        • Shape class
        ▼ CoreModeler.Geometry namespace
        • ▼ Classes
          • Box class
          • IDrawable class
          • Point3Dd class
          • Point3Df class
          • Point3Di class
          • Shape class
        ▼ CoreModeler.Model namespace
        • ▼ Classes
          • MetadataIterator class
        ▼ Enumerations
        • RenderMode enum
      ▼ Enumerations
      • GlobalStatus enum
    ▼ Mock C++ API Reference
    • ▼ Classes
      • GlobalLogger class
      ▼ CoreModeler namespace
      • ▼ Classes
        • Model class
        ▼ CoreModeler::Geometry namespace
        • ▼ Classes
          • Box class
          • IDrawable class
          • Point3D< typename T > class
          • Shape class
        ▼ CoreModeler::Model namespace
        • ▼ Classes
          • MetadataIterator class
        ▼ Fields, Structures and Enums
        • RenderMode enum
      ▼ Fields, Structures and Enums
      • g_piValue variable
      • g_systemState variable
      • GlobalConfig struct
      • GlobalStatus enum
      ▼ Functions
      • globalInitialize function
      ▼ SystemDiagnostics namespace
      • ▼ Fields, Structures and Enums
        • DIAG_FAILURE variable
        • DIAG_SUCCESS variable
        • g_diagnosticRunCount variable
        ▼ Functions
        • checkSystemHealth function
        • pingSubsystem function
        • pingSubsystem function
        • resetCounters function
        ▼ Types
        • DiagnosticCode typedef
    ▼ Mock Java API Reference
    • ▼ Classes
      • core_modeler class
      • core_modelerJNI class
      • GlobalConfig class
      • GlobalLoggerProxy class
      • GlobalStatus class
      ▼ CoreModeler namespace
      • ▼ Classes
        • Box class
        • IDrawable class
        • Model class
        • Point3Dd class
        • Point3Df class
        • Point3Di class
        • RenderMode class
        • Shape class
        ▼ CoreModeler.Geometry namespace
        • ▼ Classes
          • Box class
          • IDrawable class
          • Point3Dd class
          • Point3Df class
          • Point3Di class
          • Shape class
        ▼ CoreModeler.Model namespace
        • ▼ Classes
          • MetadataIterator class
      ▼ java.lang namespace
      ▼ Mock Python API Reference
      • ▼ core_modeler namespace
        • ▼ Classes
          • _SwigNonDynamicMeta class
          • Box class
          • GlobalConfig class
          • GlobalLoggerProxy class
          • IDrawable class
          • Model class
          • Point3Dd class
          • Point3Df class
          • Point3Di class
          • Shape class
          ▼ Functions
          • _swig_add_metaclass function
          • _swig_repr function
          • _swig_setattr_nondynamic_class_variable function
          • _swig_setattr_nondynamic_instance_variable function
          • checkSystemHealth function
          • globalInitialize function
          • pingSubsystem function
          • resetCounters function
          ▼ Variables
          • __bases__ variable
          • __name__ variable
          • cvar variable
          • DIAG_FAILURE variable
          • DIAG_SUCCESS variable
          • GLOBAL_STATUS_ERROR variable
          • GLOBAL_STATUS_OK variable
          • GLOBAL_STATUS_WARNING variable
          • RenderMode_Shaded variable
          • RenderMode_Textured variable
          • RenderMode_Wireframe variable
    ▼ UDE Python API Reference
    • ▼ ude namespace
      • ▼ ude.cli namespace
        • ▼ Functions
          • _add_audit_subparser function
          • _add_compile_subparser function
          • _add_parse_subparser function
          • _add_render_subparser function
          • _handle_audit function
          • _handle_compile function
          • _handle_flat_flags function
          • _handle_parse function
          • _handle_render function
          • _run_pipeline_from_flags function
          • main function
          • run_pipeline function
          ▼ Variables
          • _COMMAND_HANDLERS variable
        ▼ ude.collectors namespace
        • ▼ ude.collectors.cpp_input_filter namespace
          • ▼ Functions
            • main function
          ▼ ude.collectors.dom_ignore_filter namespace
          • ▼ Functions
            • _find_markers function
            • main function
            • transform function
            ▼ Variables
            • _BEGIN_RE variable
            • _BEGIN_REPL variable
          ▼ ude.collectors.doxyfile namespace
          • ▼ Functions
            • merge_doxyfile_tiers function
            • parse_doxyfile function
            • serialize_doxyfile function
            ▼ Variables
            • logger variable
          ▼ ude.collectors.doxygen namespace
          • ▼ Classes
            • DoxygenXmlCollector class
            ▼ Variables
            • logger variable
          ▼ ude.collectors.sfinae_filter namespace
          • ▼ Functions
            • main function
            • transform function
            ▼ Variables
            • _SFINAE_PARAM_RE variable
        ▼ ude.config namespace
        • ▼ Classes
          • GlobalConfig class
          • GroupsConfig class
          ▼ Functions
          • apply_global_cfg_env function
          • logging_setup function
          • resolve_global_config_paths function
          • validate_groups_config function
          ▼ Variables
          • _UDE_FILE_FORMATTER variable
          • _UDE_FORMATTER variable
        ▼ ude.coverage namespace
        • ▼ Classes
          • CoverageReport class
          • EntityCoverage class
          ▼ Functions
          • _is_excluded_from_coverage function
          • apply_coverage_gate function
          • compute_coverage function
          • print_coverage_table function
          ▼ Variables
          • _PHANTOM_ARTIFACT_FQNS variable
          • docstring variable
          • fields variable
          • fully_qualified_name variable
          • methods variable
          • name variable
        ▼ ude.doxygen_cache namespace
        • ▼ Classes
          • HashSideCache class
          ▼ Functions
          • _hash_code_under_roots function
          • _normalize_doxyfile_for_hash function
          • build_source_manifest function
          • compute_collector_code_id function
          • compute_doxyfile_hash function
          • compute_doxygen_binary_id function
          • compute_engine_code_id function
          • compute_ir_fingerprint function
          • compute_parser_config_hash function
          • compute_project_key function
          • compute_source_manifest_hash function
          • compute_xml_fingerprint function
          • count_compounds function
          • load_fingerprint function
          • write_fingerprint_atomically function
          ▼ Variables
          • _COLLECTOR_CODE_ROOTS variable
          • _ENGINE_CODE_ROOTS variable
          • FP_VERSION variable
        ▼ ude.doxygen_lock namespace
        • ▼ Classes
          • ProjectKeyLock class
          ▼ Functions
          • publish_atomically function
        ▼ ude.formatters namespace
        • ▼ ude.formatters.signatures namespace
          • ▼ Classes
            • _CppSignatureFormatter class
            • BaseSignatureFormatter class
            • CsharpSignatureFormatter class
            • JavaSignatureFormatter class
            • PythonSignatureFormatter class
            • SegregatedMembers class
            ▼ Functions
            • collect_member_declarations function
            • collect_member_display_strings function
            • collect_segregated_member_display_strings function
            • get_signature_formatter function
            ▼ Variables
            • constants variable
            • enums variable
            • fields variable
            • type_aliases variable
        ▼ ude.interfaces namespace
        • ▼ Classes
          • BaseCollector class
          • BaseParser class
          • BaseRenderer class
          • CollectorError class
          • ParserError class
          • RendererError class
          • UdeException class
          ▼ Functions
          • sanitize_filename_slug function
          • sanitize_html_id function
          ▼ Variables
          • _RESERVED_WINDOWS_NAMES variable
          • logger variable
          • MAX_COMPONENT_CHARS variable
        ▼ ude.models namespace
        • ▼ Classes
          • ClassModel class
          • ConstantModel class
          • EnumModel class
          • InheritedMemberModel class
          • MethodModel class
          • NamespaceModel class
          • NestedClassRef class
          • OverloadModel class
          • ParameterModel class
          • ProjectCatalog class
          • TypeAliasModel class
          • VariableModel class
          ▼ Functions
          • _normalize_accessor_mode function
          ▼ Variables
          • _ACCESSOR_MODE_ALIASES variable
          • ClassEntity variable
          • logger variable
          • MethodEntity variable
          • NamespaceEntity variable
          • OverloadEntity variable
          • ParameterField variable
        ▼ ude.normalizer namespace
        • ▼ Classes
          • CommentNormalizer class
        ▼ ude.orchestrator namespace
        • ▼ Classes
          • UdeOrchestrator class
          ▼ Functions
          • _resolve_engine_default_structure function
          • _resolve_output_dir function
          • deep_merge function
          • find_global_config function
          • find_product_json function
          • load_sidebar_toml function
          • main function
          • resolve_config function
          ▼ Variables
          • _ENGINE_ROOT variable
          • _SIDEBAR_LANG_TOKENS variable
          • level variable
          • logger variable
          • tomllib variable
        ▼ ude.parsers namespace
        • ▼ ude.parsers.dialects namespace
          • ▼ Functions
            • detect_dialect function
            • get_docstring_dialect function
            • register_dialect function
            ▼ ude.parsers.dialects.base namespace
            • ▼ Classes
              • DocstringDialect class
              • DocstringParse class
              • MethodContext class
              • Overload class
              ▼ Functions
              • _clean_xrefs function
              • _clean_xrefs_in_dict function
              • _empty_parse function
              ▼ Variables
              • _XREF_RE variable
            ▼ ude.parsers.dialects.numpy_swig namespace
            • ▼ Classes
              • NumpySwigDialect class
              ▼ Functions
              • _parse_args_from_swig_sig function
              ▼ Variables
              • _AUTODOC_SIG_HINT_RE variable
              • _NUMPY_PARAMS_HINT_RE variable
            ▼ ude.parsers.dialects.plain namespace
            • ▼ Classes
              • PlainDialect class
            ▼ ude.parsers.dialects.sphinx_rst namespace
            • ▼ Classes
              • SphinxRstSwigDialect class
              ▼ Functions
              • _clean_xrefs function
              • _extract_params_from_chunk function
              • _strip_rst_fields function
              ▼ Variables
              • OVERLOAD_HEADER_RE variable
              • OVERLOAD_HINT_RE variable
              • OVERLOAD_SEP_RE variable
              • RST_PARAM_RE variable
              • RST_RETURN_RE variable
              • RST_RTYPE_RE variable
              • RST_TYPE_RE variable
              • SPHINX_FIELD_HINT_RE variable
              • SPHINX_XREF_RE variable
            ▼ Variables
            • _REGISTRY variable
            • _SCORED_DIALECTS variable
          ▼ ude.parsers.doxygen namespace
          • ▼ Variables
            • __all__ variable
          ▼ ude.parsers.doxygen_base namespace
          • ▼ Classes
            • BaseDoxygenParser class
            ▼ Functions
            • _clean_py_type function
            • _compile_py_signature function
            • _is_generic_swig_arg function
            • strip_export_macros function
            ▼ Variables
            • _GENERIC_ARG_NAMES variable
            • logger variable
            • SWIG_CSHARP_PINVOKE_HELPER_NAMES variable
            • SWIG_JAVA_GLOBALS_CONSTANTS_SUFFIX variable
            • SWIG_PROXY_INTERFACE_SUFFIX variable
            • SWIG_PYTHON_MACRO_LEAK_NAMES variable
            • SWIG_PYTHON_RUNTIME_NAMES variable
          ▼ ude.parsers.doxygen_csharp namespace
          • ▼ Classes
            • CsharpDoxygenParser class
          ▼ ude.parsers.doxygen_java namespace
          • ▼ Classes
            • JavaDoxygenParser class
          ▼ ude.parsers.doxygen_python namespace
          • ▼ Classes
            • PythonDoxygenParser class
          ▼ ude.parsers.doxygen_router namespace
          • ▼ Classes
            • _LegacyCppParser class
            • DoxygenXmlParser class
            ▼ Functions
            • get_parser_class function
            ▼ Variables
            • logger variable
          ▼ Variables
          • __all__ variable
        ▼ ude.renderers namespace
        • ▼ ude.renderers.hugo_markdown namespace
          • ▼ Classes
            • CppHugoDefaultRenderer class
            • CsHugoDefaultRenderer class
            • HugoMarkdownRenderer class
            • JavaHugoDefaultRenderer class
            • PyHugoDefaultRenderer class
            ▼ Variables
            • logger variable
          ▼ ude.renderers.oda namespace
          • ▼ Classes
            • CppHtmlODARenderer class
            • CppHugoODARenderer class
            • CsHtmlODARenderer class
            • CsHugoODARenderer class
            • JavaHtmlODARenderer class
            • JavaHugoODARenderer class
            • ODAHtmlRenderer class
            • ODAHugoMarkdownRenderer class
            • PyHtmlODARenderer class
            • PyHugoODARenderer class
            ▼ Functions
            • _sanitize_relative_filename function
            • make_resolve_filename_wrapper function
            • markdown_to_html function
            ▼ Variables
            • DEFAULT_FALLBACK_TEMPLATE variable
            • logger variable
          ▼ ude.renderers.static_html namespace
          • ▼ Classes
            • CppHtmlDefaultRenderer class
            • CsHtmlDefaultRenderer class
            • HtmlRenderer class
            • JavaHtmlDefaultRenderer class
            • PyHtmlDefaultRenderer class
            ▼ Functions
            • make_resolve_filename_wrapper function
            • markdown_to_html function
            ▼ Variables
            • DEFAULT_FALLBACK_TEMPLATE variable
            • logger variable
          ▼ Variables
          • __all__ variable
        ▼ ude.storage namespace
        • ▼ Classes
          • BuildCache class
          • BuildCacheManager class
          • L1CacheEntry class
          • L2CacheEntry class
          ▼ Functions
          • calculate_sha256 function
          • compute_template_hash function
          • get_file_metadata function
          • load_compressed_ir function
          • save_compressed_ir function
        ▼ Variables
        • __version__ variable

    Tags

    On this page

    Copyright © 2026 Universal Documentation Engine (UDE). Email me!