summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDavid Zeuthen <davidz@redhat.com>2009-02-01 16:18:25 -0500
committerDavid Zeuthen <davidz@redhat.com>2009-02-01 16:18:25 -0500
commit1581cff19de827dec8234a8ca5d040874a3dca89 (patch)
tree5c011606224f5c6aec47c8158e860787c6874c6f /docs
parent5977ce758ceb745bdc4cef42b56b9cf2b0c8d14e (diff)
add API docs for PolkitAuthority
Also slightly rearrange the doc layout.
Diffstat (limited to 'docs')
-rw-r--r--docs/polkit/Makefile.am7
-rw-r--r--docs/polkit/polkit-docs.xml3
-rw-r--r--docs/polkit/polkit-sections.txt262
-rw-r--r--docs/polkit/polkit.types19
4 files changed, 287 insertions, 4 deletions
diff --git a/docs/polkit/Makefile.am b/docs/polkit/Makefile.am
index e74fb5c..3660163 100644
--- a/docs/polkit/Makefile.am
+++ b/docs/polkit/Makefile.am
@@ -66,14 +66,17 @@ endif
CLEANFILES += *~ \
polkit-scan.* \
- polkit.* \
+ polkit.args \
+ polkit.hierarchy \
+ polkit.interfaces \
+ polkit.prerequisites \
+ polkit.signals \
*.bak \
polkit-decl-list.txt \
polkit-decl.txt \
polkit-overrides.txt \
polkit-undeclared.txt \
polkit-undocumented.txt \
- polkit-sections.txt \
*.stamp \
-rf html xml \
$(NULL)
diff --git a/docs/polkit/polkit-docs.xml b/docs/polkit/polkit-docs.xml
index d486dbb..5488f75 100644
--- a/docs/polkit/polkit-docs.xml
+++ b/docs/polkit/polkit-docs.xml
@@ -59,10 +59,9 @@
<title>Core API Reference</title>
<xi:include href="xml/polkitauthority.xml"/>
<xi:include href="xml/polkiterror.xml"/>
- <xi:include href="xml/polkitauthorizationresult.xml"/>
<xi:include href="xml/polkitactiondescription.xml"/>
+ <xi:include href="xml/polkitauthoritymanager.xml"/>
<xi:include href="xml/polkitauthorization.xml"/>
- <xi:include href="xml/polkitimplicitauthorization.xml"/>
<chapter id="subjects">
<title>Subjects</title>
<xi:include href="xml/polkitsubject.xml"/>
diff --git a/docs/polkit/polkit-sections.txt b/docs/polkit/polkit-sections.txt
new file mode 100644
index 0000000..2094a3f
--- /dev/null
+++ b/docs/polkit/polkit-sections.txt
@@ -0,0 +1,262 @@
+<SECTION>
+<FILE>polkitunixuser</FILE>
+PolkitUnixUser
+polkit_unix_user_new
+polkit_unix_user_new_for_name
+polkit_unix_user_get_uid
+polkit_unix_user_set_uid
+<SUBSECTION Standard>
+PolkitUnixUserClass
+POLKIT_UNIX_USER
+POLKIT_IS_UNIX_USER
+POLKIT_TYPE_UNIX_USER
+polkit_unix_user_get_type
+POLKIT_UNIX_USER_CLASS
+POLKIT_IS_UNIX_USER_CLASS
+POLKIT_UNIX_USER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>polkitauthoritymanager</FILE>
+PolkitAuthorityManager
+polkit_authority_manager_get
+polkit_authority_manager_enumerate_users_sync
+polkit_authority_manager_enumerate_groups_sync
+polkit_authority_manager_enumerate_authorizations_sync
+polkit_authority_manager_add_authorization_sync
+polkit_authority_manager_remove_authorization_sync
+polkit_authority_manager_enumerate_users
+polkit_authority_manager_enumerate_users_finish
+polkit_authority_manager_enumerate_groups
+polkit_authority_manager_enumerate_groups_finish
+polkit_authority_manager_enumerate_authorizations
+polkit_authority_manager_enumerate_authorizations_finish
+polkit_authority_manager_add_authorization
+polkit_authority_manager_add_authorization_finish
+polkit_authority_manager_remove_authorization
+polkit_authority_manager_remove_authorization_finish
+<SUBSECTION Standard>
+PolkitAuthorityManagerClass
+POLKIT_AUTHORITY_MANAGER
+POLKIT_IS_AUTHORITY_MANAGER
+POLKIT_TYPE_AUTHORITY_MANAGER
+polkit_authority_manager_get_type
+POLKIT_AUTHORITY_MANAGER_CLASS
+POLKIT_IS_AUTHORITY_MANAGER_CLASS
+POLKIT_AUTHORITY_MANAGER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>polkitauthority</FILE>
+PolkitAuthority
+PolkitCheckAuthorizationFlags
+PolkitAuthorizationResult
+polkit_authority_get
+polkit_authority_enumerate_actions_sync
+polkit_authority_check_authorization_sync
+polkit_authority_register_authentication_agent_sync
+polkit_authority_unregister_authentication_agent_sync
+polkit_authority_authentication_agent_response_sync
+polkit_authority_enumerate_actions
+polkit_authority_enumerate_actions_finish
+polkit_authority_check_authorization
+polkit_authority_check_authorization_finish
+polkit_authority_register_authentication_agent
+polkit_authority_register_authentication_agent_finish
+polkit_authority_unregister_authentication_agent
+polkit_authority_unregister_authentication_agent_finish
+polkit_authority_authentication_agent_response
+polkit_authority_authentication_agent_response_finish
+<SUBSECTION Standard>
+PolkitAuthorityClass
+POLKIT_AUTHORITY
+POLKIT_IS_AUTHORITY
+POLKIT_TYPE_AUTHORITY
+polkit_authority_get_type
+POLKIT_AUTHORITY_CLASS
+POLKIT_IS_AUTHORITY_CLASS
+POLKIT_AUTHORITY_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>polkitsystembusname</FILE>
+PolkitSystemBusName
+polkit_system_bus_name_new
+polkit_system_bus_name_get_name
+polkit_system_bus_name_set_name
+<SUBSECTION Standard>
+PolkitSystemBusNameClass
+POLKIT_SYSTEM_BUS_NAME
+POLKIT_IS_SYSTEM_BUS_NAME
+POLKIT_TYPE_SYSTEM_BUS_NAME
+polkit_system_bus_name_get_type
+POLKIT_SYSTEM_BUS_NAME_CLASS
+POLKIT_IS_SYSTEM_BUS_NAME_CLASS
+POLKIT_SYSTEM_BUS_NAME_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>polkitunixgroup</FILE>
+PolkitUnixGroup
+polkit_unix_group_new
+polkit_unix_group_new_for_name
+polkit_unix_group_get_gid
+polkit_unix_group_set_gid
+<SUBSECTION Standard>
+PolkitUnixGroupClass
+POLKIT_UNIX_GROUP
+POLKIT_IS_UNIX_GROUP
+POLKIT_TYPE_UNIX_GROUP
+polkit_unix_group_get_type
+POLKIT_UNIX_GROUP_CLASS
+POLKIT_IS_UNIX_GROUP_CLASS
+POLKIT_UNIX_GROUP_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>polkitauthorization</FILE>
+PolkitAuthorization
+polkit_authorization_new
+polkit_authorization_get_action_id
+polkit_authorization_get_subject
+polkit_authorization_get_is_negative
+<SUBSECTION Standard>
+PolkitAuthorizationClass
+POLKIT_AUTHORIZATION
+POLKIT_IS_AUTHORIZATION
+POLKIT_TYPE_AUTHORIZATION
+polkit_authorization_get_type
+POLKIT_AUTHORIZATION_CLASS
+POLKIT_IS_AUTHORIZATION_CLASS
+POLKIT_AUTHORIZATION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>polkitunixsession</FILE>
+PolkitUnixSession
+polkit_unix_session_new
+polkit_unix_session_get_session_id
+polkit_unix_session_set_session_id
+<SUBSECTION Standard>
+PolkitUnixSessionClass
+POLKIT_UNIX_SESSION
+POLKIT_IS_UNIX_SESSION
+POLKIT_TYPE_UNIX_SESSION
+polkit_unix_session_get_type
+POLKIT_UNIX_SESSION_CLASS
+POLKIT_IS_UNIX_SESSION_CLASS
+POLKIT_UNIX_SESSION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>polkitunixprocess</FILE>
+PolkitUnixProcess
+polkit_unix_process_new
+polkit_unix_process_new_full
+polkit_unix_process_get_pid
+polkit_unix_process_get_start_time
+polkit_unix_process_set_pid
+<SUBSECTION Standard>
+PolkitUnixProcessClass
+POLKIT_UNIX_PROCESS
+POLKIT_IS_UNIX_PROCESS
+POLKIT_TYPE_UNIX_PROCESS
+polkit_unix_process_get_type
+POLKIT_UNIX_PROCESS_CLASS
+POLKIT_IS_UNIX_PROCESS_CLASS
+POLKIT_UNIX_PROCESS_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>polkitidentity</FILE>
+PolkitIdentity
+PolkitIdentityIface
+polkit_identity_hash
+polkit_identity_equal
+polkit_identity_to_string
+polkit_identity_from_string
+<SUBSECTION Standard>
+POLKIT_IDENTITY
+POLKIT_IS_IDENTITY
+POLKIT_TYPE_IDENTITY
+polkit_identity_get_type
+POLKIT_IDENTITY_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>polkitsubject</FILE>
+PolkitSubject
+PolkitSubjectIface
+polkit_subject_hash
+polkit_subject_equal
+polkit_subject_to_string
+polkit_subject_from_string
+<SUBSECTION Standard>
+POLKIT_SUBJECT
+POLKIT_IS_SUBJECT
+POLKIT_TYPE_SUBJECT
+polkit_subject_get_type
+POLKIT_SUBJECT_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>polkitactiondescription</FILE>
+PolkitActionDescription
+PolkitImplicitAuthorization
+polkit_action_description_get_action_id
+polkit_action_description_get_description
+polkit_action_description_get_message
+polkit_action_description_get_vendor_name
+polkit_action_description_get_vendor_url
+polkit_action_description_get_icon
+polkit_action_description_get_implicit_any
+polkit_action_description_get_implicit_inactive
+polkit_action_description_get_implicit_active
+polkit_action_description_get_annotation
+<SUBSECTION Standard>
+PolkitActionDescriptionClass
+POLKIT_ACTION_DESCRIPTION
+POLKIT_IS_ACTION_DESCRIPTION
+POLKIT_TYPE_ACTION_DESCRIPTION
+polkit_action_description_get_type
+POLKIT_ACTION_DESCRIPTION_CLASS
+POLKIT_IS_ACTION_DESCRIPTION_CLASS
+POLKIT_ACTION_DESCRIPTION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>polkitcheckauthorizationflags</FILE>
+POLKIT_TYPE_CHECK_AUTHORIZATION_FLAGS
+PolkitCheckAuthorizationFlags
+<SUBSECTION Standard>
+polkit_check_authorization_flags_get_type
+</SECTION>
+
+<SECTION>
+<FILE>polkitimplicitauthorization</FILE>
+POLKIT_TYPE_IMPLICIT_AUTHORIZATION
+PolkitImplicitAuthorization
+polkit_implicit_authorization_to_string
+polkit_implicit_authorization_from_string
+<SUBSECTION Standard>
+polkit_implicit_authorization_get_type
+</SECTION>
+
+<SECTION>
+<FILE>polkiterror</FILE>
+POLKIT_ERROR
+POLKIT_TYPE_ERROR
+PolkitError
+<SUBSECTION Standard>
+polkit_error_quark
+polkit_error_get_type
+</SECTION>
+
+<SECTION>
+<FILE>polkitauthorizationresult</FILE>
+POLKIT_TYPE_AUTHORIZATION_RESULT
+PolkitAuthorizationResult
+<SUBSECTION Standard>
+polkit_authorization_result_get_type
+</SECTION>
+
diff --git a/docs/polkit/polkit.types b/docs/polkit/polkit.types
new file mode 100644
index 0000000..c47d206
--- /dev/null
+++ b/docs/polkit/polkit.types
@@ -0,0 +1,19 @@
+polkit_authority_get_type
+polkit_authority_manager_get_type
+
+polkit_authorization_get_type
+polkit_action_description_get_type
+
+polkit_check_authorization_flags_get_type
+polkit_implicit_authorization_get_type
+
+polkit_identity_get_type
+polkit_unix_user_get_type
+polkit_unix_group_get_type
+
+polkit_subject_get_type
+polkit_unix_process_get_type
+polkit_unix_session_get_type
+polkit_system_bus_name_get_type
+polkit_error_get_type
+polkit_authorization_result_get_type