[Telepathy] [Bug 17148] New: [tools] Needs markup for requestability

[bugzilla-daemon at freedesktop.org]

http://bugs.freedesktop.org/show_bug.cgi?id=17148

           Summary: [tools] Needs markup for requestability
           Product: Telepathy
           Version: unspecified
          Platform: Other
        OS/Version: All
            Status: NEW
          Severity: normal
          Priority: medium
         Component: telepathy-spec
        AssignedTo: telepathy at lists.freedesktop.org
        ReportedBy: simon.mcvittie at collabora.co.uk


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>


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