[Bug 28484] Document API

[bugzilla-daemon at freedesktop.org]

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

Simon McVittie <simon.mcvittie at collabora.co.uk> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Status Whiteboard|                            |review+ with minor changes

--- Comment #1 from Simon McVittie <simon.mcvittie at collabora.co.uk> 2010-06-11 04:03:32 PDT ---
> + * @short_description: Fetch and search trough logs

through

> + * 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.)

> +/**
> + * 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.

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