Bug 17148 - [tools] Needs markup for requestability
Summary: [tools] Needs markup for requestability
Status: RESOLVED FIXED
Alias: None
Product: Telepathy
Classification: Unclassified
Component: tp-spec (show other bugs)
Version: unspecified
Hardware: Other All
: medium normal
Assignee: Telepathy bugs list
QA Contact: Telepathy bugs list
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-08-15 03:45 UTC by Simon McVittie
Modified: 2010-11-09 05:44 UTC (History)
0 users

See Also:
i915 platform:
i915 features:


Attachments

Description Simon McVittie 2008-08-15 03:45:04 UTC
telepathy-spec should have some markup that indicates that a property is useful in CreateChannel (and hypothetically, EnsureChannel) calls. Proposal (using TargetHandle as my example property):

<tp:requestable>
<p>If <a>TargetHandleType</a> is not Handle_Type_None, then either TargetHandle or <a>TargetID</a> must be given.</p>

<p>If <a>TargetHandleType</a> is omitted or Handle_Type_None, or <a>TargetID</a> is given, then TargetHandle must be omitted.</p>
</tp:requestable>

leading to output like:

<h3>Using this property in requests</h3>

This property can be used when requesting a channel.

<p>If <a>TargetHandleType</a> is not Handle_Type_None, then either TargetHandle or <a>TargetID</a> must be given.</p>

<p>If <a>TargetHandleType</a> is omitted or Handle_Type_None, or <a>TargetID</a> is given, then TargetHandle must be omitted.</p>
Comment 1 Simon McVittie 2010-11-09 05:44:32 UTC
Will fixed this with attributes.


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.