[telepathy-spec/master] HTML: produce documentation for contact attributes and handler cap.tokens

Simon McVittie simon.mcvittie at collabora.co.uk
Wed Aug 5 10:21:28 PDT 2009


---
 doc/templates/interface.html |   85 ++++++++++++++++++++++++++++++++++++++++++
 doc/templates/style.css      |   20 +++++++++-
 2 files changed, 104 insertions(+), 1 deletions(-)

diff --git a/doc/templates/interface.html b/doc/templates/interface.html
index f3b7c66..79c35b2 100644
--- a/doc/templates/interface.html
+++ b/doc/templates/interface.html
@@ -16,6 +16,8 @@
    #if $interface.signals: | <a href="#signals">Signals</a>
    #if $interface.properties: | <a href="#properties">Properties</a>
    #if $interface.tpproperties: | <a href="#tpproperties">Telepathy Properties</a>
+   #if $interface.contact_attributes: | <a href="#contact-attributes">Contact Attributes</a>
+   #if $interface.handler_capability_tokens: | <a href="#handler-capability-tokens">Handler Capability Tokens</a>
    #if $interface.types: | <a href="#types">Types</a>
   </div>
   <div class="main">
@@ -101,6 +103,38 @@
     </table>
     #end if
 
+     #if $interface.contact_attributes
+     <h3>Contact Attributes</h3>
+     <table class="summary">
+      #for $token in $interface.contact_attributes
+       <tr class="contact-attribute">
+       <td><a href="$token.get_url()">$token.name</a></td>
+       <td>
+        $token.dbus_type
+        #if $token.type: (<a href="$token.get_type_url()" title="$token.get_type_title()">$token.get_type().short_name</a>)
+       </td>
+      </tr>
+      #end for
+    </table>
+    #end if
+
+     #if $interface.handler_capability_tokens
+     <h3>Handler Capability Tokens</h3>
+     <table class="summary">
+      #for $token in $interface.handler_capability_tokens
+       <tr class="handler-capability-token">
+         <td><a href="$token.get_url()">$token.name</a>
+           #if $token.is_family
+             (etc.)
+           #end if
+         </td>
+       <td>
+       </td>
+      </tr>
+      #end for
+    </table>
+    #end if
+
      #if $interface.types
      <h3>Types</h3>
      <table class="summary">
@@ -311,6 +345,57 @@
    </div>
    #end if
 
+   #if $interface.contact_attributes
+   <div class="outset contact-attributes">
+    <a name="contact-attributes"></a>
+    <h1>Contact Attributes</h1>
+    <div>
+      Attributes that a contact can have, accessed with the
+      org.freedesktop.Telepathy.Connection.Interface.Contacts interface.
+    </div>
+    #for $token in $interface.contact_attributes
+    <div class="inset contact-attribute">
+     <a name="$token.name"></a>
+     <span class="permalink">(<a href="$token.get_url()">Permalink</a>)</span>
+     <h2>
+      $token.name &mdash; $token.dbus_type
+      #if $token.type: (<a href="$token.get_type_url()" title="$token.get_type_title()">$token.get_type().short_name</a>)
+     </h2>
+     $token.get_added()
+     $token.get_changed()
+     $token.get_deprecated()
+     $token.get_docstring()
+    </div>
+    #end for
+   </div>
+   #end if
+
+   #if $interface.handler_capability_tokens
+   <div class="outset handler-capability-tokens">
+    <a name="handler-capability-tokens"></a>
+    <h1>Handler Capability Tokens</h1>
+    <div>
+      Tokens representing capabilities that a Client.Handler can have.
+    </div>
+    #for $token in $interface.handler_capability_tokens
+    <div class="inset handler-capability-token">
+     <a name="$token.name"></a>
+     <span class="permalink">(<a href="$token.get_url()">Permalink</a>)</span>
+     <h2>
+      $token.name
+      #if $token.is_family
+      (etc.)
+      #end if
+     </h2>
+     $token.get_added()
+     $token.get_changed()
+     $token.get_deprecated()
+     $token.get_docstring()
+    </div>
+    #end for
+   </div>
+   #end if
+
    #if $interface.types
    <div class="outset types type">
     <a name="types"></a>
diff --git a/doc/templates/style.css b/doc/templates/style.css
index ba73b6b..964d88b 100644
--- a/doc/templates/style.css
+++ b/doc/templates/style.css
@@ -99,7 +99,25 @@ div.tpproperties {
 }
 
 div.tpproperty {
-	border: 1px solid: #333333;
+	border: 1px solid #333333;
+}
+
+div.contact-attributes {
+	background-color: #ccccff;
+	border: 1px solid #9999cc;
+}
+
+div.contact-attribute {
+	border: 1px solid #9999cc;
+}
+
+div.handler-capability-tokens {
+	background-color: #339933;
+	border: 1px solid #228822;
+}
+
+div.handler-capability-token {
+	border: 1px solid #228822;
 }
 
 div.types {
-- 
1.5.6.5




More information about the telepathy-commits mailing list