From 6055c8a77b40707fb2d3bd0d617a96750ea40867 Mon Sep 17 00:00:00 2001 From: Kris Maglione Date: Mon, 25 May 2009 12:10:22 -0400 Subject: [PATCH] Add some rough documentation for config.js properties. --- common/content/configbase.js | 60 +++++++++++++++++++++++++++++++++++- common/content/tabs.js | 2 +- muttator/content/config.js | 9 +++--- vimperator/content/config.js | 9 +++--- xulmus/content/config.js | 9 +++--- 5 files changed, 72 insertions(+), 17 deletions(-) diff --git a/common/content/configbase.js b/common/content/configbase.js index 61e837c5..4b042457 100644 --- a/common/content/configbase.js +++ b/common/content/configbase.js @@ -27,30 +27,88 @@ the terms of any one of the MPL, the GPL or the LGPL. }}} ***** END LICENSE BLOCK *****/ const configbase = { //{{{ + /** + * @property {[["string", "string"]]} A sequence of names and descriptions + * of the autocommands available in this application. Primarily used + * for completion results. + */ autocommands: [], get browserModes() [modes.NORMAL], + /** + * @property {object} Application specific defaults for option values. The + * property names must be the options' cannonical names, and the values + * must be strings as entered via :set. + */ defaults: { guioptions: "rb" }, + /** + * @property {[["string", "string", "function"]]} An array of + * dialogs available via the :dialog command. + * [0] name - The name of the dialog, used as the first + * argument to :dialog. + * [1] description - A description of the dialog, used in + * command completion results for :dialog. + * [2] action - The function executed by :dialog. + */ dialogs: [], + /** + * @property {string[]} A list of features available in this + * application. Used extensively in feature test macros. Use + * liberator.has(feature) to check for a feature's presense + * in this array. + */ features: [], guioptions: {}, hasTabbrowser: false, + /** + * @property {string} The name of the application that hosts the + * “liberated” application. E.g., "Firefox" or "Xulrunner". + */ + hostApplication: null, + + /** + * @property {[string]} A list of HTML help files available under + * chrome://liberator/locale/. Used to generate help tag indeces for + * the :help command. + */ helpFiles: [], + /** + * @property {function} Called on liberator startup to allow for any + * arbitrary application-specific initialization code. + */ init: function () {}, + /** + * @property {object} A map between key names for key events should be ignored, + * and a mask of the modes in which they shoule be ignored. + */ ignoreKeys: {}, + /** + * @property {[[]]} An array of application specific mode specifications. + * The values of each mode are passed to modes.addMode during + * liberator startup. + */ modes: [], - optionDefaults: {}, + /** + * @property {string} The name of “liberated” application. + * Required. + */ + name: null, + /** + * @property {[string]} A list of extra scripts in the liberator or + * application namespaces which should be loaded before liberator + * initialization. + */ scripts: [], }; //}}} diff --git a/common/content/tabs.js b/common/content/tabs.js index 99061b9b..1e4b985d 100644 --- a/common/content/tabs.js +++ b/common/content/tabs.js @@ -119,7 +119,7 @@ function Tabs() //{{{ options.add(["showtabline", "stal"], "Control when to show the tab bar of opened web pages", - "number", config.optionDefaults["showtabline"], + "number", config.defaults["showtabline"], { setter: function (value) { diff --git a/muttator/content/config.js b/muttator/content/config.js index 51287251..75c8e502 100644 --- a/muttator/content/config.js +++ b/muttator/content/config.js @@ -33,7 +33,10 @@ const config = { //{{{ /*** optional options, there are checked for existence and a fallback provided ***/ features: ["hints", "mail", "marks", "addressbook", "tabs"], - defaults: { guioptions: "frb" }, + defaults: { + guioptions: "frb", + showtabline: 1, + }, guioptions: { m: ["MenuBar", ["mail-toolbar-menubar2"]], @@ -128,10 +131,6 @@ const config = { //{{{ ["COMPOSE"] ], - optionDefaults: { - showtabline: 1, - }, - scripts: [ "addressbook.js", "mail.js", diff --git a/vimperator/content/config.js b/vimperator/content/config.js index 3bbe4fa6..255e836f 100644 --- a/vimperator/content/config.js +++ b/vimperator/content/config.js @@ -33,7 +33,10 @@ const config = { //{{{ /*** optional options, there are checked for existence and a fallback provided ***/ features: ["bookmarks", "hints", "history", "marks", "quickmarks", "session", "tabs", "windows"], - defaults: { guioptions: "rb" }, + defaults: { + guioptions: "rb", + showtabline: 2, + }, guioptions: { m: ["Menubar", ["toolbar-menubar"]], @@ -132,10 +135,6 @@ const config = { //{{{ } }, - optionDefaults: { - showtabline: 2, - }, - scripts: [ "bookmarks.js", "tabs.js", diff --git a/xulmus/content/config.js b/xulmus/content/config.js index e7c5fd01..a2b32533 100644 --- a/xulmus/content/config.js +++ b/xulmus/content/config.js @@ -33,7 +33,10 @@ const config = { //{{{ //mainWindowID: "mainplayer", /*** optional options, there are checked for existence and a fallback provided ***/ features: ["bookmarks", "hints", "marks", "history", "quickmarks", "session", "tabs", "windows", "player"], - defaults: { guioptions: "mprb" }, + defaults: { + guioptions: "mprb", + showtabline: 2, + }, guioptions: { m: ["Menubar", ["main-menubar"]], @@ -175,10 +178,6 @@ const config = { //{{{ } }, - optionDefaults: { - showtabline: 2, - }, - scripts: [ "bookmarks.js", "tabs.js",