[Bug 28484] Document API

[bugzilla-daemon at freedesktop.org]

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

--- Comment #2 from Guillaume Desmottes <guillaume.desmottes at collabora.co.uk> 2010-06-11 05:33:02 PDT ---
(In reply to comment #1)
> > + * @short_description: Fetch and search trough logs
> 
> through

fixed.

> > + * Free @hists and its content.
> 
> @hits
> 
> > rename TPL_LOG_MANAGER_ERROR to TPL_LOG_MANAGER_ERRORS
> 
> Vala will have trouble with that usage; it's telepathy-glib that's being weird
> by pluralizing our error domain, so I'd recommend reverting that particular
> change. (In recent versions of telepathy-glib, TP_ERROR is an undocumented
> synonym for TP_ERRORS for this reason.)

done.

> > +/**
> > + * tpl_log_manager_errors_quark:
> 
> This should probably be undocumented, and appear in a <SUBSECTION Standard>, if
> possible? There's no point in documenting it, given that we document
> TPL_LOG_MANAGER_ERRORS.

humm removing it from the doc means we'll have to manually maintain a
-sections.txt file instead of generating it. I'm not sure it's worth it.

-- 
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.