After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 706487 - doc: Updates and fixes
doc: Updates and fixes
Status: RESOLVED FIXED
Product: grilo
Classification: Other
Component: core
unspecified
Other All
: Normal normal
: ---
Assigned To: grilo-maint
grilo-maint
Depends on:
Blocks:
 
 
Reported: 2013-08-21 11:47 UTC by Emanuele Aina
Modified: 2013-08-23 22:52 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
doc: Updates and fixes (21.38 KB, patch)
2013-08-21 11:47 UTC, Emanuele Aina
committed Details | Review

Description Emanuele Aina 2013-08-21 11:47:52 UTC
• Ignore all the *-priv.h headers
• Update grilo-sections.txt with new symbols
• Fix referecens to old GrlMediaSource and GrlMetadataSource to point to
  GrlSource
• Standardize element-type annotation to use the C symbol names
• Misc cleanups to fix gtk-doc warnings

GISCAN still complains about the following annotations, I'm not sure if
they're worth fixing or they should be simply excluded:

grl-value-helper.h:38: Warning: Grl: grl_g_value_hashtable_new: return value: Missing (transfer) annotation
grl-value-helper.h:40: Warning: Grl: grl_g_value_hashtable_new_direct: return value: Missing (transfer) annotation
grl-range-value.h:44: Warning: Grl: grl_range_value_hashtable_new: return value: Missing (transfer) annotation
grl-operation-priv.h:39: Warning: Grl: grl_operation_get_private_data: return value: Missing (transfer) annotation
grl-range-value.h:44: Warning: Grl: grl_range_value_hashtable_new: return value: Missing (transfer) annotation
grl-plugin-priv.h:51: Warning: Grl: grl_plugin_load: argument configurations: Missing (element-type) annotation

The doc/grilo/grilo-unused.txt file still list 19 symbols not included
in the documentation, again I'm not sure if they should be moved to
*-priv.h headers or are meant for public consumption:

GRL_CAPS_TYPE
GRL_COUNT_INFINITY
GRL_LOG_valist
GRL_OPERATION_OPTIONS_TYPE
GrlRangeValue
GrlRank
g_value_get_grl_key_id
g_value_set_grl_key_id
grl_g_value_dup
grl_g_value_free
grl_g_value_hashtable_new
grl_g_value_hashtable_new_direct
grl_g_value_new
grl_range_value_dup
grl_range_value_free
grl_range_value_get_type
grl_range_value_hashtable_insert
grl_range_value_hashtable_new
grl_range_value_new
Comment 1 Emanuele Aina 2013-08-21 11:47:55 UTC
Created attachment 252537 [details] [review]
doc: Updates and fixes

• Ignore all the *-priv.h headers
• Update grilo-sections.txt with new symbols
• Fix referecens to old GrlMediaSource and GrlMetadataSource to point to
  GrlSource
• Standardize element-type annotation to use the C symbol names
• Misc cleanups to fix gtk-doc warnings
Comment 2 Juan A. Suarez Romero 2013-08-23 22:52:06 UTC
Attachment 252537 [details] pushed as 18da634 - doc: Updates and fixes

commit 18da634b72c5670fb96bbbc4af70a868adb040a2
Author: Emanuele Aina <emanuele.aina@collabora.com>
Date:   Wed Aug 21 13:37:33 2013 +0200

    doc: Updates and fixes
    
    - Ignore all the *-priv.h headers
    - Update grilo-sections.txt with new symbols
    - Fix referecens to old GrlMediaSource and GrlMetadataSource to point to
      GrlSource
    - Standardize element-type annotation to use the C symbol names
    - Misc cleanups to fix gtk-doc warnings
    
    https://bugzilla.gnome.org/show_bug.cgi?id=706487

 doc/grilo/Makefile.am         | 11 ++++++++---
 doc/grilo/grilo-sections.txt  | 22 ++++++++++++++++++++--
 doc/grilo/plugins-sources.xml | 15 ++++++++-------
 libs/net/grl-net-wc.c         |  5 +++--
 src/data/grl-data.c           |  4 ++--
 src/grl-caps.c                |  2 +-
 src/grl-caps.h                |  6 ++++++
 src/grl-multiple.c            |  6 +++---
 src/grl-operation-options.c   | 16 +++++++++-------
 src/grl-operation-options.h   |  6 ++++++
 src/grl-plugin.c              |  9 ++++-----
 src/grl-registry.c            |  8 +++++---
 src/grl-source.c              | 17 ++++++++---------
 src/grl-source.h              |  2 +-
 14 files changed, 84 insertions(+), 45 deletions(-)