Rename the org.gtk.GDBus.TypeName annotation to org.gtk.GDBus.Name

... and allow also using it for methods, properties and signals.

1 files changed, 27 insertions, 7 deletions

diff --git a/doc/gdbus-binding-tool.xml b/doc/gdbus-binding-tool.xml
index d16f427..7db227d 100644
--- a/doc/gdbus-binding-tool.xml
+++ b/doc/gdbus-binding-tool.xml
@@ -455,15 +455,35 @@ GVariant  *foo_rect_to_gvariant   (FooRect  *rect);
   <variablelist>
 
     <varlistentry>
-      <term><literal>org.gtk.GDBus.TypeName</literal></term>
+      <term><literal>org.gtk.GDBus.Name</literal></term>
       <listitem>
         <para>
-          Can be used on any <literal>&lt;interface&gt;</literal>
-          element to specify the type name to use for the generated
-          <type>GType</type>. If not specified, the type name is
-          calculated by (essentially) removing the dots in the
-          interface name (optionally after stripping the name
-          cf. <option>--strip-prefix</option>).
+          Can be used on any <literal>&lt;interface&gt;</literal>,
+          <literal>&lt;method&gt;</literal>,
+          <literal>&lt;signal&gt;</literal> and
+          <literal>&lt;property&gt;</literal> element to specify the
+          name to use.
+        </para>
+        <para>
+          For interfaces where this annotation is not specified, the
+          name used is the D-Bus interface name stripped with the
+          prefix given with <option>--strip-prefix</option> and with
+          the dots removed and initial characters capitalized. For
+          example the D-Bus interface
+          <literal>com.acme.Coyote</literal> the name used is
+          <type>ComAcmeCoyote</type>. For the D-Bus interface
+          <literal>org.project.Bar.Frobnicator</literal> with
+          <option>--strip-prefix</option>
+          <literal>org.project.</literal>, the name used is
+          <type>BarFrobnicator</type>.
+        </para>
+        <para>
+          For methods, signals and properties the name used is
+          calculated by transforming
+          <literal>NameGivenThisWay</literal> into
+          <literal>name_given_this_way</literal>, e.g. roughly
+          converting from camel-case to lower-case with underscores
+          using certain heuristics.
         </para>
       </listitem>
     </varlistentry>