GNOME Bugzilla – Bug 111795
libart gtk-docs badly broken
Last modified: 2011-08-25 04:55:51 UTC
for accessability reasons; see bug 103595. Actually, the api docs don't seem to be in CVS at all, although there is a formatted version on developer.gnome.org.
Changed the synopsis from "The libart api docs should use --output-format=xml" which is true, but it seems that the fact that they are missing altogether is far more serious. Reviewing the symbols exported by libart-lgpl, I notice that only the ones marked with "*" are included in the gtk-docs provided here: http://www.gnome.org/~mathieu/libart/libart.html In other words, only 39 of the 109 functions exported have docs. I notice looking at the code that many functions have gtk-doc style comments, so this could probably be corrected if the gtk-docs were building. Considering libart is a part of the GNOME Platform, it really should include reasonable interface documentation. Bumping up the priority one notch since this really should get fixed. Global Data defined (11): (libart_lgpl_2.so.2.3.17) art_render_clear_16_obj art_render_clear_8_obj art_render_clear_rgb8_obj art_render_composite_8_obj art_render_composite_8_opt1_obj art_render_composite_8_opt2_obj art_render_composite_obj libart_major_version libart_micro_version libart_minor_version libart_version Functions defined (109): (libart_lgpl_2.so.2.3.17) art_affine_equal * art_affine_expansion * art_affine_flip * art_affine_identity * art_affine_invert * art_affine_multiply * art_affine_point * art_affine_rectilinear * art_affine_rotate * art_affine_scale * art_affine_shear * art_affine_to_string * art_affine_translate * art_alphagamma_free * art_alphagamma_new * art_bez_path_to_vec * art_bezier_to_vec art_bpath_affine_transform * art_die art_dprint art_drect_affine_transform art_drect_copy art_drect_empty art_drect_intersect art_drect_svp art_drect_svp_union art_drect_to_irect art_drect_union art_gray_svp_aa * art_irect_copy art_irect_empty art_irect_intersect art_irect_union art_pixbuf_duplicate art_pixbuf_free art_pixbuf_free_shallow art_pixbuf_new_const_rgb art_pixbuf_new_const_rgba art_pixbuf_new_rgb art_pixbuf_new_rgb_dnotify art_pixbuf_new_rgba art_pixbuf_new_rgba_dnotify art_rect_list_from_uta art_render_add_image_source art_render_add_mask_source art_render_clear art_render_clear_rgb art_render_gradient_linear art_render_gradient_radial art_render_image_solid art_render_invoke art_render_invoke_callbacks art_render_mask art_render_mask_solid art_render_new art_render_svp art_rgb_a_affine art_rgb_affine art_rgb_affine_run art_rgb_bitmap_affine art_rgb_fill_run * art_rgb_pixbuf_affine art_rgb_rgba_affine art_rgb_run_alpha * art_rgb_svp_aa * art_rgb_svp_alpha * art_rgba_fill_run art_rgba_rgba_composite art_rgba_run_alpha art_svp_add_segment art_svp_diff * art_svp_free art_svp_from_vpath * art_svp_intersect * art_svp_intersector art_svp_minus art_svp_point_dist art_svp_point_wind art_svp_render_aa * art_svp_render_aa_iter art_svp_render_aa_iter_done art_svp_render_aa_iter_step art_svp_rewind_uncrossed art_svp_seg_compare art_svp_uncross art_svp_union * art_svp_vpath_stroke * art_svp_vpath_stroke_raw art_svp_writer_rewind_new art_svp_writer_rewind_reap art_uta_add_line art_uta_free art_uta_from_irect art_uta_from_svp art_uta_from_vpath art_uta_new art_uta_new_coords art_uta_union art_vpath_add_point * art_vpath_affine_transform * art_vpath_bbox_drect art_vpath_bbox_irect art_vpath_dash * art_vpath_from_svp * art_vpath_new_circle * art_vpath_perturb * art_warn libart_postinit libart_preinit Also, I notice that a new function art_svp_minus was added for version 2.3.13. I notice this function does not have gtk-docs. When added, the gtk-doc comments for this functions should include a "Since:" value to highlight when this was added. We can probably get rid of the #define ART_USE_NEW_INTERSECTOR since it's always set to true.
libart development has been stalled and it has been unmaintained now. Maintainers don't have future development plan so i am closing all the bugs as WONTFIX. Please feel free to reopen the bugs in future if anyone takes the responsibility for active development.