Commit b6de2df1 authored by Stef Walter's avatar Stef Walter Committed by Matthias Clasen

Fix up all documentation warnings and complete documentation

https://bugs.freedesktop.org/show_bug.cgi?id=63880
parent ef858b4b
......@@ -8,6 +8,7 @@
*.la
*.lo
*.pc
*.stamp
*.typelib
*.vapi
*~
......@@ -27,6 +28,7 @@ Makefile.in
/config.sub
/configure
/depcomp
/gtk-doc.make
/install-sh
/libtool
/ltmain.sh
......@@ -41,6 +43,16 @@ Makefile.in
/doc/dbus/AccountsService.html
/doc/dbus/org.freedesktop.Accounts.User.ref.xml
/doc/dbus/org.freedesktop.Accounts.ref.xml
/doc/libaccountsservice/html/
/doc/libaccountsservice/xml
/doc/libaccountsservice/*decl*.txt
/doc/libaccountsservice/*-unused.txt
/doc/libaccountsservice/*-undocumented.txt
/doc/libaccountsservice/*.args
/doc/libaccountsservice/*.hierarchy
/doc/libaccountsservice/*.interfaces
/doc/libaccountsservice/*.prerequisites
/doc/libaccountsservice/*.signals
/m4/libtool.m4
/m4/ltoptions.m4
......
......@@ -22,3 +22,7 @@ GTKDOC_CFLAGS=-I$(top_srcdir)/src/libaccountsservice
GTKDOC_LIBS=$(top_builddir)/src/libaccountsservice/libaccountsservice.la
include $(top_srcdir)/gtk-doc.make
CLEANFILES += \
*-decl*.txt \
$(NULL)
......@@ -19,4 +19,8 @@
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<xi:include href="xml/annotation-glossary.xml">
<xi:fallback />
</xi:include>
</book>
<SECTION>
<FILE>act-user</FILE>
ActUser
ActUserAccountType
ActUserPasswordMode
act_user_collate
act_user_get_account_type
act_user_get_automatic_login
act_user_get_email
act_user_get_home_dir
act_user_get_icon_file
act_user_get_language
act_user_get_location
act_user_get_locked
act_user_get_login_frequency
act_user_get_login_history
act_user_get_login_time
act_user_get_num_sessions
act_user_get_object_path
act_user_get_password_hint
act_user_get_password_mode
act_user_get_primary_session_id
act_user_get_real_name
act_user_get_shell
act_user_get_uid
act_user_get_user_name
act_user_get_x_session
act_user_is_loaded
act_user_is_local_account
act_user_is_logged_in
act_user_is_system_account
act_user_set_account_type
act_user_set_automatic_login
act_user_set_email
act_user_set_icon_file
act_user_set_language
act_user_set_location
act_user_set_locked
act_user_set_password
act_user_set_password_mode
act_user_set_real_name
act_user_set_user_name
act_user_set_x_session
<SUBSECTION Standard>
ActUserClass
ACT_IS_USER
ACT_TYPE_USER
ACT_USER
act_user_get_type
</SECTION>
<SECTION>
<FILE>act-user-manager</FILE>
ACT_USER_MANAGER_ERROR
ActUserManager
ActUserManagerError
act_user_manager_activate_user_session
act_user_manager_cache_user
act_user_manager_cache_user_async
act_user_manager_cache_user_finish
act_user_manager_can_switch
act_user_manager_create_user
act_user_manager_create_user_async
act_user_manager_create_user_finish
act_user_manager_delete_user
act_user_manager_delete_user_async
act_user_manager_delete_user_finish
act_user_manager_get_default
act_user_manager_get_user
act_user_manager_get_user_by_id
act_user_manager_goto_login_session
act_user_manager_list_users
act_user_manager_no_service
act_user_manager_uncache_user
<SUBSECTION Standard>
ActUserManagerClass
ACT_IS_USER_MANAGER
ACT_IS_USER_MANAGER_CLASS
ACT_TYPE_USER_MANAGER
ACT_USER_MANAGER
ACT_USER_MANAGER_CLASS
ACT_USER_MANAGER_GET_CLASS
ActUserManagerPrivate
act_user_manager_get_type
act_user_manager_error_quark
</SECTION>
<SECTION>
<FILE>AccountsUser</FILE>
</SECTION>
<SECTION>
<FILE>AccountsAccounts</FILE>
</SECTION>
<SECTION>
<FILE>ConsoleKitSeat</FILE>
</SECTION>
<SECTION>
<FILE>ConsoleKitSession</FILE>
</SECTION>
<SECTION>
<FILE>ConsoleKitManager</FILE>
</SECTION>
\ No newline at end of file
act_user_get_type
act_user_manager_get_type
......@@ -67,6 +67,29 @@
* can be obtained by act_user_manager_get_default().
*/
/**
* ActUserManager:
*
* A user manager object.
*/
/**
* ACT_USER_MANAGER_ERROR:
*
* The GError domain for #ActUserManagerError errors
*/
/**
* ActUserManagerError:
* @ACT_USER_MANAGER_ERROR_FAILED: Generic failure
* @ACT_USER_MANAGER_ERROR_USER_EXISTS: The user already exists
* @ACT_USER_MANAGER_ERROR_USER_DOES_NOT_EXIST: The user does not exist
* @ACT_USER_MANAGER_ERROR_PERMISSION_DENIED: Permission denied
* @ACT_USER_MANAGER_ERROR_NOT_SUPPORTED: Operation not supported
*
* Various error codes returned by the accounts service.
*/
#define ACT_USER_MANAGER_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), ACT_TYPE_USER_MANAGER, ActUserManagerPrivate))
#define CK_NAME "org.freedesktop.ConsoleKit"
......@@ -402,6 +425,14 @@ session_is_login_window (ActUserManager *manager,
return _ck_session_is_login_window (manager, session_id);
}
/**
* act_user_manager_goto_login_session:
* @manager: the user manager
*
* Switch the display to the login manager.
*
* Returns: whether successful or not
*/
gboolean
act_user_manager_goto_login_session (ActUserManager *manager)
{
......@@ -462,6 +493,14 @@ _can_activate_console_kit_sessions (ActUserManager *manager)
return can_activate_sessions;
}
/**
* act_user_manager_can_switch:
* @manager: the user manager
*
* Check whether the user can switch to another session.
*
* Returns: whether we can switch to another session
*/
gboolean
act_user_manager_can_switch (ActUserManager *manager)
{
......@@ -487,6 +526,15 @@ act_user_manager_can_switch (ActUserManager *manager)
return _can_activate_console_kit_sessions (manager);
}
/**
* act_user_manager_activate_user_session:
* @manager: the user manager
* @user: the user to activate
*
* Activate the session for a given user.
*
* Returns: whether successfully activated
*/
gboolean
act_user_manager_activate_user_session (ActUserManager *manager,
ActUser *user)
......@@ -2482,31 +2530,36 @@ act_user_manager_class_init (ActUserManagerClass *klass)
g_object_class_install_property (object_class,
PROP_IS_LOADED,
g_param_spec_boolean ("is-loaded",
NULL,
NULL,
"Is loaded",
"Determines whether or not the manager object is loaded and ready to read from.",
FALSE,
G_PARAM_READABLE));
g_object_class_install_property (object_class,
PROP_HAS_MULTIPLE_USERS,
g_param_spec_boolean ("has-multiple-users",
NULL,
NULL,
"Has multiple users",
"Whether more than one normal user is present",
FALSE,
G_PARAM_READABLE));
g_object_class_install_property (object_class,
PROP_INCLUDE_USERNAMES_LIST,
g_param_spec_pointer ("include-usernames-list",
NULL,
NULL,
"Include usernames list",
"Usernames who are specifically included",
G_PARAM_READWRITE));
g_object_class_install_property (object_class,
PROP_EXCLUDE_USERNAMES_LIST,
g_param_spec_pointer ("exclude-usernames-list",
NULL,
NULL,
"Exclude usernames list",
"Usernames who are specifically excluded",
G_PARAM_READWRITE));
/**
* ActUserManager::user-added:
*
* Emitted when a user is added to the user manager.
*/
signals [USER_ADDED] =
g_signal_new ("user-added",
G_TYPE_FROM_CLASS (klass),
......@@ -2515,6 +2568,11 @@ act_user_manager_class_init (ActUserManagerClass *klass)
NULL, NULL,
g_cclosure_marshal_VOID__OBJECT,
G_TYPE_NONE, 1, ACT_TYPE_USER);
/**
* ActUserManager::user-removed:
*
* Emitted when a user is removed from the user manager.
*/
signals [USER_REMOVED] =
g_signal_new ("user-removed",
G_TYPE_FROM_CLASS (klass),
......@@ -2523,6 +2581,11 @@ act_user_manager_class_init (ActUserManagerClass *klass)
NULL, NULL,
g_cclosure_marshal_VOID__OBJECT,
G_TYPE_NONE, 1, ACT_TYPE_USER);
/**
* ActUserManager::user-is-logged-in-changed:
*
* One of the users has logged in or out.
*/
signals [USER_IS_LOGGED_IN_CHANGED] =
g_signal_new ("user-is-logged-in-changed",
G_TYPE_FROM_CLASS (klass),
......@@ -2531,6 +2594,11 @@ act_user_manager_class_init (ActUserManagerClass *klass)
NULL, NULL,
g_cclosure_marshal_VOID__OBJECT,
G_TYPE_NONE, 1, ACT_TYPE_USER);
/**
* ActUserManager::user-changed:
*
* One of the users has changed
*/
signals [USER_CHANGED] =
g_signal_new ("user-changed",
G_TYPE_FROM_CLASS (klass),
......@@ -2767,6 +2835,8 @@ act_user_manager_get_default (void)
* act_user_manager_no_service:
* @manager: a #ActUserManager
*
* Check whether or not the accounts service is running.
*
* Returns: whether or not accounts service is running
*/
gboolean
......@@ -2846,7 +2916,7 @@ act_user_manager_async_complete_handler (GObject *source,
* %NULL to ignore
* @callback: (scope async): a #GAsyncReadyCallback to call
* when the request is satisfied
* @user_data (closure): the data to pass to @callback
* @user_data: (closure): the data to pass to @callback
*
* Asynchronously creates a user account on the system.
*
......@@ -2984,7 +3054,7 @@ act_user_manager_cache_user (ActUserManager *manager,
* %NULL to ignore
* @callback: (scope async): a #GAsyncReadyCallback to call
* when the request is satisfied
* @user_data (closure): the data to pass to @callback
* @user_data: (closure): the data to pass to @callback
*
* Asynchronously caches a user account so it shows up via
* act_user_manager_list_users().
......@@ -3151,7 +3221,7 @@ act_user_manager_delete_user (ActUserManager *manager,
* %NULL to ignore
* @callback: (scope async): a #GAsyncReadyCallback to call
* when the request is satisfied
* @user_data (closure): the data to pass to @callback
* @user_data: (closure): the data to pass to @callback
*
* Asynchronously deletes a user account from the system.
*
......
......@@ -36,16 +36,18 @@ G_BEGIN_DECLS
#define ACT_USER_MANAGER_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), ACT_TYPE_USER_MANAGER, ActUserManagerClass))
typedef struct ActUserManagerPrivate ActUserManagerPrivate;
typedef struct ActUserManager ActUserManager;
typedef struct ActUserManagerClass ActUserManagerClass;
typedef struct _ActUserManager ActUserManager;
typedef struct _ActUserManagerClass ActUserManagerClass;
struct ActUserManager
struct _ActUserManager
{
GObject parent;
/*< private >*/
ActUserManagerPrivate *priv;
};
struct ActUserManagerClass
struct _ActUserManagerClass
{
GObjectClass parent_class;
......
......@@ -41,6 +41,29 @@
* An ActUser object represents a user account on the system.
*/
/**
* ActUser:
*
* Represents a user account on the system.
*/
/**
* ActUserAccountType:
* @ACT_USER_ACCOUNT_TYPE_STANDARD: Normal non-administrative user
* @ACT_USER_ACCOUNT_TYPE_ADMINISTRATOR: Administrative user
*
* Type of user account
*/
/**
* ActUserPasswordMode:
* @ACT_USER_PASSWORD_MODE_REGULAR: Password set normally
* @ACT_USER_PASSWORD_MODE_SET_AT_LOGIN: Password will be chosen at next login
* @ACT_USER_PASSWORD_MODE_NONE: No password set
*
* Mode for setting the user's password.
*/
#define ACT_USER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ACT_TYPE_USER, ActUserClass))
#define ACT_IS_USER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ACT_TYPE_USER))
#define ACT_USER_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), ACT_TYPE_USER, ActUserClass))
......@@ -179,6 +202,14 @@ _act_user_remove_session (ActUser *user,
}
}
/**
* act_user_get_num_sessions:
* @user: a user
*
* Get the number of current sessions for a user.
*
* Returns: the number of sessions
*/
guint
act_user_get_num_sessions (ActUser *user)
{
......@@ -403,8 +434,8 @@ act_user_class_init (ActUserClass *class)
g_object_class_install_property (gobject_class,
PROP_IS_LOADED,
g_param_spec_boolean ("is-loaded",
NULL,
NULL,
"Is loaded",
"Determines whether or not the user object is loaded and ready to read from.",
FALSE,
G_PARAM_READABLE));
g_object_class_install_property (gobject_class,
......@@ -440,6 +471,11 @@ act_user_class_init (ActUserClass *class)
G_PARAM_READABLE));
/**
* ActUser::changed:
*
* Emitted when the user accounts changes in some way.
*/
signals [CHANGED] =
g_signal_new ("changed",
G_TYPE_FROM_CLASS (class),
......@@ -448,6 +484,11 @@ act_user_class_init (ActUserClass *class)
NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
/**
* ActUser::sessions-changed:
*
* Emitted when the list of sessions for this user changes.
*/
signals [SESSIONS_CHANGED] =
g_signal_new ("sessions-changed",
G_TYPE_FROM_CLASS (class),
......@@ -748,6 +789,16 @@ act_user_get_login_history (ActUser *user) {
return user->login_history;
}
/**
* act_user_collate:
* @user1: a user
* @user2: a user
*
* Organize the user by login frequency and names.
*
* Returns: negative if @user1 is before @user2, zero if equal
* or positive if @user1 is after @user2
*/
int
act_user_collate (ActUser *user1,
ActUser *user2)
......@@ -1774,6 +1825,7 @@ act_user_set_locked (ActUser *user,
/**
* act_user_set_automatic_login:
* @user: the user object to alter
* @enabled: whether or not to autologin for user.
*
* If enabled is set to %TRUE then this user will automatically be logged in
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment