Bug 28484 - Document API
Summary: Document API
Status: RESOLVED FIXED
Alias: None
Product: Telepathy
Classification: Unclassified
Component: logger (show other bugs)
Version: unspecified
Hardware: Other All
: medium normal
Assignee: Telepathy bugs list
QA Contact: Telepathy bugs list
URL: http://git.collabora.co.uk/?p=user/ca...
Whiteboard: review+
Keywords: patch
Depends on:
Blocks:
 
Reported: 2010-06-10 06:59 UTC by Guillaume Desmottes
Modified: 2010-06-11 06:03 UTC (History)
0 users

See Also:
i915 platform:
i915 features:


Attachments

Comment 1 Simon McVittie 2010-06-11 04:03:32 UTC
> + * @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.
Comment 2 Guillaume Desmottes 2010-06-11 05:33:02 UTC
(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.
Comment 3 Guillaume Desmottes 2010-06-11 06:03:25 UTC
Merged.


Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.