summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSimon McVittie <simon.mcvittie@collabora.co.uk>2011-05-17 17:06:21 +0100
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2011-05-17 17:06:21 +0100
commit977c7a7c4a01ba3fad919d20404865144417d9f6 (patch)
treeb46f73463f233d838e7830e81d1a4f45207f57af /doc
parent6213a3d8977c668a9a3dd2aaca211649ead60998 (diff)
downloaddbus-977c7a7c4a01ba3fad919d20404865144417d9f6.tar.gz
Describe conventional naming of methods and signals
Diffstat (limited to 'doc')
-rw-r--r--doc/dbus-specification.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
index 40455139..6d2b26a4 100644
--- a/doc/dbus-specification.xml
+++ b/doc/dbus-specification.xml
@@ -1290,6 +1290,14 @@
<listitem><para>Must be at least 1 byte in length.</para></listitem>
</itemizedlist>
</para>
+
+ <para>
+ It is conventional for member names on D-Bus to consist of
+ capitalized words with no punctuation ("camel-case").
+ Method names should usually be verbs, such as
+ <literal>GetItems</literal>, and signal names should usually be
+ a description of an event, such as <literal>ItemsChanged</literal>.
+ </para>
</sect3>
<sect3 id="message-protocol-names-error">
<title>Error names</title>