diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 11 | ||||
| -rw-r--r-- | doc/reference/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/reference/libtelepathy-logger/Makefile.am | 131 | ||||
| -rw-r--r-- | doc/reference/libtelepathy-logger/docs.xml | 22 | ||||
| -rw-r--r-- | doc/templates/devhelp.devhelp2 | 18 | ||||
| -rw-r--r-- | doc/templates/errors.html | 60 | ||||
| -rw-r--r-- | doc/templates/fullindex.html | 60 | ||||
| -rw-r--r-- | doc/templates/generic-types.html | 59 | ||||
| -rw-r--r-- | doc/templates/index.html | 66 | ||||
| -rw-r--r-- | doc/templates/interface.html | 424 | ||||
| -rw-r--r-- | doc/templates/interfaces.html | 50 | ||||
| -rw-r--r-- | doc/templates/style.css | 224 |
12 files changed, 0 insertions, 1126 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am deleted file mode 100644 index 9fc6618..0000000 --- a/doc/Makefile.am +++ /dev/null @@ -1,11 +0,0 @@ -SUBDIRS = reference - -EXTRA_DIST = \ - templates/errors.html \ - templates/interfaces.html \ - templates/style.css \ - templates/generic-types.html \ - templates/index.html \ - templates/interface.html \ - templates/devhelp.devhelp2 \ - templates/fullindex.html diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am deleted file mode 100644 index 84b5d8b..0000000 --- a/doc/reference/Makefile.am +++ /dev/null @@ -1 +0,0 @@ -SUBDIRS = libtelepathy-logger diff --git a/doc/reference/libtelepathy-logger/Makefile.am b/doc/reference/libtelepathy-logger/Makefile.am deleted file mode 100644 index d54eb99..0000000 --- a/doc/reference/libtelepathy-logger/Makefile.am +++ /dev/null @@ -1,131 +0,0 @@ -## Process this file with automake to produce Makefile.in - -abs_top_builddir = @abs_top_builddir@ - -# We require automake 1.6 at least. -AUTOMAKE_OPTIONS = 1.6 - -# This is a blank Makefile.am for using gtk-doc. -# Copy this to your project's API docs directory and modify the variables to -# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples -# of using the various options. - -# The name of the module, e.g. 'glib'. -DOC_MODULE=telepathy-logger-1 - -# The top-level SGML file. You can change this if you want to. -DOC_MAIN_SGML_FILE=docs.xml - -# The directory containing the source code. Relative to $(srcdir). -# gtk-doc will search all .c & .h files beneath here for inline comments -# documenting the functions and macros. -# e.g. DOC_SOURCE_DIR=../../../gtk -DOC_SOURCE_DIR=../../../telepathy-logger - -# Extra options to pass to gtkdoc-scangobj. Not normally needed. -SCANGOBJ_OPTIONS= - -# Extra options to supply to gtkdoc-scan. -# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" -# --rebuild-sections means we get a section (xml/*.xml) per header file: this -# should be removed if we want to maintain the sections file by hand, to split -# or combine sections. -SCAN_OPTIONS= \ - --deprecated-guards=TP_DISABLE_DEPRECATED \ - --rebuild-sections \ - --rebuild-types - -# Extra options to supply to gtkdoc-mkdb. -# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml -MKDB_OPTIONS=--sgml-mode --output-format=xml - -# Extra options to supply to gtkdoc-mktmpl -# e.g. MKTMPL_OPTIONS=--only-section-tmpl -MKTMPL_OPTIONS= - -# Extra options to supply to gtkdoc-fixref. Not normally needed. -# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html -FIXXREF_OPTIONS= - -# Used for dependencies. The docs will be rebuilt if any of these change. -# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h -# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c -HFILE_GLOB=$(top_srcdir)/telepathy-logger/*.h -CFILE_GLOB=$(top_srcdir)/telepathy-logger/*.c - -# Header files to ignore when scanning. -# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h -IGNORE_HFILES=\ - action-chain-internal.h \ - call-channel-internal.h \ - call-event-internal.h \ - channel-factory-internal.h \ - channel-internal.h \ - client-factory-internal.h \ - conf-internal.h \ - contact-internal.h \ - dbus-service-internal.h \ - debug-internal.h \ - event-internal.h \ - log-iter-internal.h \ - log-iter-pidgin-internal.h \ - log-iter-xml-internal.h \ - log-manager-internal.h \ - log-store.c \ - log-store-factory-internal.h \ - log-store-internal.h \ - log-store-sqlite-internal.h \ - log-store-xml-internal.h \ - log-walker-internal.h \ - observer-internal.h \ - text-channel-internal.h \ - text-event-internal.h \ - util-internal.h - -# Images to copy into HTML directory. -# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png -HTML_IMAGES= - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -# e.g. content_files=running.sgml building.sgml changes-2.0.sgml -content_files= - -# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded -# These files must be listed here *and* in content_files -# e.g. expand_content_files=running.sgml -expand_content_files= - -# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. -# Only needed if you are using gtkdoc-scangobj to dynamically query widget -# signals and properties. -# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) -# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) -INCLUDES= \ - -I$(top_srcdir) -I$(top_builddir) \ - $(TPL_CFLAGS) -GTKDOC_LIBS= \ - $(TPL_LIBS) \ - $(top_builddir)/telepathy-logger/libtelepathy-logger-1.la - -# This includes the standard gtk-doc make rules, copied by gtkdocize. -include $(top_srcdir)/gtk-doc.make - -if ENABLE_GTK_DOC -# Enable this enforce the documenting of symbols in `make check` -# check-local: check-undocumented - -check-undocumented: - @if grep '^0 symbols incomplete' \ - $(srcdir)/telepathy-logger-undocumented.txt; then\ - :; else \ - cat $(srcdir)/telepathy-logger-undocumented.txt; exit 1; fi - @if grep '^0 not documented' \ - $(srcdir)/telepathy-logger-undocumented.txt; then\ - :; else \ - cat $(srcdir)/telepathy-logger-undocumented.txt; exit 1; fi - @if grep . $(srcdir)/telepathy-logger-unused.txt; then\ - echo "^^^ Unused symbols" >&2; exit 1; fi - @if test -e $(srcdir)/telepathy-logger-undeclared.txt &&\ - grep . $(srcdir)/telepathy-logger-undeclared.txt; then\ - echo "^^^ Undeclared symbols" >&2; exit 1; fi -endif diff --git a/doc/reference/libtelepathy-logger/docs.xml b/doc/reference/libtelepathy-logger/docs.xml deleted file mode 100644 index dd1d09d..0000000 --- a/doc/reference/libtelepathy-logger/docs.xml +++ /dev/null @@ -1,22 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> - <bookinfo> - <title>telepathy-logger Reference Manual</title> - </bookinfo> - - <chapter id="ch-public"> - <title>libtelepathy-logger API</title> - - <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> - <xi:include href="xml/log-manager.xml"/> - <xi:include href="xml/log-walker.xml"/> - <xi:include href="xml/event.xml"/> - <xi:include href="xml/text-event.xml"/> - <xi:include href="xml/call-event.xml"/> - <xi:include href="xml/entity.xml"/> - </chapter> - -</book> -<!-- set sts=2 sw=2 et --> diff --git a/doc/templates/devhelp.devhelp2 b/doc/templates/devhelp.devhelp2 deleted file mode 100644 index af327fa..0000000 --- a/doc/templates/devhelp.devhelp2 +++ /dev/null @@ -1,18 +0,0 @@ -<?xml version="1.0"?> -<book xmlns="http://www.devhelp.net/book" title="$spec.title" name="$name" link="index.html"> - <chapters> -#for $interface in $spec.interfaces - <sub name="$interface.name" link="$interface.get_url()"/> -#end for - <sub name="Generic Types" link="generic-types.html"/> - <sub name="Errors" link="errors.html"/> - <sub name="Full Index" link="fullindex.html"/> - </chapters> - <functions> -#for $obj in $spec.everything.values() + $spec.types.values() + $spec.errors.values() - <keyword type="$obj.devhelp_name" name="$obj.get_title()" link="$obj.get_url()" #slurp -#if $obj.deprecated: deprecated="true" #slurp -/> -#end for - </functions> -</book> diff --git a/doc/templates/errors.html b/doc/templates/errors.html deleted file mode 100644 index 907d660..0000000 --- a/doc/templates/errors.html +++ /dev/null @@ -1,60 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!DOCTYPE html PUBLIC "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" ""> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> - <head> - <title>Errors</title> - <link rel="stylesheet" href="style.css" type="text/css"/> - </head> - <body> - <div class="header"> - <h1>Errors</h1> - <a href="index.html">Interface Index</a> - (<a href="interfaces.html">Compact</a>) - | <a href="#summary">Summary</a> - | <a href="#errors">Errors</a> - </div> - <div class="main"> - <div class="summary"> - <a name="summary"></a> - <h3>Errors</h3> - <table class="summary"> - #for $error in $spec.errors.values() - #if $error.deprecated - <tr class="deprecated"> - #else - <tr> - #end if - <td><a href="$error.get_url()">$error.short_name</a></td> - <td> - #if $error.deprecated: (deprecated) - </td> - </tr> - #end for - </table> - </div> - - <div class="outset errors error"> - <a name="errors"></a> - <h1>Errors</h1> - #for $error in $spec.errors.values() - <div class="inset error"> - <a name="$error.name"></a> - <span class="permalink">(<a href="$error.get_url()">Permalink</a>)</span> - <h2> - $error.short_name - </h2> - - <div class="indent"> - <code>$error.name</code> - </div> - - $error.get_added() - $error.get_deprecated() - $error.get_docstring() - </div> - #end for - </div> - </div> - - </body> -</html> diff --git a/doc/templates/fullindex.html b/doc/templates/fullindex.html deleted file mode 100644 index 2c465e1..0000000 --- a/doc/templates/fullindex.html +++ /dev/null @@ -1,60 +0,0 @@ -#from itertools import groupby -<?xml version="1.0" encoding="utf-8"?> -<!DOCTYPE html PUBLIC "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" ""> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> - <head> - <title>Full Index</title> - <link rel="stylesheet" href="style.css" type="text/css"/> - </head> - -#set $star = [] -#for $item in $spec.everything.values() + $spec.errors.values() + $spec.generic_types - #echo $star.append(($item.short_name, $item)) - #slurp -#end for -#echo $star.sort(key = lambda t: t[0].title()) -#slurp -## one use iterators... -#set $groups = [ (l, list(g)) for l, g in (groupby($star, key = lambda t: t[0][0].upper())) ] -#set $letters = set(map(lambda t: t[0], groups)) - - <body> - <div class="header"> - <h1>Full Index</h1> - <a href="index.html">Interface Index</a> - (<a href="interfaces.html">Compact</a>) - #for $a in map(chr, xrange(ord('A'), ord('Z')+1)) - #if $a in $letters - | <a href="#$a">$a</a> - #else - | $a - #end if - #end for - </div> - - <div class="main"> - <table class="summary"> - #for l, g in $groups - <tr><th colspan="3"><a name="$l"></a>$l</th></tr> - #for $n in $g - #if $n[1].deprecated - <tr class="deprecated"> - #else - <tr> - #end if - <td> - <a href="$n[1].get_url()" title="$n[1].get_title()">$n[0]</a> - #if $n[1].deprecated: (deprecated) - </td> - <td>$n[1].get_type_name()</td> - <td> - #if $n[1].parent.__class__.__name__ == 'Interface': $n[1].parent.name - </td> - </tr> - #end for - #end for - <table> - </div> - - </body> -</html> diff --git a/doc/templates/generic-types.html b/doc/templates/generic-types.html deleted file mode 100644 index 0bb209e..0000000 --- a/doc/templates/generic-types.html +++ /dev/null @@ -1,59 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!DOCTYPE html PUBLIC "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" ""> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> - <head> - <title>Generic Types</title> - <link rel="stylesheet" href="style.css" type="text/css"/> - </head> - <body> - <div class="header"> - <h1>Generic Types</h1> - <a href="index.html">Interface Index</a> - (<a href="interfaces.html">Compact</a>) - | <a href="#summary">Summary</a> - | <a href="#types">Types</a> - </div> - <div class="main"> - <div class="summary"> - <a name="summary"></a> - <h3>Generic Types</h3> - <table class="summary"> - #for $type in $spec.generic_types - #if $type.deprecated - <tr class="deprecated"> - #else - <tr> - #end if - <td><a href="$type.get_url()">$type.short_name</a></td> - <td>$type.get_type_name()</td> - <td>$type.dbus_type</td> - <td> - #if $type.deprecated: (deprecated) - </td> - </tr> - #end for - </table> - </div> - - <div class="outset types type"> - <a name="types"></a> - <h1>Generic Types</h1> - #for $type in $spec.generic_types - <div class="inset type"> - <a name="$type.name"></a> - <span class="permalink">$type.get_type_name() (<a href="$type.get_url()">Permalink</a>)</span> - <h2> - $type.short_name — $type.dbus_type - </h2> - - $type.get_added() - $type.get_deprecated() - $type.get_docstring() - $type.get_breakdown() - </div> - #end for - </div> - </div> - - </body> -</html> diff --git a/doc/templates/index.html b/doc/templates/index.html deleted file mode 100644 index efc38d4..0000000 --- a/doc/templates/index.html +++ /dev/null @@ -1,66 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!DOCTYPE html PUBLIC "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" ""> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> - <head> - <title>$spec.title &mdash v$spec.version</title> - <link rel="stylesheet" href="style.css" type="text/css"/> - </head> - <body> - <div class="header"> - <h1>$spec.title</h1> - <a href="#interfaces">Interfaces</a> - (<a href="interfaces.html">Compact</a>) - | <a href="generic-types.html">Generic Types</a> - | <a href="errors.html">Errors</a> - | <a href="fullindex.html">Full Index</a> - </div> - - <div class="main"> - <h3 class="version">Version $spec.version</h3> - <p class="copyrights"> - #echo '<br/>'.join($spec.copyrights) - </p> - $spec.license - - <a name="interfaces"></a> - <h3>Interfaces</h3> - <ul> - #def output($items) - #for $item in $items - #if $item.__class__.__name__ == 'Section' - <li class="chapter">$item.short_name</li> - $item.get_docstring() - <ul> - $output($item.items) - </ul> - #else - #if $item.causes_havoc - <li class="causes-havoc"> - #elif $item.deprecated - <li class="deprecated"> - #else - <li> - #end if - <a href="$item.get_url()">$item.name</a> - #if $item.causes_havoc - (unstable) - #elif $item.deprecated - (deprecated) - #end if - </li> - #end if - #end for - #end def - $output($spec.items) - </ul> - - <a name="other"></a> - <h3>Other</h3> - <ul> - <li><a href="generic-types.html">Generic Types</a></li> - <li><a href="errors.html">Errors</a></li> - </ul> - - </div> - </body> -</html> diff --git a/doc/templates/interface.html b/doc/templates/interface.html deleted file mode 100644 index 42ad0ce..0000000 --- a/doc/templates/interface.html +++ /dev/null @@ -1,424 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!DOCTYPE html PUBLIC "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" ""> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> - <head> - <title>$interface.name</title> - <link rel="stylesheet" href="style.css" type="text/css"/> - </head> - <body> - <div class="header"> - <h1>Interface $interface.name</h1> - <a href="index.html">Interface Index</a> - (<a href="interfaces.html">Compact</a>) - | <a href="#summary">Summary</a> - #if $interface.docstring: | <a href="#description">Description</a> - #if $interface.methods: | <a href="#methods">Methods</a> - #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"> - - #if $interface.methods or $interface.signals or $interface.properties or $interface.types or $interface.tpproperties - <div class="summary"> - <a name="summary"></a> - #if $interface.methods - <h3>Methods</h3> - <table class="summary"> - #for $method in $interface.methods - #if $method.deprecated - <tr class="deprecated"> - #else - <tr> - #end if - <td><a href="$method.get_url()">$method.short_name</a></td> - <td>($method.get_in_args())</td> - <td>→</td> - <td>$method.get_out_args()</td> - <td> - #if $method.deprecated: (deprecated) - </td> - </tr> - #end for - </table> - #end if - - #if $interface.signals - <h3>Signals</h3> - <table class="summary"> - #for $signal in $interface.signals - #if $signal.deprecated - <tr class="deprecated"> - #else - <tr> - #end if - <td><a href="$signal.get_url()">$signal.short_name</a></td> - <td>($signal.get_args())</td> - <td> - #if $signal.deprecated: (deprecated) - </td> - </tr> - #end for - </table> - #end if - - #if $interface.properties - <h3>Properties</h3> - <table class="summary"> - #for $property in $interface.properties - #if $property.deprecated - <tr class="deprecated"> - #else - <tr> - #end if - <td><a href="$property.get_url()">$property.short_name</a></td> - <td> - $property.dbus_type - #if $property.type: (<a href="$property.get_type_url()" title="$property.get_type_title()">$property.get_type().short_name</a>) - </td> - <td>$property.get_access()</td> - <td> - #if $property.deprecated: (deprecated) - </td> - </tr> - #end for - </table> - #end if - - #if $interface.tpproperties - <h3>Telepathy Properties</h3> - <table class="summary"> - #for $property in $interface.tpproperties - <tr class="deprecated"> - <td><a href="$property.get_url()">$property.short_name</a></td> - <td> - $property.dbus_type - #if $property.type: (<a href="$property.get_type_url()" title="$property.get_type_title()">$property.get_type().short_name</a>) - </td> - </tr> - #end for - </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"> - #for $type in $interface.types - #if type.deprecated - <tr class="deprecated"> - #else - <tr> - #end if - <td><a href="$type.get_url()">$type.short_name</a></td> - <td>$type.get_type_name()</td> - <td>$type.dbus_type</td> - <td> - #if $type.deprecated: (deprecated) - </td> - </tr> - #end for - </table> - #end if - </div> - #end if - - #if $interface.causes_havoc - <div class="havoc"><span class="warning">WARNING:</span> - This interface is $interface.causes_havoc and is likely to cause havoc - to your API/ABI if bindings are generated. Do not include this interface - in libraries that care about compatibility. - </div> - #end if - $interface.get_added() - $interface.get_changed() - $interface.get_deprecated() - - #if $interface.requires - <div class="requires"> - Objects implementing this interface must also implement: - <ul> - #for $req in $interface.get_requires() - <li><a href="$req.get_url()" title="$req.get_title()">$req.name</a></li> - #end for - </ul> - </div> - #end if - - #if $interface.docstring - <a name="description"></a> - <h3>Description</h3> - $interface.get_docstring() - #end if - - #if $interface.methods - <div class="outset methods method"> - <a name="methods"></a> - <h1>Methods</h1> - #for $method in $interface.methods - <div class="inset method"> - <a name="$method.name"></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> - - $method.get_added() - $method.get_changed() - $method.get_deprecated() - - #if $method.in_args - <div class="indent"> - <h3>Parameters</h3> - <ul> - #for $arg in $method.in_args - <li> - $arg.short_name — $arg.dbus_type - #if $arg.get_type(): (<a href="$arg.get_type_url()" title="$arg.get_type_title()">$arg.get_type().short_name</a>) - </li> - $arg.get_added() - $arg.get_changed() - $arg.get_deprecated() - $arg.get_docstring() - #end for - </ul> - </div> - #end if - - #if $method.out_args - <div class="indent"> - <h3>Returns</h3> - <ul> - #for $arg in $method.out_args - <li> - $arg.short_name — $arg.dbus_type - #if $arg.get_type(): (<a href="$arg.get_type_url()" title="$arg.get_type_title()">$arg.get_type().short_name</a>) - </li> - $arg.get_added() - $arg.get_changed() - $arg.get_deprecated() - $arg.get_docstring() - #end for - </ul> - </div> - #end if - - $method.get_docstring() - - #if $method.possible_errors - <hr/> - <div class="indent"> - <h3>Possible Errors</h3> - <ul> - #for $error in $method.possible_errors - <li><a href="$error.get_url()" title="$error.get_title()">$error.get_error().short_name</a></li> - $error.get_added() - $error.get_changed() - $error.get_deprecated() - $error.get_docstring() - #end for - </ul> - </div> - #end if - </div> - #end for - </div> - #end if - - #if $interface.signals - <div class="outset signals signal"> - <a name="signals"></a> - <h1>Signals</h1> - #for $signal in $interface.signals - <div class="inset signal"> - <a name="$signal.name"></a> - <span class="permalink">(<a href="$signal.get_url()">Permalink</a>)</span> - <h2>$signal.short_name ($signal.get_args())</h2> - - $signal.get_added() - $signal.get_changed() - $signal.get_deprecated() - - #if $signal.args - <div class="indent"> - <h3>Parameters</h3> - <ul> - #for $arg in $signal.args - <li> - $arg.short_name — $arg.dbus_type - #if $arg.get_type(): (<a href="$arg.get_type_url()" title="$arg.get_type_title()">$arg.get_type().short_name</a>) - </li> - $arg.get_added() - $arg.get_changed() - $arg.get_deprecated() - $arg.get_docstring() - #end for - </ul> - </div> - #end if - - $signal.get_docstring() - </div> - #end for - </div> - #end if - - #if $interface.properties - <div class="outset properties property"> - <a name="properties"></a> - <h1>Properties</h1> - <div> - Accessed using the org.freedesktop.DBus.Properties interface. - </div> - #for $property in $interface.properties - <div class="inset property"> - <a name="$property.name"></a> - <span class="permalink">(<a href="$property.get_url()">Permalink</a>)</span> - <h2> - $property.short_name — $property.dbus_type - #if $property.type: (<a href="$property.get_type_url()" title="$property.get_type_title()">$property.get_type().short_name</a>) - </h2> - <div class="access">$property.get_access()</div> - - $property.get_added() - $property.get_changed() - $property.get_deprecated() - $property.get_docstring() - </div> - #end for - </div> - #end if - - #if $interface.tpproperties - <div class="outset tpproperties tpproperty"> - <a name="tpproperties"></a> - <h1>Telepathy Properties</h1> - <div> - Accessed using the im.telepathy1.Properties interface. - </div> - #for $property in $interface.tpproperties - <div class="inset tpproperty"> - <a name="$property.name"></a> - <span class="permalink">(<a href="$property.get_url()">Permalink</a>)</span> - <h2> - $property.short_name — $property.dbus_type - #if $property.type: (<a href="$property.get_type_url()" title="$property.get_type_title()">$property.get_type().short_name</a>) - </h2> - $property.get_added() - $property.get_changed() - $property.get_deprecated() - $property.get_docstring() - </div> - #end for - </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 - im.telepathy1.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 — $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> - <h1>Types</h1> - #for $type in $interface.types - <div class="inset type"> - <a name="$type.name"></a> - <span class="permalink">$type.get_type_name() (<a href="$type.get_url()">Permalink</a>)</span> - <h2> - $type.short_name — $type.dbus_type - </h2> - - $type.get_added() - $type.get_changed() - $type.get_deprecated() - $type.get_docstring() - $type.get_breakdown() - </div> - #end for - </div> - #end if - - </div> - - </body> -</html> diff --git a/doc/templates/interfaces.html b/doc/templates/interfaces.html deleted file mode 100644 index a93334c..0000000 --- a/doc/templates/interfaces.html +++ /dev/null @@ -1,50 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!DOCTYPE html PUBLIC "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" ""> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> - <head> - <title>$spec.title &mdash v$spec.version</title> - <link rel="stylesheet" href="style.css" type="text/css"/> - </head> - <body> - <div class="header"> - <h1>$spec.title</h1> - <a href="index.html">Full</a> - | <a href="generic-types.html">Generic Types</a> - | <a href="errors.html">Errors</a> - | <a href="fullindex.html">Full Index</a> - </div> - - <div class="main"> - <b>Version $spec.version</b> - - <a name="interfaces"></a> - <h3>Interfaces</h3> - <ul> - #for $interface in $spec.interfaces - #if $interface.causes_havoc - <li class="causes-havoc"> - #elif $interface.deprecated - <li class="deprecated"> - #else - <li> - #end if - <a href="$interface.get_url()">$interface.name</a> - #if $interface.causes_havoc - (unstable) - #elif $interface.deprecated - (deprecated) - #end if - </li> - #end for - </ul> - - <a name="other"></a> - <h3>Other</h3> - <ul> - <li><a href="generic-types.html">Generic Types</a></li> - <li><a href="errors.html">Errors</a></li> - </ul> - - </div> - </body> -</html> diff --git a/doc/templates/style.css b/doc/templates/style.css deleted file mode 100644 index 964d88b..0000000 --- a/doc/templates/style.css +++ /dev/null @@ -1,224 +0,0 @@ -html, body, -h1, h2 { - margin: 0; - padding: 0; -} - -h3 { - margin-top: 2pt; - margin-bottom: 2pt; -} - -ul { - margin: 1ex; - margin-left: 1.5em; - padding: 0; -} - -hr { - border-style: none; - color: #cccccc; - background-color: #cccccc; - height: 1px; -} - -div.header { - position: fixed; - height: 4em; - background-color: white; - width: 100%; - margin: 0; - padding: 0.5ex; - border-bottom: 1px solid black; - top: 0; - left: 0; - z-index: 1; -} - -div.header h1 { - white-space: nowrap; - text-overflow: ellipsis; - overflow: hidden; -} - -div.main { - margin-top: 5em; - margin-left: 1ex; - margin-right: 1ex; - margin-bottom: 1ex; -} - -div.main a[name] { - position: relative; - top: -4.5em; -} - -div.outset { - padding: 1ex; - margin-top: 1ex; - margin-bottom: 1ex; -} - -div.inset { - background-color: white; - margin-top: 1ex; - margin-bottom: 1ex; - padding: 0.5ex; -} - -div.indent { - margin-left: 1em; -} - -div.methods { - background-color: #fcaf3e; -} - -div.method { - border: 1px solid #f57900; -} - -div.signals { - background-color: #729fcf; -} - -div.signal { - border: 1px solid #3465a4; -} - -div.properties { - background-color: #ad7fa8; -} - -div.property { - border: 1px solid #75507b; -} - -div.tpproperties { - background-color: #999999; -} - -div.tpproperty { - 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 { - background-color: #e9b96e; -} - -div.type { - border: 1px solid #c17d11; -} - -div.errors { - background-color: #ef2929; -} - -div.error { - border: 1px solid #cc0000; -} - -div.access { - font-weight: bold; - margin-left: 1ex; -} - -div.summary { - padding: 0.5ex; - background-color: #eeeeec; - border: 1px solid #d3d7cf; -} - -table.summary { - margin: 1ex; - font-size: small; -} - -table.summary td { - padding-right: 1ex; -} - -li.chapter { - margin-top: 1ex; - font-weight: bold; -} - -li.causes-havoc { - font-style: italic; -} - -li.deprecated, -li.deprecated a, -table.summary tr.deprecated td, -table.summary tr.deprecated td a { - color: gray; -} - -div.requires, -div.docstring { - margin: 1ex; -} - -div.added { - border-left: 2px solid #4e9a06; - margin: 1ex; - padding-left: 1ex; -} - -div.added span.version { - color: #4e9a06; - font-weight: bold; -} - -div.changed { - border-left: 2px solid #8f5902; - margin: 1ex; - padding-left: 1ex; -} - -div.changed span.version { - color: #8f5902; - font-weight: bold; -} - -div.deprecated, -div.havoc { - border-left: 2px solid #a40000; - margin: 1ex; - padding-left: 1ex; -} - -div.deprecated span.version, -span.warning { - color: #a40000; - font-weight: bold; -} - -div.rationale { - border-left: 2px solid gray; - margin: 1ex; - padding-left: 1ex; -} - -span.permalink { - float: right; - font-size: x-small; -} |