Flude Logo Fast Layered Universal Document Engine API Reference
User Guides Blog
Flude » API Reference
API Reference Home
▼ Flude Python API Reference
  • ▼ ude namespace
    • ▼ ude.api_diff namespace
      • ▼ Functions
        • _extract_public_entities function
        • _get_class_signature function
        • _get_constant_signature function
        • _get_enum_signature function
        • _get_method_signature function
        • _get_type_alias_signature function
        • _get_variable_signature function
        • diff_catalogs function
      ▼ ude.cli namespace
      • ▼ Functions
        • _add_audit_subparser function
        • _add_compile_subparser function
        • _add_diff_subparser function
        • _add_parse_subparser function
        • _add_render_subparser function
        • _handle_audit function
        • _handle_compile function
        • _handle_diff 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.concurrency namespace
      • ▼ Functions
        • resolve_worker_count function
        • run_concurrently function
        ▼ Variables
        • R variable
        • T variable
      ▼ ude.config namespace
      • ▼ Classes
        • _UdeJsonFormatter class
        • 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
        • FORBIDDEN_SIDEBAR_KEYS 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
        • fields variable
        • methods variable
      ▼ ude.doc_quality namespace
      • ▼ Functions
        • _is_low_quality_docstring function
        • _split_identifier_words function
        • compute_doc_quality_findings function
        ▼ Variables
        • fields variable
        • methods 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_project_key_and_dir 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
        • _is_pid_alive function
        • 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
        • CoverageGateError class
        • FilenameCollisionResolver class
        • ParserError class
        • PluginCompatibilityError class
        • RendererError class
        • SignatureVerificationError class
        • UdeException class
        ▼ Functions
        • build_inheritance_columns function
        • render_inheritance_diagram_png function
        • sanitize_filename_slug function
        • sanitize_html_id function
        ▼ Variables
        • _DIAGRAM_BOX_H_GAP variable
        • _DIAGRAM_BOX_HEIGHT variable
        • _DIAGRAM_BOX_PAD_X variable
        • _DIAGRAM_BOX_V_GAP variable
        • _DIAGRAM_MARGIN variable
        • _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
        • _coerce_legacy_field_entries function
        • _normalize_accessor_mode function
        ▼ Variables
        • _ACCESSOR_MODE_ALIASES variable
        • ClassEntity variable
        • logger variable
        • MethodEntity variable
        • NamespaceEntity variable
        • OverloadEntity variable
        • ParameterField variable
      ▼ ude.native_parser_cache namespace
      • ▼ Classes
        • NativeParseCache class
        ▼ Functions
        • compute_backend_code_id function
        • compute_native_project_key_and_dir function
        ▼ Variables
        • logger variable
      ▼ ude.normalizer namespace
      • ▼ Classes
        • CommentNormalizer class
        ▼ Variables
        • _INLINE_LABELS variable
      ▼ ude.orchestrator namespace
      • ▼ Classes
        • UdeOrchestrator class
        ▼ Functions
        • _reject_forbidden_sidebar_keys 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
        • level variable
        • logger variable
        • tomllib variable
      ▼ ude.parsers namespace
      • ▼ ude.parsers.backend_registry namespace
        • ▼ Functions
          • get_backend_class function
          • register_backend function
          ▼ Variables
          • _REGISTRY variable
        ▼ 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_backend namespace
        • ▼ Classes
          • DoxygenParserBackend class
          ▼ Variables
          • _ENGINE_ROOT variable
          • logger variable
        ▼ ude.parsers.doxygen_base namespace
        • ▼ Classes
          • BaseDoxygenParser class
          ▼ Functions
          • _aliased_type_from_misparsed_variable function
          • _clean_py_type function
          • _compile_py_signature function
          • _dots_to_scope function
          • _extract_location function
          • _is_forward_declaration_misparse function
          • _is_generic_swig_arg function
          • _is_pointer_or_reference_type_text function
          • _is_self_referential_c_style_typedef function
          • _is_top_level_const_qualified function
          • _is_typedef_misparsed_as_variable function
          • _render_highlight_text function
          • _render_mixed_text function
          • _render_para_content function
          • _render_programlisting function
          • _resolve_access function
          • _visible function
          • strip_export_macros function
          ▼ Variables
          • _ACCESS_LITERALS variable
          • _ELABORATED_TYPE_MISPARSE_RE variable
          • _GENERIC_ARG_NAMES variable
          • _SIMPLESECT_LABELS variable
          • _VISIBILITY_RANK 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
          • register_parser function
          ▼ Variables
          • _REGISTRY variable
          • logger variable
        ▼ ude.parsers.native_backend namespace
        • ▼ Classes
          • NativeParserBackend class
        ▼ ude.parsers.native_cpp_backend namespace
        • ▼ Functions
          • _strip_internal_marked_text function
          ▼ Variables
          • _INTERNAL_BLOCK_RE variable
          • _RELATES_TAG_RE variable
          • logger variable
        ▼ ude.parsers.native_csharp_backend namespace
        • ▼ Classes
          • NativeCsTreeSitterParserBackend class
          ▼ Variables
          • logger variable
        ▼ ude.parsers.native_java_backend namespace
        • ▼ Classes
          • NativeJavaTreeSitterParserBackend class
          ▼ Variables
          • logger variable
          • SWIG_FIELDS variable
          • SWIG_METHODS variable
          • SWIG_WRAPPER_LIFECYCLE_METHODS variable
        ▼ ude.parsers.native_python_backend namespace
        • ▼ Classes
          • NativePythonAstParserBackend class
        ▼ Variables
        • __all__ variable
      ▼ ude.plugin_api namespace
      • ▼ Functions
        • check_plugin_compatibility function
        ▼ Variables
        • PLUGIN_API_VERSION variable
      ▼ ude.renderers namespace
      • ▼ Functions
        • get_renderer_class function
        • register_renderer function
        • registered_formats function
        ▼ ude.renderers.hugo_markdown namespace
        • ▼ Classes
          • CppHugoDefaultRenderer class
          • CsHugoDefaultRenderer class
          • HugoMarkdownRenderer class
          • JavaHugoDefaultRenderer class
          • PyHugoDefaultRenderer class
          ▼ Variables
          • 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
          • logger variable
        ▼ Variables
        • __all__ variable
        • _REGISTRY variable
      ▼ ude.reporting namespace
      • ▼ Classes
        • Finding class
        ▼ Functions
        • _rule_short_description function
        • coverage_report_to_findings function
        • to_codeclimate function
        • to_sarif function
        ▼ Variables
        • _RULE_DESCRIPTIONS variable
      ▼ ude.signed_config namespace
      • ▼ Functions
        • load_signed_json_override function
        • verify_signed_file function
        ▼ Variables
        • logger 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
▼ 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
      ▼ EdgeCases namespace
      • ▼ Classes
        • Handle< typename T > class
        • Point class
        • ValueRange< typename IteratorT > class
        ▼ Fields, Structures and Enums
        • FirstMatchingType< T, T > struct
        • FirstMatchingType< typename T, typename U > struct
        ▼ Functions
        • cInteropChecksum function
        • clampValue function
        • clampValue< int > function
        • clampValue< short > function
        • operator- function
        • operator+ function
        • ValueRange function
      ▼ 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 constant
        • DIAG_SUCCESS constant
        • 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

    Categories

    On this page

    Copyright © 2026 Fast Layered Universal Document Engine (Flude). Email me!