PolicyKit: Branch 'master'

Danny Kukawka dkukawka at kemper.freedesktop.org
Thu Aug 23 05:06:16 PDT 2007


 polkit-grant/polkit-grant.c |    1 -
 polkit-grant/polkit-grant.h |   24 ++++++++++++------------
 polkit/polkit-context.h     |    8 ++++----
 3 files changed, 16 insertions(+), 17 deletions(-)

New commits:
diff-tree 0d69cdc59f51fda93c857171b69ac8f3fe46b745 (from 9924987f324953fa9e58b937dfedc1cc06ece0b3)
Author: Danny Kukawka <danny.kukawka at web.de>
Date:   Thu Aug 23 14:05:34 2007 +0200

    fixed code documentation issues
    
    Fixed code documentation issues:
     * s/<programlisting>/@code/
     * removed @void: from polkit_grant_new()

diff --git a/polkit-grant/polkit-grant.c b/polkit-grant/polkit-grant.c
index 73ecbda..5976f51 100644
--- a/polkit-grant/polkit-grant.c
+++ b/polkit-grant/polkit-grant.c
@@ -83,7 +83,6 @@ struct PolKitGrant
 
 /**
  * polkit_grant_new:
- * @void: 
  * 
  * Creates a #PolKitGrant object.
  * 
diff --git a/polkit-grant/polkit-grant.h b/polkit-grant/polkit-grant.h
index e619625..d6e12c9 100644
--- a/polkit-grant/polkit-grant.h
+++ b/polkit-grant/polkit-grant.h
@@ -144,7 +144,7 @@ typedef void (*PolKitGrantConversationTe
  * Basically, this callback enables a program to provide an user
  * interface like this:
  *
- * <programlisting>
+ * @code 
  * +------------------------------------------------------------+
  * | You need to authenticate to access the volume 'Frobnicator |
  * | Adventures Vol 2'                                          |
@@ -157,7 +157,7 @@ typedef void (*PolKitGrantConversationTe
  * |                                                            |
  * |                                    [Cancel] [Authenticate] |
  * +------------------------------------------------------------+
- * </programlisting>
+ * @endcode
  *
  * This dialog assumes that @grant_type passed was
  * #POLKIT_RESULT_ONLY_VIA_SELF_AUTH_KEEP_ALWAYS. By ticking the
@@ -170,7 +170,7 @@ typedef void (*PolKitGrantConversationTe
  * #POLKIT_RESULT_ONLY_VIA_SELF_AUTH_KEEP_SESSION. Then the dialog
  * should look like this:
  *
- * <programlisting>
+ * @code
  * +------------------------------------------------------------+
  * | You need to authenticate to access the volume 'Frobnicator |
  * | Adventures Vol 2'                                          |
@@ -181,13 +181,13 @@ typedef void (*PolKitGrantConversationTe
  * |                                                            |
  * |                                    [Cancel] [Authenticate] |
  * +------------------------------------------------------------+
- * </programlisting>
+ * @endcode
  *
  * Finally, if the @grant_type value passed is
  * e.g. #POLKIT_RESULT_ONLY_VIA_SELF_AUTH, there are no options to
  * click.:
  *
- * <programlisting>
+ * @code 
  * +------------------------------------------------------------+
  * | You need to authenticate to access the volume 'Frobnicator |
  * | Adventures Vol 2'                                          |
@@ -196,7 +196,7 @@ typedef void (*PolKitGrantConversationTe
  * |                                                            |
  * |                                    [Cancel] [Authenticate] |
  * +------------------------------------------------------------+
- * </programlisting>
+ * @endcode
  *
  * Of course, these examples also applies to
  * #POLKIT_RESULT_ONLY_VIA_ADMIN_AUTH and friends.
@@ -239,7 +239,7 @@ typedef void (*PolKitGrantDone) (PolKitG
  *
  * For glib mainloop, the function will typically look like this:
  *
- * <programlisting>
+ * @code
  * static void
  * child_watch_func (GPid pid,
  *                   gint status,
@@ -254,7 +254,7 @@ typedef void (*PolKitGrantDone) (PolKitG
  * {
  *         return g_child_watch_add (pid, child_watch_func, polkit_grant);
  * }
- * </programlisting>
+ * @endcode
  *
  * Returns: 0 if the watch couldn't be set up; otherwise an unique
  * identifier for the watch.
@@ -274,7 +274,7 @@ typedef int (*PolKitGrantAddChildWatch) 
  *
  * For glib mainloop, the function will typically look like this:
  *
- * <programlisting>
+ * @code 
  * static gboolean
  * io_watch_have_data (GIOChannel *channel, GIOCondition condition, gpointer user_data)
  * {
@@ -302,7 +302,7 @@ typedef int (*PolKitGrantAddChildWatch) 
  * out:
  *         return id;
  * }
- * </programlisting>
+ * @endcode
  *
  * Returns: 0 if the watch couldn't be set up; otherwise an unique
  * identifier for the watch.
@@ -322,13 +322,13 @@ typedef int (*PolKitGrantAddIOWatch) (Po
  *
  * For glib mainloop, the function will typically look like this:
  *
- * <programlisting>
+ * @code
  * static void 
  * remove_watch (PolKitGrant *polkit_auth, int watch_id)
  * {
  *         g_source_remove (watch_id);
  * }
- * </programlisting>
+ * @endcode
  *
  **/
 typedef void (*PolKitGrantRemoveWatch) (PolKitGrant *polkit_grant,
diff --git a/polkit/polkit-context.h b/polkit/polkit-context.h
index b75f5a3..e46d822 100644
--- a/polkit/polkit-context.h
+++ b/polkit/polkit-context.h
@@ -80,7 +80,7 @@ typedef void (*PolKitContextConfigChange
  *
  * For glib mainloop, the function will typically look like this:
  *
- * <programlisting>
+ * @code
  * static gboolean
  * io_watch_have_data (GIOChannel *channel, GIOCondition condition, gpointer user_data)
  * {
@@ -108,7 +108,7 @@ typedef void (*PolKitContextConfigChange
  * out:
  *         return id;
  * }
- * </programlisting>
+ * @endcode
  *
  * Returns: 0 if the watch couldn't be set up; otherwise an unique
  * identifier for the watch.
@@ -126,13 +126,13 @@ typedef int (*PolKitContextAddIOWatch) (
  *
  * For the glib mainloop, the function will typically look like this:
  *
- * <programlisting>
+ * @code
  * static void 
  * io_remove_watch (PolKitContext *pk_context, int watch_id)
  * {
  *         g_source_remove (watch_id);
  * }
- * </programlisting>
+ * @endcode
  *
  **/
 typedef void (*PolKitContextRemoveIOWatch) (PolKitContext *pk_context, int watch_id);


More information about the hal-commit mailing list