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 681063 - Please add the Rygel API reference
Please add the Rygel API reference
Status: RESOLVED FIXED
Product: website
Classification: Infrastructure
Component: developer.gnome.org
current
Other Linux
: Normal normal
: ---
Assigned To: GNOME Web maintainers
GNOME Web maintainers
Depends on:
Blocks:
 
 
Reported: 2012-08-02 10:53 UTC by Murray Cumming
Modified: 2014-01-26 22:58 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
0001-Add-librygel-renderer-gst.patch (1.11 KB, patch)
2012-11-29 12:11 UTC, Murray Cumming
committed Details | Review

Description Murray Cumming 2012-08-02 10:53:38 UTC
As of rygel-0.15.1, 
  http://ftp.acc.umu.se/pub/GNOME/sources/rygel/0.15/rygel-0.15.1.tar.xz
Rygel now provides some shared libraries, with gtk-doc documentation: librygel-core, librygel-server and librygel-render

Could these please be added to developer.gnome.org/library.gnome.org ?

I suggest that they be listed under Multimedia here:
http://developer.gnome.org/references
Comment 1 Frederic Peters 2012-08-02 11:21:22 UTC
I looked at this briefly, the autotools usage looks a bit unusual, it will need some patches to library-web to get it to work.
Comment 2 Jens Georg 2012-08-02 11:25:52 UTC
Anything we can do on our side?
Comment 3 Frederic Peters 2012-08-02 11:32:12 UTC
I am not sure, mostly because I don't know the details required for Vala. For example heuristics used to locate the gtk-doc files are the inclusion of gtk-doc.make in a Makefile.am, or a call to gtkdoc-scan, and I guess this doens't fit Vala.
Comment 4 Jens Georg 2012-08-02 12:17:12 UTC
Adding CC for Luca as author of the gtkdoc valadoc taglet
Comment 5 Frederic Peters 2012-08-12 10:50:47 UTC
This is not perfect but this should be the rygel documentations published; it will happen once the website is rebuilt (it happens once a day).

commit 5e9818614306d3ebeba65a595f76a61b1fa1f5d3
Author: Frédéric Péters <fpeters@0d.be>
Date:   Sun Aug 12 12:47:54 2012 +0200

    overlay: explicitely mention rygel documentation directories
    
    The way Rygel API reference documentation is set doesn't allow for the usual
    automatic detection to work; therefore add mentions of those directories to
    the overlay.xml file.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=681063
Comment 6 Murray Cumming 2012-11-07 10:34:16 UTC
Are the cross-references something that you need to fix, or do we need to do something?

For instance, here: 
  http://developer.gnome.org/librygel-renderer/unstable/RygelMediaRenderer.html#RygelMediaRenderer.object-hierarchy
the RygelMediaDevice link should go to here:
  http://developer.gnome.org/librygel-core/unstable/RygelMediaDevice.html
rather than here:
  http://developer.gnome.org/librygel-renderer/librygel-core/RygelMediaDevice.html

Likewise, this should have the same link into librygel-core:
http://developer.gnome.org/librygel-server/unstable/RygelMediaServer.html#RygelMediaServer.object-hierarchy


We have also added a librygel-renderer-gst, with similar documentation, that we'd like to see on developer.gnome.org alongside the other ones, please. It has links into librygel-renderer and librygel-core.
Comment 7 Jens Georg 2012-11-07 10:48:21 UTC
additionaly, there seems to be an issue with the css class not being gtk-doc, causing everything to be orange - is that something we need to fix or is that server-side?
Comment 8 Murray Cumming 2012-11-07 10:57:40 UTC
(In reply to comment #7)
> additionaly, there seems to be an issue with the css class not being gtk-doc,
> causing everything to be orange

Yeah. The links are meant to be orange, like here too, for instance:
http://developer.gnome.org/grilo/unstable/
but the non-link text should not be orange:
http://developer.gnome.org/librygel-renderer/unstable/
Comment 9 Murray Cumming 2012-11-29 12:11:45 UTC
Created attachment 230177 [details] [review]
0001-Add-librygel-renderer-gst.patch

Here is a simple patch to library-web to add librygel-renderer-gst.

I don't know how to correct the cross-references.
Comment 10 Murray Cumming 2012-12-03 11:39:43 UTC
Comment on attachment 230177 [details] [review]
0001-Add-librygel-renderer-gst.patch

Pushed with fredp's permission on irc.
Comment 11 Frederic Peters 2014-01-26 22:58:24 UTC
Murray latest patch fixed it for real.