fix up polkitagent docs
authorDavid Zeuthen <davidz@redhat.com>
Sat, 31 Jan 2009 21:17:27 +0000 (16:17 -0500)
committerDavid Zeuthen <davidz@redhat.com>
Sat, 31 Jan 2009 21:17:27 +0000 (16:17 -0500)
docs/polkitagent/Makefile.am
docs/polkitagent/polkitagent-sections.txt
docs/polkitagent/polkitagent.types [new file with mode: 0644]
src/polkitagent/polkitagentlistener.c
src/polkitagent/polkitagentlistener.h
src/polkitagent/polkitagentsession.h

index 75a134a..4ef4787 100644 (file)
@@ -59,11 +59,14 @@ HTML_IMAGES =                               \
 # Extra options to supply to gtkdoc-fixref
 FIXXREF_OPTIONS=
 
-MAINTAINERCLEANFILES =         \
-       *~                      \
-       Makefile.in             \
-       polkitagent.types       \
-       polkit-*.txt            \
+MAINTAINERCLEANFILES =                         \
+       *~                                      \
+       Makefile.in                             \
+       polkitagent-decl-list.txt               \
+       polkitagent-decl.txt                    \
+       polkitagent-overrides.txt               \
+       polkitagent-undeclared.txt              \
+       polkitagent-undocumented.txt            \
        $(NULL)
 
 if ENABLE_GTK_DOC
@@ -74,7 +77,11 @@ endif
 
 CLEANFILES +=   *~                                     \
                polkitagent-scan.*                      \
-               polkitagent.*                           \
+               polkitagent.args                        \
+               polkitagent.hierarchy                   \
+               polkitagent.interfaces                  \
+               polkitagent.prerequisites               \
+               polkitagent.signals                     \
                *.bak                                   \
                polkitagent-decl-list.txt               \
                polkitagent-decl.txt                    \
index 38c1de6..685be44 100644 (file)
@@ -1,5 +1,6 @@
 <SECTION>
 <FILE>polkitagentsession</FILE>
+<TITLE>PolkitAgentSession</TITLE>
 PolkitAgentSession
 polkit_agent_session_new
 polkit_agent_session_initiate
diff --git a/docs/polkitagent/polkitagent.types b/docs/polkitagent/polkitagent.types
new file mode 100644 (file)
index 0000000..dec96b8
--- /dev/null
@@ -0,0 +1,2 @@
+polkit_agent_session_get_type
+polkit_agent_listener_get_type
index 15be7db..313d38f 100644 (file)
@@ -31,7 +31,7 @@
  * @title: PolkitAgentListener
  * @short_description: Abstract base class for Authentication Agents
  *
- * The #PolkitAgentListener is an abstract base class used for implementing authentication
+ * #PolkitAgentListener is an abstract base class used for implementing authentication
  * agents. To implement an authentication agent, simply subclass #PolkitAgentListener and
  * implement the @initiate_authentication and @initiate_authentication_finish VFuncs.
  *
index fae6c96..b50e922 100644 (file)
@@ -34,9 +34,7 @@ G_BEGIN_DECLS
 #define POLKIT_AGENT_IS_LISTENER(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), POLKIT_AGENT_TYPE_LISTENER))
 #define POLKIT_AGENT_IS_LISTENER_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), POLKIT_AGENT_TYPE_LISTENER))
 
-#if 0
-typedef struct _PolkitAgentListener PolkitAgentListener;
-#endif
+struct _PolkitAgentListenerClass;
 typedef struct _PolkitAgentListenerClass PolkitAgentListenerClass;
 
 /**
@@ -63,17 +61,17 @@ struct _PolkitAgentListenerClass
   GObjectClass parent_class;
 
   /* Vtable */
-  void (*initiate_authentication)  (PolkitAgentListener  *listener,
-                                    const gchar          *action_id,
-                                    const gchar          *cookie,
-                                    GList                *identities,
-                                    GCancellable         *cancellable,
-                                    GAsyncReadyCallback   callback,
-                                    gpointer              user_data);
+  void     (*initiate_authentication)        (PolkitAgentListener  *listener,
+                                              const gchar          *action_id,
+                                              const gchar          *cookie,
+                                              GList                *identities,
+                                              GCancellable         *cancellable,
+                                              GAsyncReadyCallback   callback,
+                                              gpointer              user_data);
 
-  gboolean (*initiate_authentication_finish)  (PolkitAgentListener  *listener,
-                                               GAsyncResult         *res,
-                                               GError              **error);
+  gboolean (*initiate_authentication_finish) (PolkitAgentListener  *listener,
+                                              GAsyncResult         *res,
+                                              GError              **error);
 
   /*< private >*/
   /* Padding for future expansion */
index a3863bf..acba074 100644 (file)
@@ -34,10 +34,7 @@ G_BEGIN_DECLS
 #define POLKIT_AGENT_IS_SESSION(o)         (G_TYPE_CHECK_INSTANCE_TYPE ((o), POLKIT_AGENT_TYPE_SESSION))
 #define POLKIT_AGENT_IS_SESSION_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), POLKIT_AGENT_TYPE_SESSION))
 
-
-#if 0
-typedef struct _PolkitAgentSession PolkitAgentSession;
-#endif
+struct _PolkitAgentSessionClass;
 typedef struct _PolkitAgentSessionClass PolkitAgentSessionClass;
 
 GType                polkit_agent_session_get_type    (void) G_GNUC_CONST;