Index: /CKEditor/trunk/_dev/docs_build/docs_build.conf =================================================================== --- /CKEditor/trunk/_dev/docs_build/docs_build.conf (revision 6018) +++ /CKEditor/trunk/_dev/docs_build/docs_build.conf (revision 6019) @@ -17,5 +17,6 @@ '../../_source/core/', '../../_source/plugins/', - '../../_source/skins/kama/skin.js' + '../../_source/skins/kama/skin.js', + '../../_source/themes/default/theme.js' ], Index: /CKEditor/trunk/_source/core/editor.js =================================================================== --- /CKEditor/trunk/_source/core/editor.js (revision 6018) +++ /CKEditor/trunk/_source/core/editor.js (revision 6019) @@ -119,8 +119,44 @@ 'skins/' + skinName + '/' ) ); + /** + * The name of the skin used by this editor instance. The skin name can + * be set though the {@link CKEDITOR.config.skin} setting. + * @name CKEDITOR.editor.prototype.skinName + * @type String + * @example + * alert( editor.skinName ); // "kama" (e.g.) + */ editor.skinName = skinName; + + /** + * The full URL of the skin directory. + * @name CKEDITOR.editor.prototype.skinPath + * @type String + * @example + * alert( editor.skinPath ); // "http://example.com/ckeditor/skins/kama/" (e.g.) + */ editor.skinPath = skinPath; + + /** + * The CSS class name used for skin identification purposes. + * @name CKEDITOR.editor.prototype.skinClass + * @type String + * @example + * alert( editor.skinClass ); // "cke_skin_kama" (e.g.) + */ editor.skinClass = 'cke_skin_' + skinName; + /** + * The tabbing + * navigation order that has been calculated for this editor + * instance. This can be set by the {@link CKEDITOR.config.tabIndex} + * setting or taken from the "tabindex" attribute of the + * {@link #element} associated to the editor. + * @name CKEDITOR.editor.prototype.tabIndex + * @type Number + * @default 0 (zero) + * @example + * alert( editor.tabIndex ); // "0" (e.g.) + */ editor.tabIndex = editor.config.tabIndex || editor.element.getAttribute( 'tabindex' ) || 0; @@ -136,6 +172,22 @@ CKEDITOR.lang.load( editor.config.language, editor.config.defaultLanguage, function( languageCode, lang ) { + /** + * The code for the language resources that have been loaded + * for the user internface elements of this editor instance. + * @name CKEDITOR.editor.prototype.langCode + * @type String + * @example + * alert( editor.langCode ); // "en" (e.g.) + */ editor.langCode = languageCode; + /** + * An object holding all language strings used by the editor + * interface. + * @name CKEDITOR.editor.prototype.lang + * @type CKEDITOR.lang + * @example + * alert( editor.lang.bold ); // "Negrito" (e.g. if language is Portuguese) + */ // As we'll be adding plugin specific entries that could come // from different language code files, we need a copy of lang, @@ -189,5 +241,12 @@ var languageFiles = []; - // Cache the loaded plugin names. + /** + * And object holding references to all plugins used by this + * editor istance. + * @name CKEDITOR.editor.prototype.plugins + * @type Object + * @example + * alert( editor.plugins.dialog.path ); // "http://example.com/ckeditor/plugins/dialog/" (e.g.) + */ editor.plugins = plugins; @@ -272,4 +331,11 @@ CKEDITOR.themes.load( theme, function() { + /** + * The theme used by this editor instance. + * @name CKEDITOR.editor.prototype.theme + * @type CKEDITOR.theme + * @example + * alert( editor.theme ); "http://example.com/ckeditor/themes/default/" (e.g.) + */ var editorTheme = editor.theme = CKEDITOR.themes.get( theme ); editorTheme.path = CKEDITOR.themes.getPath( theme ); @@ -604,4 +670,14 @@ }, + /** + * Gets the "raw data" currently available in the editor. This is a + * fast method which return the data as is, without processing, so it's + * not recommended to use it on resulting pages. It can be used instead + * combined with the {@link #loadSnapshot} so one can automatic save + * the editor data from time to time while the user is using the + * editor, to avoid data loss, without risking performance issues. + * @example + * alert( editor.getSnapshot() ); + */ getSnapshot : function() { @@ -618,4 +694,13 @@ }, + /** + * Loads "raw data" in the editor. This data is loaded with processing + * straight to the editing area. It should not be used as a way to load + * any kind of data, but instead in combination with + * {@link #getSnapshot} produced data. + * @example + * var data = editor.getSnapshot(); + * editor.loadSnapshot( data ); + */ loadSnapshot : function( snapshot ) { @@ -685,4 +770,22 @@ }, + /** + * Checks whether the current editor contents present changes when + * compared to the contents loaded into the editor at startup, or to + * the contents available in the editor when {@link #resetDirty} has + * been called. + * @returns {Boolean} "true" is the contents present changes. + * @example + * function beforeUnload( e ) + * { + * if ( CKEDITOR.instances.editor1.checkDirty() ) + * return e.returnValue = "You'll loose the changes made in the editor."; + * } + * + * if ( window.addEventListener ) + * window.addEventListener( 'beforeunload', beforeUnload, false ); + * else + * window.attachEvent( 'onbeforeunload', beforeUnload ); + */ checkDirty : function() { @@ -690,4 +793,13 @@ }, + /** + * Resets the "dirty state" of the editor so subsequent calls to + * {@link #checkDirty} will return "false" if the user will not make + * further changes to the contents. + * @example + * alert( editor.checkDirty() ); // "true" (e.g.) + * editor.resetDirty(); + * alert( editor.checkDirty() ); // "false" + */ resetDirty : function() { @@ -788,2 +900,25 @@ * @param {Object} data.returnValue The value returned by the command execution. */ + +/** + * Fired every custom configuration file is loaded, before the final + * configurations initialization.
+ *
+ * Custom configuration files can be loaded thorugh the + * {@link CKEDITOR.config.customConfig} setting. Several files can be loading + * by chaning this setting. + * @name CKEDITOR.editor#customConfigLoaded + * @event + * @param {CKEDITOR.editor} editor This editor instance. + * @example + */ + +/** + * Fired once the editor configuration is ready (loaded and processed). + * @name CKEDITOR.editor#configLoaded + * @event + * @param {CKEDITOR.editor} editor This editor instance. + * @example + * if( editor.config.fullPage ) + * alert( 'This is a full page editor' ); + */ Index: /CKEditor/trunk/_source/core/editor_basic.js =================================================================== --- /CKEditor/trunk/_source/core/editor_basic.js (revision 6018) +++ /CKEditor/trunk/_source/core/editor_basic.js (revision 6019) @@ -28,7 +28,7 @@ /** - * Represents an editor instance. This constructor should be rarely used, - * being the {@link CKEDITOR} methods preferible. - * @constructor + * Creates an editor class instance. This constructor should be rarely + * used, in favor of the {@link CKEDITOR} editor creation functions. + * @ class Represents an editor instance. * @param {Object} instanceConfig Configuration values for this specific * instance. @@ -36,5 +36,5 @@ * instance. * @param {Number} [mode] The mode in which the element is linked to this - * instance. + * instance. See {@link #elementMode}. * @param {String} [data] Since 3.3. Initial value for the instance. * @augments CKEDITOR.event @@ -55,9 +55,9 @@ * instance. It can be any of the following values: * Index: /CKEditor/trunk/_source/themes/default/theme.js =================================================================== --- /CKEditor/trunk/_source/themes/default/theme.js (revision 6018) +++ /CKEditor/trunk/_source/themes/default/theme.js (revision 6019) @@ -3,4 +3,9 @@ For licensing, see LICENSE.html or http://ckeditor.com/license */ + +/** + * @name CKEDITOR.theme + * @class + */ CKEDITOR.themes.add( 'default', (function() @@ -66,5 +71,5 @@ } - return { + return /** @lends CKEDITOR.theme */ { build : function( editor, themePath ) {