summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWill Thompson <will.thompson@collabora.co.uk>2010-11-05 17:27:43 -0400
committerWill Thompson <will.thompson@collabora.co.uk>2010-11-05 17:27:43 -0400
commit1d1fe3a37829aa57c42728dedd3e444d8e20d9a7 (patch)
tree7b74f8b65b116bf0432eaef41b1eef603a87bdca /doc
parentce706bdf4f9fa18a2000078bca188e042feb99b0 (diff)
specparser: add markup for sometimes-requestable properties
Diffstat (limited to 'doc')
-rw-r--r--doc/templates/interface.html16
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/templates/interface.html b/doc/templates/interface.html
index 53b27b0c..77db9f2f 100644
--- a/doc/templates/interface.html
+++ b/doc/templates/interface.html
@@ -337,7 +337,21 @@
</div>
#end if
- #if $property.requestable:
+ #if $property.sometimes_requestable:
+ <div class="annotation requestable">Depending on the protocol, this
+ property <strong>requestable</strong> which means that it may be allowed
+ in the properties hash of a channel request such as in the
+ the <a href="Connection_Interface_Requests.html#org.freedesktop.Telepathy.Connection.Interface.Requests.CreateChannel">CreateChannel</a>
+ and
+ <a href="Connection_Interface_Requests.html#org.freedesktop.Telepathy.Connection.Interface.Requests.EnsureChannel">EnsureChannel</a>
+ methods
+ on <a href="Connection_Interface_Requests.html">Requests</a>
+ and <a href="Channel_Dispatcher.html">ChannelDispatcher</a>.
+ If supported on this protocol, the property should appear in either the
+ Fixed_Properties or Allowed_Properties lists of
+ a <a href="Connection_Interface_Requests.html#org.freedesktop.Telepathy.Connection.Interface.Requests.RequestableChannelClasses">RequestableChannelClass</a>
+ advertised by the CM.</div>
+ #elif $property.requestable:
<div class="annotation requestable">This property
is <strong>requestable</strong> which means that it is allowed
in the properties hash of a channel request such as in the