GNOME Bugzilla – Bug 138197
doc won't build against gtk-doc 1.2
Last modified: 2005-05-13 08:38:27 UTC
compiling 1.0.3 when gtk-doc 1.2 is installed (worked with 1.1 but 1.2 is more strict) gtkdoc-scan --module=libgnomedb --source-dir=../../libgnomedb --ignore-headers="config.h acconfig.h gnome-db-intl.h" touch scan-build.stamp *** Rebuilding template files *** cd . && gtkdoc-mktmpl --module=libgnomedb ============================================================================= WARNING: 50 unused declarations. These can be found in libgnomedb-unused.txt. They should be added to libgnomedb-sections.txt in the appropriate place. ============================================================================= touch tmpl-build.stamp *** Building SGML *** cd . && \ gtkdoc-mkdb --module=libgnomedb --source-dir=../../libgnomedb --main-sgml-file=libgnomedb-docs.sgml ERROR parsing comment block file : parameter expected - ../../libgnomedb/gnome-db-error-dialog.c:182 WARNING: Parameter description missing in source code comment block - Func: gnome_db_combo_set_model Param: pos. WARNING: Parameter described in source code comment block but does not exist - Func: gnome_db_combo_set_model Param: col. WARNING: Parameter description missing in source code comment block - Func: gnome_db_connection_properties_get_connection Param: props. WARNING: Parameter description missing in source code comment block - Func: gnome_db_connection_properties_get_connection Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_connection_properties_new Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_connection_properties_set_connection Param: props. WARNING: Parameter description missing in source code comment block - Func: gnome_db_connection_properties_set_connection Param: cnc. WARNING: Parameter description missing in source code comment block - Func: gnome_db_control_widget_get_objref Param: wid. WARNING: Parameter description missing in source code comment block - Func: gnome_db_control_widget_get_objref Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_control_widget_new_from_corba Param: control. WARNING: Parameter description missing in source code comment block - Func: gnome_db_control_widget_new_from_corba Param: uic. WARNING: Parameter description missing in source code comment block - Func: gnome_db_control_widget_new_from_corba Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_control_widget_construct Param: wid. WARNING: Parameter description missing in source code comment block - Func: gnome_db_control_widget_construct Param: id. WARNING: Parameter description missing in source code comment block - Func: gnome_db_control_widget_construct Param: uic. WARNING: Parameter description missing in source code comment block - Func: gnome_db_control_widget_construct Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_control_widget_get_ui_container Param: wid. WARNING: Parameter description missing in source code comment block - Func: gnome_db_control_widget_get_ui_container Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_control_construct Param: control. WARNING: Parameter description missing in source code comment block - Func: gnome_db_control_construct Param: widget. WARNING: Parameter description missing in source code comment block - Func: gnome_db_control_construct Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_dsn_config_druid_new Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_dsn_config_druid_get_dsn Param: druid. WARNING: Parameter description missing in source code comment block - Func: gnome_db_dsn_config_druid_get_dsn Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_dsn_config_get_info Param: config. WARNING: Parameter description missing in source code comment block - Func: gnome_db_dsn_config_get_info Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_dsn_config_new Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_dsn_config_set_info Param: config. WARNING: Parameter description missing in source code comment block - Func: gnome_db_dsn_config_set_info Param: dsn_info. WARNING: Parameter description missing in source code comment block - Func: gnome_db_error_dialog_new Param: title. WARNING: Parameter description missing in source code comment block - Func: gnome_db_error_show Param: errors. WARNING: Parameter description missing in source code comment block - Func: gnome_db_error_clear Param: error_widget. WARNING: Parameter description missing in source code comment block - Func: gnome_db_form_get_model Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_form_set_form_type Param: form. WARNING: Parameter description missing in source code comment block - Func: gnome_db_form_set_form_type Param: type. WARNING: Parameter description missing in source code comment block - Func: gnome_db_form_get_form_type Param: form. WARNING: Parameter description missing in source code comment block - Func: gnome_db_form_get_form_type Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_grid_hide_column_titles Param: grid. WARNING: Parameter description missing in source code comment block - Func: gnome_db_grid_unselect_all Param: grid. WARNING: Parameter description missing in source code comment block - Func: gnome_db_grid_show_column_titles Param: grid. WARNING: Parameter description missing in source code comment block - Func: gnome_db_grid_get_model Param: grid. WARNING: Parameter description missing in source code comment block - Func: gnome_db_grid_get_model Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_grid_select_all Param: grid. WARNING: Parameter description missing in source code comment block - Func: gnome_db_grid_set_model Param: grid. WARNING: Parameter description missing in source code comment block - Func: gnome_db_grid_set_model Param: model. WARNING: Parameter description missing in source code comment block - Func: gnome_db_grid_new_with_model Param: model. WARNING: Parameter description missing in source code comment block - Func: gnome_db_grid_new_with_model Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_grid_get_selection_mode Param: grid. WARNING: Parameter description missing in source code comment block - Func: gnome_db_grid_get_selection_mode Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_grid_new Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_list_new_with_model Param: model. WARNING: Parameter description missing in source code comment block - Func: gnome_db_list_new_with_model Param: col. WARNING: Parameter description missing in source code comment block - Func: gnome_db_list_new_with_model Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_list_get_model Param: list. WARNING: Parameter description missing in source code comment block - Func: gnome_db_list_get_model Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_dialog_run Param: dialog. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_dialog_run Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_dialog_get_dsn Param: dialog. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_dialog_get_dsn Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_dialog_new Param: title. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_dialog_new Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_dialog_get_username Param: dialog. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_dialog_get_username Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_dialog_get_password Param: dialog. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_dialog_get_password Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_get_dsn Param: login. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_get_dsn Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_new Param: dsn. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_new Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_get_password Param: login. WARNING: Parameter description missing in source code comment block - Func: gnome_db_login_get_password Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_window_set_status Param: window. WARNING: Parameter description missing in source code comment block - Func: gnome_db_window_set_status Param: status. WARNING: Parameter description missing in source code comment block - Func: gnome_db_window_get_ui_component Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_window_get_contents Param: window. WARNING: Parameter description missing in source code comment block - Func: gnome_db_window_get_contents Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_window_set_contents Param: window. WARNING: Parameter description missing in source code comment block - Func: gnome_db_window_set_contents Param: contents. WARNING: Parameter description missing in source code comment block - Func: gnome_db_window_get_ui_container Param: window. WARNING: Parameter description missing in source code comment block - Func: gnome_db_window_get_ui_container Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_window_close Param: window. WARNING: Parameter description missing in source code comment block - Func: gnome_db_window_new Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_window_show Param: window. WARNING: Parameter description missing in source code comment block - Func: gnome_db_gray_bar_set_text Param: text. WARNING: Parameter description missing in source code comment block - Func: gnome_db_gray_bar_new Param: text. WARNING: Parameter description missing in source code comment block - Func: gnome_db_gray_bar_new Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_config_free_component_list Param: list. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_entry_widget Param: max_length. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_entry_widget Param: editable. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_entry_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_vseparator_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_select_file_dialog Param: parent. WARNING: Parameter description missing in source code comment block - Func: gnome_db_select_file_dialog Param: title. WARNING: Parameter description missing in source code comment block - Func: gnome_db_select_file_dialog Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_cut_clipboard Param: text. WARNING: Parameter description missing in source code comment block - Func: gnome_db_show_error Param: format. WARNING: Parameter description missing in source code comment block - Func: gnome_db_show_error Param: Varargs. WARNING: Parameter description missing in source code comment block - Func: gnome_db_set_widget_bg_color Param: widget. WARNING: Parameter description missing in source code comment block - Func: gnome_db_set_widget_bg_color Param: color. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_label_widget Param: text. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_label_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_hseparator_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_set_widget_fg_color Param: widget. WARNING: Parameter description missing in source code comment block - Func: gnome_db_set_widget_fg_color Param: color. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_paste_clipboard Param: text. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_insert_at_cursor Param: text. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_insert_at_cursor Param: contents. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_insert_at_cursor Param: len. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_hpaned_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_hbox_widget Param: homogenous. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_hbox_widget Param: spacing. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_hbox_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_button_widget Param: label. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_button_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_option_menu_get_selection Param: option_menu. WARNING: Parameter description missing in source code comment block - Func: gnome_db_option_menu_get_selection Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_copy_clipboard Param: text. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_scrolled_window_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_grid_widget Param: model. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_grid_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_yes_no_dialog Param: parent. WARNING: Parameter description missing in source code comment block - Func: gnome_db_yes_no_dialog Param: format. WARNING: Parameter description missing in source code comment block - Func: gnome_db_yes_no_dialog Param: Varargs. WARNING: Parameter description missing in source code comment block - Func: gnome_db_yes_no_dialog Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_option_menu_add_item Param: option_menu. WARNING: Parameter description missing in source code comment block - Func: gnome_db_option_menu_add_item Param: label. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_toolbar_widget Param: orientation. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_toolbar_widget Param: style. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_toolbar_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_table_widget Param: rows. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_table_widget Param: cols. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_table_widget Param: homogenous. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_table_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_notebook_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_show_message Param: Varargs. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_get_text Param: text. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_get_text Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_get_char_count Param: text. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_get_char_count Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_vpaned_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_option_menu_set_selection Param: option_menu. WARNING: Parameter description missing in source code comment block - Func: gnome_db_option_menu_set_selection Param: selection. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_get_line_count Param: text. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_get_line_count Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_popup_menu Param: parent. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_popup_menu Param: ui_info. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_popup_menu Param: user_data. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_popup_menu Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_tree_view_widget Param: model. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_tree_view_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_status_bar_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_radio_button_widget Param: group. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_radio_button_widget Param: label. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_radio_button_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_hbutton_box_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_combo_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_set_text Param: text. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_set_text Param: contents. WARNING: Parameter description missing in source code comment block - Func: gnome_db_text_set_text Param: len. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_option_menu_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_text_widget Param: contents. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_text_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_vbox_widget Param: homogenous. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_vbox_widget Param: spacing. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_vbox_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_frame_widget Param: title. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_frame_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_button_widget_from_stock Param: stock_id. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_button_widget_from_stock Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_file_entry_widget Param: history_id. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_file_entry_widget Param: title. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_file_entry_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_check_button_widget Param: label. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_check_button_widget Param: Returns. WARNING: Parameter description missing in source code comment block - Func: gnome_db_new_browser_widget Param: Returns. 38% symbol docs coverage (108 symbols documented, 177 not documented) See libgnomedb-undocumented.txt for a list of missing docs. The doc coverage percentage doesn't include intro sections. touch sgml-build.stamp *** Building HTML *** test -d ./html || mkdir ./html cd ./html && gtkdoc-mkhtml libgnomedb ../libgnomedb-docs.sgml /usr/bin/openjade:../libgnomedb-docs.sgml:148:2:E: cannot find "fdl-appendix.sgml"; tried "../fdl-appendix.sgml", "/usr/share/sgml/fdl-appendix.sgml" /usr/bin/openjade:/usr/share/sgml/docbook/dsssl-stylesheets-1.77/html/dblink.dsl:203:1:E: XRef LinkEnd to missing ID 'FDL' make[2]: *** [html-build.stamp] Erreur 1 make[2]: Leaving directory `/usr/portage/tmp/portage/libgnomedb-1.0.3/work/libgnomedb-1.0.3/doc/C' make[1]: *** [all-recursive] Erreur 1 make[1]: Leaving directory `/usr/portage/tmp/portage/libgnomedb-1.0.3/work/libgnomedb-1.0.3/doc' make: *** [all-recursive] Erreur 1
libgnomedb-1.1.1 refuses to build with the same error not only warnings but errors also : *** Building SGML *** cd . && \ gtkdoc-mkdb --module=libgnomedb --source-dir=../../libgnomedb --main-sgml-file=libgnomedb-docs.sgml ERROR parsing comment block file : parameter expected - ../../libgnomedb/gnome-db-error-dialog.c:182 ERROR parsing comment block file : parameter expected - ../../libgnomedb/gnome-db-grid.c:792 ERROR parsing comment block file : parameter expected - ../../libgnomedb/gnome-db-grid.c:793 ERROR parsing comment block file : parameter expected - ../../libgnomedb/gnome-db-grid.c:794 ERROR parsing comment block file : parameter expected - ../../libgnomedb/gnome-db-grid.c:816 ERROR parsing comment block file : parameter expected - ../../libgnomedb/gnome-db-grid.c:817 the same error than with 1.0.3 (gnome-db-error-dialog.c) but 4 new ones (gnome-db-grid.c)
some '@' and ':' missing is the reason of those 'ERROR' lines : gnome-db-error-dialog.c:182 : (both 1.0.3 and 1.1.1) - * title: title of the dialog box + * @title: title of the dialog box gnome-db-grid.c:792-794 : (1.1.1 only) - * @grid a #GnomeDbGrid widget - * @col the number of the column to change the title - * @title the new title for this column + * @grid: a #GnomeDbGrid widget + * @col: the number of the column to change the title + * @title: the new title for this column gnome-db-grid.c:816-817 (1.1.1 only) - * @grid a #GnomeDbGrid widget - * @col the number of the column to get the title + * @grid: a #GnomeDbGrid widget + * @col: the number of the column to get the title even with those fixed, i still breaks. but at least, those errors would be no more
Created attachment 26223 [details] [review] patch for 1.0.3 that make this ERROR line die also applies to 1.1.1
Created attachment 26238 [details] [review] libgnomedb-HEAD-fdl.patch The initial problem is related to fdl-appendix.sgml not showing up in the tarball. This simple patch corrects that.
All patches applied. We're missing though the first patch for 1.0.3 :-)