Re: Feedback on building gtkdoc

On Wed, Oct 27, 2004 at 06:56:37PM +0200, Michèle Garoche wrote:
> Docs improved :-) : 59% symbol docs coverage (869 symbols documented, 
> 610 not documented)

Let me start to admit a mistake.

I was wrong when I though that gtkdocoverrides, gtkdocsections
and gtkdoctyps could be generated automatically.

Sorry.
Especial sorry to Robert Varga.

My apology for being optimistic.


> With the latest fo-dropped patch, there are now:
> 
> 1 -  only those warnings for unknown declarations :
> 
> WARNING: No declaration for: cong_attribute_editor_get_attribute
> WARNING: No declaration for: cong_attribute_wrapper_get_attribute
> WARNING: No declaration for: cong_document_get_root
> WARNING: No declaration for: cong_document_get_dispspec
> WARNING: No declaration for: cong_document_paste_clipboard_or_selection
> WARNING: No declaration for: cong_editor_widget3_get_dispspec
> WARNING: No declaration for: cong_eel_option_menu_get_selected_menu_item
Once we had "eel" code, but it got dropped.
And now you found it in the gtkdoc stuff, sorry again.


> WARNING: No declaration for: 
> cong_menu_item_attach_callback_Document_Node_ParentWindow
> WARNING: No declaration for: 
> cong_menu_item_attach_callback_Document_DispspecElement_Node
> WARNING: No declaration for: 
> cong_util_make_menu_item_for_dispspec_element
> WARNING: No declaration for: cong_util_make_menu_item_for_element_desc
> WARNING: No declaration for: cong_view_get_dispspec
> 
> 2 - This one for unused declarations
> 
> WARNING: 199 unused declarations.
>   These can be found in conglomerate-unused.txt.
> 
> 3 -  And those ones for missing parameter description
> 
> WARNING: Parameter description missing in source code comment block -
>          Func: cong_editor_widget3_construct Param: primary_window.
> WARNING: Parameter description missing in source code comment block -
>          Func: cong_editor_widget3_new Param: primary_window.
IIRC, widget3 was some kind of test. (an old expriment)

> WARNING: Parameter description missing in source code comment block -
>          Func: cong_overview_view_new Param: primary_window.
> WARNING: Parameter description missing in source code comment block -
>          Func: cong_ui_transform_doc_to_uri Param: uri.
> WARNING: Parameter described in source code comment block but does not 
> exist -
>          Func: cong_ui_transform_doc_to_uri Param: string_uri.
> WARNING: Parameter description missing in source code comment block -
>          Func: cong_tree_view_new Param: primary_window.
> WARNING: Parameter description missing in source code comment block -
>          Func: cong_menus_create_items Param: Returns.
> WARNING: Parameter description missing in source code comment block -
>          Func: cong_ui_hook_tree_new_sibling Param: element_desc.
> WARNING: Parameter described in source code comment block but does not 
> exist -
>          Func: cong_ui_hook_tree_new_sibling Param: ds_element.
> WARNING: Parameter description missing in source code comment block -
>          Func: cong_ui_hook_tree_new_sub_element Param: element_desc.
> WARNING: Parameter described in source code comment block but does not 
> exist -
>          Func: cong_ui_hook_tree_new_sub_element Param: ds_element.
Can probably be fixed with:

--- src/tree.c  14 Aug 2004 04:10:46 -0000      1.60
+++ src/tree.c  27 Oct 2004 20:47:38 -0000
@@ -148,13 +148,13 @@

 }

 /**
  * cong_ui_hook_tree_new_sub_element:
  * @doc:
- * @ds_element:
+ * @element_desc:
  *
  * TODO: Write me
  */
 void
 cong_ui_hook_tree_new_sub_element (CongDocument *doc,
                                   CongElementDescription *element_desc)


( element_desc seems to be the name of the second parameter of the
function that is reported about.)


> WARNING: Parameter description missing in source code comment block -
>          Func: cong_ui_popup_init Param: primary_window.
> WARNING: Parameter description missing in source code comment block -
>          Func: cong_dom_view_new Param: primary_window.
> 
> Michèle
> <http://micmacfr.homeunix.org>

Geert Stappers

_______________________________________________
Conglomerate-devel mailing list
[email protected]
http://lists.copyleft.no/mailman/listinfo/conglomerate-devel

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (GNU/Linux)

iD8DBQFBgAw0OSINbgwa/7sRAkV2AKC5cQUEHTu9jexgBi70Twgvw4jqvwCgrPh2
y6F+UnjfQ7VTcP/N+TrB3ZA=
=oX3I
-----END PGP SIGNATURE-----