[Bug 15464] Telepathy-glib should link enums in the documentation

bugzilla-daemon at freedesktop.org bugzilla-daemon at freedesktop.org
Thu Jan 6 11:48:22 CET 2011


https://bugs.freedesktop.org/show_bug.cgi?id=15464

Jonny Lamb <jonny.lamb at collabora.co.uk> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                URL|                            |http://git.collabora.co.uk/
                   |                            |?p=user/jonny/telepathy-gli
                   |                            |b.git;a=shortlog;h=refs/hea
                   |                            |ds/client-gen-guint
           Keywords|                            |patch

--- Comment #5 from Jonny Lamb <jonny.lamb at collabora.co.uk> 2011-01-06 02:48:22 PST ---
So, without something like specparser, this is actually really hard because
once you see you have a guint argument you don't know whether it is actually a
number (like number of handles, or avatar height, etc.) or it is an enum.

I've written a patch to fix this in the client codegen. It displays the type in
the gtk-doc for guint arguments if there's a tp:type.

There is a problem here though. Because we don't know whether a guint is part
of an enum or whether it's a number on its own, we get nice links like
#TpConnectionStatus (yay), #TpHandle (yay), and #TpContactHandle (boo).

The latter will just not get linked by gtk-doc, and tbh I think this is
acceptable. We can fix this properly when we break ABI.

Thoughts?

-- 
Configure bugmail: https://bugs.freedesktop.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA contact for the bug.
You are the assignee for the bug.



More information about the telepathy-bugs mailing list