Browse Source

more adustments to docstrings

sisyphus
Dustin Falgout 8 years ago
parent
commit
4b109e211f
  1. 12
      src/gresource/js/Greeter.js
  2. 24
      src/gresource/js/GreeterConfig.js
  3. 10
      src/gresource/js/ThemeUtils.js

12
src/gresource/js/Greeter.js

@ -37,7 +37,7 @@
* Base class for the greeter's JavaScript Theme API. Greeter themes will interact
* directly with an object derived from this class to facilitate the user log-in process.
* The greeter will automatically create an instance when it starts.
* The instance can be accessed using the global variable: [`lightdm`]({@link external:window.lightdm}).
* The instance can be accessed using the global variable: {@link window.lightdm}.
*
* @memberOf LightDM
*/
@ -335,7 +335,7 @@ const __lightdm = new Promise( (resolve, reject) => {
/**
* @alias lightdm
* @type {LightDM.Greeter}
* @memberOf external:window
* @memberOf window
*/
__lightdm.then( result => window.lightdm = result );
@ -345,7 +345,7 @@ __lightdm.then( result => window.lightdm = result );
* @external moment
* @type {Object}
* @version 2.17.0
* @memberOf external:window
* @memberOf window
* @see {@link [Moment.js Documentation](http://momentjs.com/docs)}
*/
@ -354,13 +354,13 @@ __lightdm.then( result => window.lightdm = result );
* @external jQuery
* @type {Object}
* @version 3.1.1
* @memberOf external:window
* @memberOf window
* @see {@link [jQuery Documentation](http://api.jquery.com)}
*/
/**
* @external $
* @memberOf external:window
* @memberOf window
* @see {@link window.jQuery}
*/
@ -369,7 +369,7 @@ __lightdm.then( result => window.lightdm = result );
* @name Cookies
* @type {Object}
* @version 2.1.3
* @memberOf external:window
* @memberOf window
* @see {@link [JS Cookie Documentation](https://github.com/js-cookie/js-cookie/tree/latest#readme)}
*/

24
src/gresource/js/GreeterConfig.js

@ -56,9 +56,9 @@ class GreeterConfig {
* Holds keys/values from the `branding` section of the config file.
*
* @type {object} branding
* @prop {string} branding.background_images
* @prop {string} branding.logo
* @prop {string} branding.user_image
* @prop {string} background_images
* @prop {string} logo
* @prop {string} user_image
*
* @readonly
*/
@ -83,12 +83,12 @@ class GreeterConfig {
* Holds keys/values from the `greeter` section of the config file.
*
* @type {object} greeter
* @prop {boolean} greeter.debug_mode
* @prop {boolean} greeter.secure_mode
* @prop {number} greeter.screensaver_timeout
* @prop {string} greeter.time_format
* @prop {string} greeter.time_language
* @prop {string} greeter.webkit_theme
* @prop {boolean} debug_mode
* @prop {boolean} secure_mode
* @prop {number} screensaver_timeout
* @prop {string} time_format
* @prop {string} time_language
* @prop {string} webkit_theme
*
* @readonly
*/
@ -178,7 +178,7 @@ const __greeter_config = new Promise( (resolve, reject) => {
/**
* @alias greeter_config
* @type {LightDM.GreeterConfig}
* @memberOf external:window
* @memberOf window
*/
__greeter_config.then( result => {
window.greeter_config = result;
@ -186,8 +186,8 @@ __greeter_config.then( result => {
/**
* @alias config
* @type {LightDM.GreeterConfig}
* @memberOf external:window
* @deprecated Use [`greeter_config`]({@link external:window.greeter_config}) instead.
* @memberOf window
* @deprecated Use {@link window.greeter_config} instead.
*/
window.config = window.greeter_config;
} );

10
src/gresource/js/ThemeUtils.js

@ -41,7 +41,7 @@ let localized_invalid_date = moment('today', '!@#'),
/**
* Provides various utility methods for use by theme authors. The greeter will automatically
* create an instance of this class when it starts. The instance can be accessed
* with the global variable: [`theme_utils`]({@link external:window.theme_utils}).
* with the global variable: {@link window.theme_utils}.
*
* @memberOf LightDM
*/
@ -186,7 +186,7 @@ class ThemeUtils {
/**
* @deprecated Use {@link theme_utils.esc_html()} instead.
* @deprecated Use {@link window.theme_utils.esc_html()} instead.
*/
txt2html( text ) {
try {
@ -226,7 +226,7 @@ const __theme_utils = new Promise( (resolve, reject) => {
/**
* @alias theme_utils
* @type {LightDM.ThemeUtils}
* @memberOf external:window
* @memberOf window
*/
__theme_utils.then( result => {
window.theme_utils = result;
@ -234,8 +234,8 @@ __theme_utils.then( result => {
/**
* @alias greeterutil
* @type {LightDM.ThemeUtils}
* @memberOf external:window
* @deprecated Use [`theme_utils`]({@link external:window.theme_utils}) instead.
* @memberOf window
* @deprecated Use {@link window.theme_utils} instead.
*/
window.greeterutil = window.theme_utils;
} );

Loading…
Cancel
Save