API Docs: Format plugin.

ckeditor · Sep 2, 2014 · 0bfcfc3 · 0bfcfc3
1 parent 3f8e7e9
commit 0bfcfc3
Showing 1 changed file with 14 additions and 14 deletions.
diff --git a/plugins/format/plugin.js b/plugins/format/plugin.js
@@ -130,11 +130,11 @@ CKEDITOR.plugins.add( 'format', {
 } );
 
 /**
- * A list of semi colon separated style names (by default tags) representing
- * the style definition for each entry to be displayed in the Format combo in
- * the toolbar. Each entry must have its relative definition configuration in a
+ * A list of semicolon-separated style names (by default: tags) representing
+ * the style definition for each entry to be displayed in the Format drop-down list
+ * in the toolbar. Each entry must have a corresponding configuration in a
  * setting named `'format_(tagName)'`. For example, the `'p'` entry has its
- * definition taken from `config.format_p`.
+ * definition taken from [config.format_p](#!/api/CKEDITOR.config-cfg-format_p).
  *
  *		config.format_tags = 'p;h2;h3;pre';
  *
@@ -144,7 +144,7 @@ CKEDITOR.plugins.add( 'format', {
 CKEDITOR.config.format_tags = 'p;h1;h2;h3;h4;h5;h6;pre;address;div';
 
 /**
- * The style definition to be used to apply the `'Normal'` format.
+ * The style definition to be used to apply the `Normal` format.
  *
  *		config.format_p = { element: 'p', attributes: { 'class': 'normalPara' } };
  *
@@ -154,7 +154,7 @@ CKEDITOR.config.format_tags = 'p;h1;h2;h3;h4;h5;h6;pre;address;div';
 CKEDITOR.config.format_p = { element: 'p' };
 
 /**
- * The style definition to be used to apply the `'Normal (DIV)'` format.
+ * The style definition to be used to apply the `Normal (DIV)` format.
  *
  *		config.format_div = { element: 'div', attributes: { 'class': 'normalDiv' } };
  *
@@ -164,7 +164,7 @@ CKEDITOR.config.format_p = { element: 'p' };
 CKEDITOR.config.format_div = { element: 'div' };
 
 /**
- * The style definition to be used to apply the `'Formatted'` format.
+ * The style definition to be used to apply the `Formatted` format.
  *
  *		config.format_pre = { element: 'pre', attributes: { 'class': 'code' } };
  *
@@ -174,7 +174,7 @@ CKEDITOR.config.format_div = { element: 'div' };
 CKEDITOR.config.format_pre = { element: 'pre' };
 
 /**
- * The style definition to be used to apply the `'Address'` format.
+ * The style definition to be used to apply the `Address` format.
  *
  *		config.format_address = { element: 'address', attributes: { 'class': 'styledAddress' } };
  *
@@ -184,7 +184,7 @@ CKEDITOR.config.format_pre = { element: 'pre' };
 CKEDITOR.config.format_address = { element: 'address' };
 
 /**
- * The style definition to be used to apply the `'Heading 1'` format.
+ * The style definition to be used to apply the `Heading 1` format.
  *
  *		config.format_h1 = { element: 'h1', attributes: { 'class': 'contentTitle1' } };
  *
@@ -194,7 +194,7 @@ CKEDITOR.config.format_address = { element: 'address' };
 CKEDITOR.config.format_h1 = { element: 'h1' };
 
 /**
- * The style definition to be used to apply the `'Heading 2'` format.
+ * The style definition to be used to apply the `Heading 2` format.
  *
  *		config.format_h2 = { element: 'h2', attributes: { 'class': 'contentTitle2' } };
  *
@@ -204,7 +204,7 @@ CKEDITOR.config.format_h1 = { element: 'h1' };
 CKEDITOR.config.format_h2 = { element: 'h2' };
 
 /**
- * The style definition to be used to apply the `'Heading 3'` format.
+ * The style definition to be used to apply the `Heading 3` format.
  *
  *		config.format_h3 = { element: 'h3', attributes: { 'class': 'contentTitle3' } };
  *
@@ -214,7 +214,7 @@ CKEDITOR.config.format_h2 = { element: 'h2' };
 CKEDITOR.config.format_h3 = { element: 'h3' };
 
 /**
- * The style definition to be used to apply the `'Heading 4'` format.
+ * The style definition to be used to apply the `Heading 4` format.
  *
  *		config.format_h4 = { element: 'h4', attributes: { 'class': 'contentTitle4' } };
  *
@@ -224,7 +224,7 @@ CKEDITOR.config.format_h3 = { element: 'h3' };
 CKEDITOR.config.format_h4 = { element: 'h4' };
 
 /**
- * The style definition to be used to apply the `'Heading 5'` format.
+ * The style definition to be used to apply the `Heading 5` format.
  *
  *		config.format_h5 = { element: 'h5', attributes: { 'class': 'contentTitle5' } };
  *
@@ -234,7 +234,7 @@ CKEDITOR.config.format_h4 = { element: 'h4' };
 CKEDITOR.config.format_h5 = { element: 'h5' };
 
 /**
- * The style definition to be used to apply the `'Heading 6'` format.
+ * The style definition to be used to apply the `Heading 6` format.
  *
  *		config.format_h6 = { element: 'h6', attributes: { 'class': 'contentTitle6' } };
  *