diff options
| author | Danielle Madeley <danielle.madeley@collabora.co.uk> | 2010-12-01 15:35:44 +1100 |
|---|---|---|
| committer | Danielle Madeley <danielle.madeley@collabora.co.uk> | 2010-12-01 15:35:44 +1100 |
| commit | 97312aba741b118306e0570d33bb2aa7af417e8c (patch) | |
| tree | a7528103ba503b399092958146522753f371b623 /doc | |
| parent | 234bf29796b899312b6ffe03c3c1666c90708689 (diff) | |
Add a Base.get_anchor() method, to be used in HTML anchors.
Update get_url() to use get_anchor().
This removes the duplicate construction of anchors, once in the templates
and once in the get_url() method and move it into one place. This allows us
to easily change the way anchors are constructed for a given type.
The way anchors are constructed has been changed to include the type name
at the beginning, i.e. Type-Name:Short_Name, to prevent potential namespace
collisions between client interests and capability tokens.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/templates/errors.html | 2 | ||||
| -rw-r--r-- | doc/templates/generic-types.html | 2 | ||||
| -rw-r--r-- | doc/templates/interface.html | 16 |
3 files changed, 10 insertions, 10 deletions
diff --git a/doc/templates/errors.html b/doc/templates/errors.html index 82c08058..dc580eed 100644 --- a/doc/templates/errors.html +++ b/doc/templates/errors.html @@ -42,7 +42,7 @@ <h1>Errors</h1> #for $error in $spec.sorted_errors <div class="inset error"> - <a name="$error.name"></a> + <a name="$error.get_anchor()"></a> <span class="permalink">(<a href="$error.get_url()">Permalink</a>)</span> <h2> $error.short_name diff --git a/doc/templates/generic-types.html b/doc/templates/generic-types.html index 0bb209e4..c4ed932c 100644 --- a/doc/templates/generic-types.html +++ b/doc/templates/generic-types.html @@ -40,7 +40,7 @@ <h1>Generic Types</h1> #for $type in $spec.generic_types <div class="inset type"> - <a name="$type.name"></a> + <a name="$type.get_anchor()"></a> <span class="permalink">$type.get_type_name() (<a href="$type.get_url()">Permalink</a>)</span> <h2> $type.short_name — $type.dbus_type diff --git a/doc/templates/interface.html b/doc/templates/interface.html index 4019e307..4920f0f7 100644 --- a/doc/templates/interface.html +++ b/doc/templates/interface.html @@ -214,7 +214,7 @@ </div> #for $interest in $interface.client_interests <div class="inset client-interest"> - <a name="$interest.name"></a> + <a name="$interest.get_anchor()"></a> <span class="permalink">(<a href="$interest.get_url()">Permalink</a>)</span> <h2>$interest.name</h2> @@ -230,7 +230,7 @@ <h1>Methods</h1> #for $method in $interface.methods <div class="inset method"> - <a name="$method.name"></a> + <a name="$method.get_anchor()"></a> <span class="permalink">(<a href="$method.get_url()">Permalink</a>)</span> <h2>$method.short_name ($method.get_in_args()) → $method.get_out_args()</h2> @@ -302,7 +302,7 @@ <h1>Signals</h1> #for $signal in $interface.signals <div class="inset signal"> - <a name="$signal.name"></a> + <a name="$signal.get_anchor()"></a> <span class="permalink">(<a href="$signal.get_url()">Permalink</a>)</span> <h2>$signal.short_name ($signal.get_args())</h2> @@ -345,7 +345,7 @@ </div> #for $property in $interface.properties <div class="inset property"> - <a name="$property.name"></a> + <a name="$property.get_anchor()"></a> <span class="permalink">(<a href="$property.get_url()">Permalink</a>)</span> <h2> $property.short_name — $property.dbus_type @@ -434,7 +434,7 @@ </div> #for $property in $interface.tpproperties <div class="inset tpproperty"> - <a name="$property.name"></a> + <a name="$property.get_anchor()"></a> <span class="permalink">(<a href="$property.get_url()">Permalink</a>)</span> <h2> $property.short_name — $property.dbus_type @@ -459,7 +459,7 @@ </div> #for $token in $interface.contact_attributes <div class="inset contact-attribute"> - <a name="$token.name"></a> + <a name="$token.get_anchor()"></a> <span class="permalink">(<a href="$token.get_url()">Permalink</a>)</span> <h2> $token.name — $token.dbus_type @@ -483,7 +483,7 @@ </div> #for $token in $interface.handler_capability_tokens <div class="inset handler-capability-token"> - <a name="$token.name"></a> + <a name="$token.get_anchor()"></a> <span class="permalink">(<a href="$token.get_url()">Permalink</a>)</span> <h2> $token.name @@ -506,7 +506,7 @@ <h1>Types</h1> #for $type in $interface.types <div class="inset type"> - <a name="$type.name"></a> + <a name="$type.get_anchor()"></a> <span class="permalink">$type.get_type_name() (<a href="$type.get_url()">Permalink</a>)</span> <h2> $type.short_name — $type.dbus_type |