GNOME Bugzilla – Bug 313888
undocumented symbols exported by libgnome
Last modified: 2009-05-04 07:47:28 UTC
The libgnome library exports the following symbols, but these do not have gtk-docs. Some of them (probably all that end with "_") should probably not be exported. Should probably be using LIBTOOL_EXPORT_OPTIONS in configure.in to remove symbols not intended for export from the symbol list. The functions that end with "_" probably should be changed to start with "_" instead since this is the convention for functions in other GNOME modules (glib/GTK+/etc.) gnome_config_clean_file_ gnome_config_clean_key_ gnome_config_clean_section_ gnome_config_drop_file_ gnome_config_get_bool_with_default_ gnome_config_get_float_with_default_ gnome_config_get_int_with_default_ gnome_config_get_string_with_default_ gnome_config_get_translated_string_with_default_ gnome_config_get_vector_with_default_ gnome_config_has_section_ gnome_config_init_iterator_ gnome_config_init_iterator_sections_ gnome_config_set_bool_ gnome_config_set_float_ gnome_config_set_int_ gnome_config_set_set_handler gnome_config_set_string_ gnome_config_set_sync_handler gnome_config_set_translated_string_ gnome_config_set_vector_ gnome_config_sync_file_ gnome_file_domain_get_type gnome_help_error_get_type gnome_help_error_quark (not well documented) gnome_module_info_get_type gnome_program_get_type gnome_program_init_paramv gnome_trigger_type_get_type gnome_url_error_get_type gnome_url_error_quark (not well documented) Note that the *_get_type functions probably don't need to be documented since they are not documented for the rest of the GNOME Platform libraries. The following functions have been added to libgnome, but do not contain "Since:" tags to highlight what version they were added in, this should be fixed: 2.1.1 gnome_help_display_desktop_with_env 2.1.1 gnome_help_display_uri_with_env 2.1.1 gnome_help_display_with_doc_id_and_env 2.7.2 gnome_program_init_paramv 2.1.1 gnome_url_show_with_env I've highlighted the version numbers for new symbols. Note that it's normal to say "Since: 2.2" when it was changed in an unstable release like 2.1.1.
*** Bug 313889 has been marked as a duplicate of this bug. ***
Added the listed Since: entries. There are lots more missing though.
Not too many. I suspect the functions ending in "_" are private functions. So there are really only 10 undocumented functions left. Of these 6 are get_type functions and probably do not need docs. So only 4 functions to deal with, I think. Might be better to rename the private functions with the underscore at the beginning and use the LIBTOOL_EXPORT_OPTIONS='-export-symbols-regex "^[[^_]].*"' configure mechanism to strip them out so they are not exported. That would be cleaner.
Closing now that libgnome is heavily deprecated.