From 468548cb2d450576796bf04d6160f1b9404370d7 Mon Sep 17 00:00:00 2001 From: Dustin Falgout Date: Sat, 3 Dec 2016 00:59:34 -0600 Subject: [PATCH] ... --- src/gresource/js/GreeterConfig.js | 18 ++++++----- src/gresource/js/LightDMObjects.js | 50 ++++++++++++++++-------------- src/gresource/js/ThemeUtils.js | 10 ++++-- 3 files changed, 44 insertions(+), 34 deletions(-) diff --git a/src/gresource/js/GreeterConfig.js b/src/gresource/js/GreeterConfig.js index d02e25b..4def3d7 100644 --- a/src/gresource/js/GreeterConfig.js +++ b/src/gresource/js/GreeterConfig.js @@ -44,7 +44,7 @@ function set_values( defaults, target_obj, method ) { /** - * Provides theme authors with a way to retrieve values from the greeter's config + * Provides greeter themes with a way to access values from the greeter's config * file located at `/etc/lightdm/lightdm-webkit2-greeter.conf`. The greeter will * create an instance of this class when it starts. The instance can be accessed * with the global variable: [`greeter_config`](#dl-window-greeter_config). @@ -109,9 +109,9 @@ class GreeterConfig { } /** - * Returns the value of `key` from the `config_section` of the greeter's config file. + * ***Deprecated!*** Access config sections directly as properties of this object instead. * - * @deprecated Access config sections directly as properties of this object instead. + * @deprecated * * @arg {string} config_section * @arg {string} key @@ -123,9 +123,9 @@ class GreeterConfig { } /** - * Returns the value of `key` from the `config_section` of the greeter's config file. + * ***Deprecated!*** Access config sections directly as properties of this object instead. * - * @deprecated Access config sections directly as properties of this object instead. + * @deprecated * * @arg {string} config_section * @arg {string} key @@ -137,9 +137,9 @@ class GreeterConfig { } /** - * Returns the value of `key` from the `config_section` of the greeter's config file. + * ***Deprecated!*** Access config sections directly as properties of this object instead. * - * @deprecated Access config sections directly as properties of this object instead. + * @deprecated * * @arg {string} config_section * @arg {string} key @@ -176,6 +176,7 @@ const __greeter_config = new Promise( (resolve, reject) => { /** + * Greeter Config - Access values from the greeter's config file. * @name greeter_config * @type {LightDM.GreeterConfig} * @memberOf window @@ -184,10 +185,11 @@ __greeter_config.then( result => { window.greeter_config = result; /** + * ***Deprecated!*** Use {@link window.greeter_config} instead. * @name config * @type {LightDM.GreeterConfig} * @memberOf window - * @deprecated Use {@link window.greeter_config} instead. + * @deprecated */ window.config = window.greeter_config; } ); diff --git a/src/gresource/js/LightDMObjects.js b/src/gresource/js/LightDMObjects.js index d574bf7..978350b 100644 --- a/src/gresource/js/LightDMObjects.js +++ b/src/gresource/js/LightDMObjects.js @@ -28,27 +28,28 @@ /** * Interface for object that holds info about a session. Session objects are not * created by the theme's code, but rather by the {@link LightDM.Greeter} class. + * * @memberOf LightDM */ class Session { constructor( { comment, key, name } ) { /** * The comment for the session. - * @type {String} + * @type {string} * @readonly */ this.comment = comment; /** * The key for the session. - * @type {String} + * @type {string} * @readonly */ this.key = key; /** * The name for the session. - * @type {String} + * @type {string} * @readonly */ this.name = name; @@ -59,27 +60,28 @@ class Session { /** * Interface for object that holds info about a language on the system. Language objects are not * created by the theme's code, but rather by the {@link LightDM.Greeter} class. + * * @memberOf LightDM */ class Language { constructor( { code, name, territory } ) { /** * The code for the language. - * @type {String} + * @type {string} * @readonly */ this.code = code; /** * The name for the language. - * @type {String} + * @type {string} * @readonly */ this.name = name; /** * The territory for the language. - * @type {String} + * @type {string} * @readonly */ this.territory = territory; @@ -90,27 +92,28 @@ class Language { /** * Interface for object that holds info about a keyboard layout on the system. Language * objects are not created by the theme's code, but rather by the {@link LightDM.Greeter} class. + * * @memberOf LightDM */ class Layout { constructor( { description, name, short_description } ) { /** * The description for the layout. - * @type {String} + * @type {string} * @readonly */ this.description = description; /** * The name for the layout. - * @type {String} + * @type {string} * @readonly */ this.name = name; /** * The territory for the layout. - * @type {String} + * @type {string} * @readonly */ this.short_description = short_description; @@ -121,78 +124,79 @@ class Layout { /** * Interface for object that holds info about a user account on the system. User * objects are not created by the theme's code, but rather by the {@link LightDM.Greeter} class. + * * @memberOf LightDM */ class User { constructor( user_info ) { /** * The display name for the user. - * @type {String} + * @type {string} * @readonly */ this.display_name = user_info.display_name; /** * The language for the user. - * @type {String} + * @type {string} * @readonly */ this.language = user_info.language; /** * The keyboard layout for the user. - * @type {String} + * @type {string} * @readonly */ this.layout = user_info.layout; /** * The image for the user. - * @type {String} + * @type {string} * @readonly */ this.image = user_info.image; /** * The home_directory for the user. - * @type {String} + * @type {string} * @readonly */ this.home_directory = user_info.home_directory; /** * The username for the user. - * @type {String} + * @type {string} * @readonly */ this.username = user_info.username; /** * Whether or not the user is currently logged in. - * @type {Boolean} + * @type {boolean} * @readonly */ this.logged_in = user_info.logged_in; /** * The last session that the user logged into. - * @type {String|null} + * @type {string|null} * @readonly */ this.session = user_info.session; /** - * DEPRECATED! - * @deprecated See {@link LightDMUser.username}. - * @type {String} + * ***Deprecated!*** See {@link LightDM.User#username}. + * @deprecated + * @type {string} * @readonly */ this.name = user_info.name; /** - * DEPRECATED! - * @deprecated See {@link LightDMUser.display_name}. - * @type {String} + * ***Deprecated!*** See {@link LightDM.User#display_name}. + * @deprecated + * @type {string} * @readonly */ this.real_name = user_info.real_name; diff --git a/src/gresource/js/ThemeUtils.js b/src/gresource/js/ThemeUtils.js index 4ec29be..8169e66 100644 --- a/src/gresource/js/ThemeUtils.js +++ b/src/gresource/js/ThemeUtils.js @@ -39,7 +39,7 @@ let localized_invalid_date = moment('today', '!@#'), /** - * Provides various utility methods for use by theme authors. The greeter will automatically + * Provides various utility methods for use in greeter themes. The greeter will automatically * create an instance of this class when it starts. The instance can be accessed * with the global variable: [`theme_utils`](#dl-window-theme_utils). * @@ -186,7 +186,9 @@ class ThemeUtils { /** - * @deprecated Use {@link window.theme_utils.esc_html()} instead. + * Use {@link window.theme_utils.esc_html()} instead. + * + * @deprecated */ txt2html( text ) { try { @@ -224,6 +226,7 @@ const __theme_utils = new Promise( (resolve, reject) => { /** + * Theme Utils - various utility methods for use in greeter themes. * @name theme_utils * @type {LightDM.ThemeUtils} * @memberOf window @@ -232,10 +235,11 @@ __theme_utils.then( result => { window.theme_utils = result; /** + * ***Deprecated!*** Use {@link window.theme_utils} instead. * @name greeterutil * @type {LightDM.ThemeUtils} * @memberOf window - * @deprecated Use [`theme_utils`](#dl-window-theme_utils) instead. + * @deprecated */ window.greeterutil = window.theme_utils; } );