From d9cd91492519a70d9145e09064268c2f37bc865b Mon Sep 17 00:00:00 2001 From: YaoBing Xiao Date: Sat, 3 Oct 2026 16:39:13 +0800 Subject: [PATCH 1/2] docs: include all public headers in Doxygen --- docs/doxygen/meson.build | 135 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 134 insertions(+), 1 deletion(-) diff --git a/docs/doxygen/meson.build b/docs/doxygen/meson.build index 9d3b3e02..b6847ac0 100644 --- a/docs/doxygen/meson.build +++ b/docs/doxygen/meson.build @@ -16,6 +16,13 @@ wlframe_doxygen = configure_file( ) src_files = files([ + '../../include/wlf/allocator/wlf_allocator.h', + + '../../include/wlf/animation/wlf_animation.h', + '../../include/wlf/animation/wlf_animation_group.h', + '../../include/wlf/animation/wlf_parallel_animation_group.h', + '../../include/wlf/animation/wlf_sequential_animation_group.h', + '../../include/wlf/buffer/wlf_buffer.h', '../../include/wlf/curve/curve_helpers.h', @@ -33,12 +40,18 @@ src_files = files([ '../../include/wlf/curve/wlf_curve_quint.h', '../../include/wlf/curve/wlf_curve_sine.h', + '../../include/wlf/effect/wlf_drop_shadow.h', + '../../include/wlf/effect/wlf_filter.h', + '../../include/wlf/effect/wlf_gaussian_blur.h', + '../../include/wlf/image/wlf_bmp_image.h', + '../../include/wlf/image/wlf_gif_image.h', '../../include/wlf/image/wlf_image.h', '../../include/wlf/image/wlf_jpeg_image.h', '../../include/wlf/image/wlf_png_image.h', '../../include/wlf/image/wlf_ppm_image.h', '../../include/wlf/image/wlf_webp_image.h', + '../../include/wlf/image/wlf_xpm_image.h', '../../include/wlf/math/wlf_fpoint.h', '../../include/wlf/math/wlf_frect.h', @@ -55,21 +68,76 @@ src_files = files([ '../../include/wlf/math/wlf_vector3.h', '../../include/wlf/math/wlf_vector4.h', + '../../include/wlf/node/wlf_circle_node.h', + '../../include/wlf/node/wlf_ellipse_node.h', + '../../include/wlf/node/wlf_event_node.h', + '../../include/wlf/node/wlf_line_node.h', + '../../include/wlf/node/wlf_path_node.h', + '../../include/wlf/node/wlf_poly_node.h', + '../../include/wlf/node/wlf_rect_node.h', + '../../include/wlf/node/wlf_rect_shape_node.h', + '../../include/wlf/node/wlf_scene_node.h', + '../../include/wlf/node/wlf_scene_tree.h', + '../../include/wlf/node/wlf_svg_node.h', + '../../include/wlf/node/wlf_text_node.h', + '../../include/wlf/node/wlf_texture_node.h', + + '../../include/wlf/pass/wlf_circle_pass.h', + '../../include/wlf/pass/wlf_ellipse_pass.h', + '../../include/wlf/pass/wlf_line_pass.h', + '../../include/wlf/pass/wlf_pass.h', + '../../include/wlf/pass/wlf_path_pass.h', + '../../include/wlf/pass/wlf_poly_pass.h', + '../../include/wlf/pass/wlf_rect_pass.h', + '../../include/wlf/pass/wlf_rect_shape_pass.h', + '../../include/wlf/pass/wlf_render_target_info.h', + '../../include/wlf/pass/wlf_texture_pass.h', + '../../include/wlf/pass/wlf_vector_pass.h', + '../../include/wlf/platform/wlf_backend.h', + '../../include/wlf/platform/wlf_fontconfig.h', + '../../include/wlf/platform/wlf_text.h', + '../../include/wlf/platform/wlf_theme.h', '../../include/wlf/renderer/wlf_renderer.h', + '../../include/wlf/scene/wlf_scene.h', + + '../../include/wlf/shapes/wlf_circle_shape.h', + '../../include/wlf/shapes/wlf_ellipse_shape.h', + '../../include/wlf/shapes/wlf_line_shape.h', + '../../include/wlf/shapes/wlf_path_shape.h', + '../../include/wlf/shapes/wlf_poly_shape.h', + '../../include/wlf/shapes/wlf_rect_shape.h', + '../../include/wlf/shapes/wlf_shape.h', + '../../include/wlf/shapes/wlf_shape_tree.h', + '../../include/wlf/shapes/wlf_symbol_shape.h', + '../../include/wlf/shapes/wlf_text_shape.h', + '../../include/wlf/shapes/wlf_use_shape.h', + + '../../include/wlf/svg/wlf_svg.h', + + '../../include/wlf/swapchain/wlf_swapchain.h', + '../../include/wlf/texture/wlf_texture.h', '../../include/wlf/types/wlf_color.h', + '../../include/wlf/types/wlf_cursor.h', + '../../include/wlf/types/wlf_format_set.h', '../../include/wlf/types/wlf_gradient.h', + '../../include/wlf/types/wlf_keyboard.h', '../../include/wlf/types/wlf_linear_gradient.h', + '../../include/wlf/types/wlf_mesh_gradient.h', '../../include/wlf/types/wlf_output.h', '../../include/wlf/types/wlf_pixel_format.h', + '../../include/wlf/types/wlf_pointer.h', '../../include/wlf/types/wlf_radial_gradient.h', + '../../include/wlf/types/wlf_touch.h', '../../include/wlf/utils/wlf_addon.h', + '../../include/wlf/utils/wlf_array.h', '../../include/wlf/utils/wlf_cmd_parser.h', + '../../include/wlf/utils/wlf_compat.h', '../../include/wlf/utils/wlf_env.h', '../../include/wlf/utils/wlf_linked_list.h', '../../include/wlf/utils/wlf_list.h', @@ -78,25 +146,90 @@ src_files = files([ '../../include/wlf/utils/wlf_time.h', '../../include/wlf/utils/wlf_utils.h', + '../../include/wlf/window/wlf_titlebar.h', '../../include/wlf/window/wlf_window.h', ]) if is_linux src_files += files([ + '../../include/wlf/allocator/egl/allocator.h', + '../../include/wlf/allocator/shm/allocator.h', + + '../../include/wlf/buffer/egl/buffer.h', + '../../include/wlf/buffer/pixman/buffer.h', + '../../include/wlf/buffer/shm/buffer.h', + '../../include/wlf/dmabuf/wlf_dmabuf.h', + '../../include/wlf/pass/gles/rect_pass.h', + '../../include/wlf/pass/gles/render_target_info.h', + '../../include/wlf/pass/gles/texture_pass.h', + '../../include/wlf/pass/gles/vector_pass.h', + '../../include/wlf/pass/pixman/rect_pass.h', + '../../include/wlf/pass/pixman/render_target_info.h', + '../../include/wlf/pass/pixman/texture_pass.h', + '../../include/wlf/pass/pixman/vector_pass.h', + '../../include/wlf/pass/vulkan/vulkan.h', + + '../../include/wlf/platform/linux/text.h', + '../../include/wlf/platform/linux/theme.h', '../../include/wlf/platform/wayland/backend.h', + '../../include/wlf/renderer/gles/egl.h', + '../../include/wlf/renderer/gles/renderer.h', '../../include/wlf/renderer/pixman/renderer.h', '../../include/wlf/renderer/vulkan/device.h', '../../include/wlf/renderer/vulkan/instance.h', '../../include/wlf/renderer/vulkan/renderer.h', + '../../include/wlf/swapchain/egl/swapchain.h', + '../../include/wlf/swapchain/shm/swapchain.h', + '../../include/wlf/swapchain/vulkan/swapchain.h', + + '../../include/wlf/texture/gles/texture.h', '../../include/wlf/texture/pixman/texture.h', '../../include/wlf/wayland/wlf_wl_compositor.h', - '../../include/wlf/wayland/wlf_wl_output.h', + '../../include/wlf/wayland/wlf_wl_cursor.h', '../../include/wlf/wayland/wlf_wl_interface.h', + '../../include/wlf/wayland/wlf_wl_keyboard.h', + '../../include/wlf/wayland/wlf_wl_output.h', + '../../include/wlf/wayland/wlf_wl_pointer.h', + '../../include/wlf/wayland/wlf_wl_seat.h', + '../../include/wlf/wayland/wlf_wl_subcompositor.h', + '../../include/wlf/wayland/wlf_wl_subsurface.h', + '../../include/wlf/wayland/wlf_wl_surface.h', + '../../include/wlf/wayland/wlf_wl_touch.h', + '../../include/wlf/wayland/wlf_wp_alpha_modifier_v1.h', + '../../include/wlf/wayland/wlf_wp_content_type_v1.h', + '../../include/wlf/wayland/wlf_wp_fractional_scale_v1.h', + '../../include/wlf/wayland/wlf_wp_viewporter.h', + '../../include/wlf/wayland/wlf_xdg_wm_base.h', + '../../include/wlf/wayland/wlf_xdg_wm_dialog_v1.h', + '../../include/wlf/wayland/wlf_zwlr_layer_shell_v1.h', + '../../include/wlf/wayland/wlf_zxdg_decoration_v1.h', + + '../../include/wlf/window/wayland/wlr_layer_window.h', + '../../include/wlf/window/wayland/xdg_dialog_window.h', + '../../include/wlf/window/wayland/xdg_popup_window.h', + '../../include/wlf/window/wayland/xdg_toplevel_window.h', + ]) +elif is_macos + src_files += files([ + '../../include/wlf/platform/macos/backend.h', + '../../include/wlf/platform/macos/fontconfig.h', + '../../include/wlf/platform/macos/theme.h', + + '../../include/wlf/renderer/metal/device.h', + '../../include/wlf/renderer/metal/renderer.h', + ]) +elif is_windows + src_files += files([ + '../../include/wlf/platform/windows/backend.h', + '../../include/wlf/platform/windows/fontconfig.h', + '../../include/wlf/platform/windows/theme.h', + + '../../include/wlf/renderer/directx12/renderer.h', ]) endif From 098a119846694619ed1151ade84f28c89be8f539 Mon Sep 17 00:00:00 2001 From: YaoBing Xiao Date: Sat, 3 Oct 2026 16:48:05 +0800 Subject: [PATCH 2/2] docs: fix Doxygen warnings Correct file names and parameter documentation in public headers. Escape SVG element names, remove an invalid animation reference, and drop the obsolete DOT_MULTI_TARGETS option. --- docs/doxygen/wlframe.doxygen.in | 1 - include/wlf/allocator/shm/allocator.h | 2 +- include/wlf/allocator/wlf_allocator.h | 1 + include/wlf/animation/wlf_animation_group.h | 2 +- include/wlf/buffer/shm/buffer.h | 2 +- include/wlf/shapes/wlf_text_shape.h | 3 ++- include/wlf/svg/wlf_svg.h | 4 ++-- include/wlf/swapchain/wlf_swapchain.h | 4 +--- include/wlf/wayland/wlf_wp_content_type_v1.h | 2 +- include/wlf/wayland/wlf_zxdg_decoration_v1.h | 2 +- 10 files changed, 11 insertions(+), 12 deletions(-) diff --git a/docs/doxygen/wlframe.doxygen.in b/docs/doxygen/wlframe.doxygen.in index 3da498c9..32aeea0f 100644 --- a/docs/doxygen/wlframe.doxygen.in +++ b/docs/doxygen/wlframe.doxygen.in @@ -12,7 +12,6 @@ PREDEFINED = WL_EXPORT= \ WL_PRINTF(x,y)= MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES -DOT_MULTI_TARGETS = YES ALIASES += comment{1}="/* \1 */" OPTIMIZE_OUTPUT_FOR_C = YES EXTRACT_ALL = YES diff --git a/include/wlf/allocator/shm/allocator.h b/include/wlf/allocator/shm/allocator.h index 1d6d5177..ce8afdf8 100644 --- a/include/wlf/allocator/shm/allocator.h +++ b/include/wlf/allocator/shm/allocator.h @@ -1,5 +1,5 @@ /** - * @file wlf_shm_allocator.h + * @file allocator.h * @brief Shared memory buffer allocator. * @details This file provides a buffer allocator implementation using Wayland shared memory * (wl_shm). The allocator creates CPU-accessible wl_buffer objects suitable for diff --git a/include/wlf/allocator/wlf_allocator.h b/include/wlf/allocator/wlf_allocator.h index 2e4314dd..ba08def7 100644 --- a/include/wlf/allocator/wlf_allocator.h +++ b/include/wlf/allocator/wlf_allocator.h @@ -79,6 +79,7 @@ void wlf_allocator_destroy(struct wlf_allocator *allocator); * @param allocator Allocator used to create buffer. * @param width Buffer width in pixels. * @param height Buffer height in pixels. + * @param format Format and attributes for the buffer. * @return Newly created buffer, or NULL on failure. */ struct wlf_buffer *wlf_allocator_create_buffer(struct wlf_allocator *allocator, diff --git a/include/wlf/animation/wlf_animation_group.h b/include/wlf/animation/wlf_animation_group.h index 5a229cb0..5b0d37ae 100644 --- a/include/wlf/animation/wlf_animation_group.h +++ b/include/wlf/animation/wlf_animation_group.h @@ -87,7 +87,7 @@ struct wlf_animation_group_listener { /** * @brief Base object embedded in every animation group type. * - * The group owns every animation in @ref children. + * The group owns every animation in its child list. */ struct wlf_animation_group { const struct wlf_animation_group_impl *impl; /**< Concrete implementation. */ diff --git a/include/wlf/buffer/shm/buffer.h b/include/wlf/buffer/shm/buffer.h index 8af08ece..2e807133 100644 --- a/include/wlf/buffer/shm/buffer.h +++ b/include/wlf/buffer/shm/buffer.h @@ -1,5 +1,5 @@ /** - * @file wlf_shm_buffer.h + * @file buffer.h * @brief Shared memory buffer implementation. * @details This file provides a buffer implementation backed by POSIX shared memory. * SHM buffers use memory-mapped files for CPU-accessible buffer storage diff --git a/include/wlf/shapes/wlf_text_shape.h b/include/wlf/shapes/wlf_text_shape.h index c144b726..5d3dfe27 100644 --- a/include/wlf/shapes/wlf_text_shape.h +++ b/include/wlf/shapes/wlf_text_shape.h @@ -1,7 +1,8 @@ /** * @file wlf_text_shape.h * @brief Text shape type for wlframe. - * @details Defines text geometry and typography attributes inspired by SVG . + * @details Defines text geometry and typography attributes inspired by SVG + * <text> elements. * @author YaoBing Xiao * @date 2026-04-08 * @version v1.0 diff --git a/include/wlf/svg/wlf_svg.h b/include/wlf/svg/wlf_svg.h index fb81149f..6779851d 100644 --- a/include/wlf/svg/wlf_svg.h +++ b/include/wlf/svg/wlf_svg.h @@ -237,8 +237,8 @@ struct wlf_svg_image { char view_box[128]; /**< Raw viewBox attribute text from root element. */ char preserve_aspect_ratio[64];/**< Raw preserveAspectRatio text from root element. */ struct wlf_shape *shapes; /**< Linked list of shapes parsed from the SVG. */ - struct wlf_svg_symbol_data *symbols; /**< Parsed definitions. */ - struct wlf_svg_use_data *uses; /**< Parsed elements. */ + struct wlf_svg_symbol_data *symbols; /**< Parsed <symbol> definitions. */ + struct wlf_svg_use_data *uses; /**< Parsed <use> elements. */ struct wlf_filter *filters; /**< Owned linked list of parsed filter definitions. */ }; diff --git a/include/wlf/swapchain/wlf_swapchain.h b/include/wlf/swapchain/wlf_swapchain.h index 6551cd9b..97e2dfcb 100644 --- a/include/wlf/swapchain/wlf_swapchain.h +++ b/include/wlf/swapchain/wlf_swapchain.h @@ -93,12 +93,10 @@ struct wlf_swapchain { * the common swapchain fields. * * @param swapchain Swapchain to initialize. + * @param allocator Allocator to use for creating buffers. * @param impl Implementation methods for this swapchain. - * @param alloc Allocator to use for creating buffers. * @param width Width of buffers in pixels. * @param height Height of buffers in pixels. - * @param format Format and attributes for the buffers. - * @param slot_count Number of buffer slots (typically 2-4 depending on backend capabilities). */ void wlf_swapchain_init(struct wlf_swapchain *swapchain, struct wlf_allocator *allocator, const struct wlf_swapchain_impl *impl, int width, int height); diff --git a/include/wlf/wayland/wlf_wp_content_type_v1.h b/include/wlf/wayland/wlf_wp_content_type_v1.h index 8bb31afa..f767d183 100644 --- a/include/wlf/wayland/wlf_wp_content_type_v1.h +++ b/include/wlf/wayland/wlf_wp_content_type_v1.h @@ -1,5 +1,5 @@ /** - * @file wlf_wp_content_type_manager_v1.h + * @file wlf_wp_content_type_v1.h * @brief Wayland wp_content_type_manager_v1 protocol wrapper for wlframe. * @details Implements the staging wp_content_type_v1 protocol, which lets a * client hint to the compositor what kind of content a surface diff --git a/include/wlf/wayland/wlf_zxdg_decoration_v1.h b/include/wlf/wayland/wlf_zxdg_decoration_v1.h index 23c0ccf3..b1888032 100644 --- a/include/wlf/wayland/wlf_zxdg_decoration_v1.h +++ b/include/wlf/wayland/wlf_zxdg_decoration_v1.h @@ -1,5 +1,5 @@ /** - * @file wlf_zxdg_decoration_manager_v1.h + * @file wlf_zxdg_decoration_v1.h * @brief Wayland zxdg_decoration_manager_v1 protocol wrapper for wlframe. * @details Implements the xdg-decoration-unstable-v1 protocol, which allows * a compositor to offer server-side window decorations (title bar,