chiark / gitweb /
doc: balance C indirections in function prototypes
authorJan Engelhardt <jengelh@inai.de>
Sun, 16 Feb 2014 12:55:27 +0000 (13:55 +0100)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Tue, 18 Feb 2014 00:03:07 +0000 (19:03 -0500)
Shift the asterisks in the documentation's prototypes such that they
are consistent among each other. Use the right side to match source code.

man/sd_bus_creds_get_pid.xml
man/sd_bus_creds_new_from_pid.xml
man/sd_bus_label_escape.xml
man/sd_bus_message_get_monotonic_usec.xml
man/sd_bus_new.xml
man/sd_bus_open_user.xml

index a35efef..0a9b5d0 100644 (file)
@@ -77,145 +77,145 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_pid</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>pid_t *<parameter>pid</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_pid_starttime</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>uint64_t *<parameter>usec</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_tid</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>pid_t *<parameter>tid</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_pid</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>uid_t *<parameter>uid</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_gid</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>gid_t *<parameter>gid</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_comm</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>comm</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_tid_comm</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>comm</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_exe</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>exe</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_cmdline</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>char ***<parameter>cmdline</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_cgroup</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>cgroup</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_unit</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>unit</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_user_unit</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>unit</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_slice</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>slice</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_session</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>slice</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_owner_uid</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>uid_t *<parameter>uid</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_has_effective_cap</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>int <parameter>capability</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_has_permitted_cap</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>int <parameter>capability</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_has_inheritable_cap</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>int <parameter>capability</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_has_bounding_cap</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>int <parameter>capability</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_selinux_context</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>context</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_audit_session_id</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>uint32_t *<parameter>sessionid</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_audit_login_uid</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>uid_t *<parameter>loginuid</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_unique_name</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>name</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_well_known_names</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>char ***<parameter>name</parameter></paramdef>
       </funcprototype>
 
index 9415dc7..5faee9e 100644 (file)
@@ -59,22 +59,22 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <funcdef>int <function>sd_bus_creds_new_from_pid</function></funcdef>
         <paramdef>pid_t <parameter>pid</parameter></paramdef>
         <paramdef>uint64_t <parameter>creds_mask</parameter></paramdef>
-        <paramdef>sd_bus_creds** <parameter>ret</parameter></paramdef>
+        <paramdef>sd_bus_creds **<parameter>ret</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>uint64_t <function>sd_bus_creds_get_mask</function></funcdef>
-        <paramdef>const sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>const sd_bus_creds *<parameter>c</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
-        <funcdef>sd_bus_creds<function>sd_bus_creds_ref</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <funcdef>sd_bus_creds *<function>sd_bus_creds_ref</function></funcdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
-        <funcdef>sd_bus_creds<function>sd_bus_creds_unref</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <funcdef>sd_bus_creds *<function>sd_bus_creds_unref</function></funcdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
       </funcprototype>
     </funcsynopsis>
 
index fb964ba..ef4b7e2 100644 (file)
@@ -54,13 +54,13 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
 
       <funcprototype>
-        <funcdef>char<function>sd_bus_label_escape</function></funcdef>
-        <paramdef>const char<parameter>s</parameter></paramdef>
+        <funcdef>char *<function>sd_bus_label_escape</function></funcdef>
+        <paramdef>const char *<parameter>s</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
-        <funcdef>char<function>sd_bus_label_unescape</function></funcdef>
-        <paramdef>const char<parameter>f</parameter></paramdef>
+        <funcdef>char *<function>sd_bus_label_unescape</function></funcdef>
+        <paramdef>const char *<parameter>f</parameter></paramdef>
       </funcprototype>
     </funcsynopsis>
   </refsynopsisdiv>
index b9437ff..e0ee909 100644 (file)
 
                         <funcprototype>
                                 <funcdef>int <function>sd_bus_message_get_monotonic_usec</function></funcdef>
-                                <paramdef>sd_bus_message<parameter>message</parameter></paramdef>
-                                <paramdef>uint64_t<parameter>usec</parameter></paramdef>
+                                <paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
+                                <paramdef>uint64_t *<parameter>usec</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_bus_message_get_realtime_usec</function></funcdef>
-                                <paramdef>sd_bus_message<parameter>message</parameter></paramdef>
-                                <paramdef>uint64_t<parameter>usec</parameter></paramdef>
+                                <paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
+                                <paramdef>uint64_t *<parameter>usec</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_bus_message_get_seqnum</function></funcdef>
-                                <paramdef>sd_bus_message<parameter>message</parameter></paramdef>
-                                <paramdef>uint64_t<parameter>seqnum</parameter></paramdef>
+                                <paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
+                                <paramdef>uint64_t *<parameter>seqnum</parameter></paramdef>
                         </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
index 573def7..4e43872 100644 (file)
@@ -56,17 +56,17 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
       <funcprototype>
         <funcdef>int <function>sd_bus_new</function></funcdef>
-        <paramdef>sd_bus** <parameter>bus</parameter></paramdef>
+        <paramdef>sd_bus **<parameter>bus</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
-        <funcdef>sd_bus<function>sd_bus_ref</function></funcdef>
-        <paramdef>sd_bus<parameter>bus</parameter></paramdef>
+        <funcdef>sd_bus *<function>sd_bus_ref</function></funcdef>
+        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
-        <funcdef>sd_bus<function>sd_bus_unref</function></funcdef>
-        <paramdef>sd_bus<parameter>bus</parameter></paramdef>
+        <funcdef>sd_bus *<function>sd_bus_unref</function></funcdef>
+        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
       </funcprototype>
     </funcsynopsis>
   </refsynopsisdiv>
index 22a4f61..9ddf2b8 100644 (file)
@@ -60,34 +60,34 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
       <funcprototype>
         <funcdef>int <function>sd_bus_open_user</function></funcdef>
-        <paramdef>sd_bus** <parameter>bus</parameter></paramdef>
+        <paramdef>sd_bus **<parameter>bus</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_open_system</function></funcdef>
-        <paramdef>sd_bus** <parameter>bus</parameter></paramdef>
+        <paramdef>sd_bus **<parameter>bus</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_open_system_remote</function></funcdef>
         <paramdef>const char *<parameter>host</parameter></paramdef>
-        <paramdef>sd_bus** <parameter>bus</parameter></paramdef>
+        <paramdef>sd_bus **<parameter>bus</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_open_system_container</function></funcdef>
         <paramdef>const char *<parameter>machine</parameter></paramdef>
-        <paramdef>sd_bus** <parameter>bus</parameter></paramdef>
+        <paramdef>sd_bus **<parameter>bus</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_default_user</function></funcdef>
-        <paramdef>sd_bus** <parameter>bus</parameter></paramdef>
+        <paramdef>sd_bus **<parameter>bus</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_default_system</function></funcdef>
-        <paramdef>sd_bus** <parameter>bus</parameter></paramdef>
+        <paramdef>sd_bus **<parameter>bus</parameter></paramdef>
       </funcprototype>
     </funcsynopsis>
   </refsynopsisdiv>