X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=_source%2Fplugins%2Fbasicstyles%2Fplugin.js;h=cf64afcc9cb06717861cd84b76c917c872729a3d;hb=c6e377a02b54abc07129d72b632763c727476a15;hp=b023ab7bc481b51a946939b97300c08fcb5cc171;hpb=ea7e3453c7b0f023b050aca6d9f83ab372860d91;p=ckeditor.git

diff --git a/_source/plugins/basicstyles/plugin.js b/_source/plugins/basicstyles/plugin.js
index b023ab7..cf64afc 100644
--- a/_source/plugins/basicstyles/plugin.js
+++ b/_source/plugins/basicstyles/plugin.js
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.
+Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
 For licensing, see LICENSE.html or http://ckeditor.com/license
 */
 
@@ -42,9 +42,52 @@ CKEDITOR.plugins.add( 'basicstyles',
 });
 
 // Basic Inline Styles.
+/**
+ * The style definition to be used to apply the bold style in the text.
+ * @type Object
+ * @example
+ * config.coreStyles_bold = { element : 'b', overrides : 'strong' };
+ * @example
+ * config.coreStyles_bold = { element : 'span', attributes : {'class': 'Bold'} };
+ */
 CKEDITOR.config.coreStyles_bold			= { element : 'strong', overrides : 'b' };
+/**
+ * The style definition to be used to apply the italic style in the text.
+ * @type Object
+ * @default { element : 'em', overrides : 'i' }
+ * @example
+ * CKEDITOR.config.coreStyles_italic		= { element : 'span', attributes : {'class': 'Italic'} };
+ */
 CKEDITOR.config.coreStyles_italic		= { element : 'em', overrides : 'i' };
+/**
+ * The style definition to be used to apply the underline style in the text.
+ * @type Object
+ * @default { element : 'u' }
+ * @example
+ * CKEDITOR.config.coreStyles_underline	= { element : 'span', attributes : {'class': 'Underline'}};
+ */
 CKEDITOR.config.coreStyles_underline	= { element : 'u' };
+/**
+ * The style definition to be used to apply the strike style in the text.
+ * @type Object
+ * @default { element : 'strike' }
+ * @example
+ * CKEDITOR.config.coreStyles_strike		= { element : 'span', attributes : {'class': 'StrikeThrough'}, overrides : 'strike' };
+ */
 CKEDITOR.config.coreStyles_strike		= { element : 'strike' };
+/**
+ * The style definition to be used to apply the subscript style in the text.
+ * @type Object
+ * @default { element : 'sub' }
+ * @example
+ * CKEDITOR.config.coreStyles_subscript	= { element : 'span', attributes : {'class': 'Subscript'}, overrides : 'sub' };
+ */
 CKEDITOR.config.coreStyles_subscript	= { element : 'sub' };
+/**
+ * The style definition to be used to apply the superscript style in the text.
+ * @type Object
+ * @default { element : 'sup' }
+ * @example
+ * CKEDITOR.config.coreStyles_superscript	= { element : 'span', attributes : {'class': 'Superscript'}, overrides : 'sup' };
+ */
 CKEDITOR.config.coreStyles_superscript	= { element : 'sup' };