Skip to content

Commit 0e3a94a

Browse files
jalnersjalners
authored
Merge pull request #179 from sculpt0r/skipsource
Add @skipsource to each config member in api docs
2 parents 2a4b497 + 08922a1 commit 0e3a94a

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

‎plugin.js‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1656,6 +1656,7 @@ CKEDITOR.on('scaytReady', function() {
16561656
*
16571657
* config.scayt_autoStartup = true;
16581658
*
1659+
* @skipsource
16591660
* @cfg {Boolean} [scayt_autoStartup=false]
16601661
* @member CKEDITOR.config
16611662
*/
@@ -1668,6 +1669,7 @@ CKEDITOR.on('scaytReady', function() {
16681669
*
16691670
* config.grayt_autoStartup = true;
16701671
*
1672+
* @skipsource
16711673
* @since 4.5.6
16721674
* @cfg {Boolean} [grayt_autoStartup=false]
16731675
* @member CKEDITOR.config
@@ -1681,6 +1683,7 @@ CKEDITOR.on('scaytReady', function() {
16811683
*
16821684
* config.scayt_inlineModeImmediateMarkup = true;
16831685
*
1686+
* @skipsource
16841687
* @since 4.5.6
16851688
* @cfg {Boolean} [scayt_inlineModeImmediateMarkup=false]
16861689
* @member CKEDITOR.config
@@ -1707,6 +1710,7 @@ CKEDITOR.on('scaytReady', function() {
17071710
* // Do not show the suggestions directly.
17081711
* config.scayt_maxSuggestions = 0;
17091712
*
1713+
* @skipsource
17101714
* @cfg {Number} [scayt_maxSuggestions=3]
17111715
* @member CKEDITOR.config
17121716
*/
@@ -1722,6 +1726,7 @@ CKEDITOR.on('scaytReady', function() {
17221726
* // Set the minimum length of words that will be collected from editor text.
17231727
* config.scayt_minWordLength = 5;
17241728
*
1729+
* @skipsource
17251730
* @cfg {Number} [scayt_minWordLength=3]
17261731
* @member CKEDITOR.config
17271732
*/
@@ -1734,6 +1739,7 @@ CKEDITOR.on('scaytReady', function() {
17341739
* // additional separator.
17351740
* config.scayt_customPunctuation = '-';
17361741
*
1742+
* @skipsource
17371743
* @cfg {String} [scayt_customPunctuation='']
17381744
* @member CKEDITOR.config
17391745
*/
@@ -1747,6 +1753,7 @@ CKEDITOR.on('scaytReady', function() {
17471753
* // Load SCAYT using my customer ID.
17481754
* config.scayt_customerId = 'your-encrypted-customer-id';
17491755
*
1756+
* @skipsource
17501757
* @cfg {String} [scayt_customerId='1:WvF0D4-UtPqN1-43nkD4-NKvUm2-daQqk3-LmNiI-z7Ysb4-mwry24-T8YrS3-Q2tpq2']
17511758
* @member CKEDITOR.config
17521759
*/
@@ -1760,6 +1767,7 @@ CKEDITOR.on('scaytReady', function() {
17601767
* // Disables the "More Suggestions" sub-menu.
17611768
* config.scayt_moreSuggestions = 'off';
17621769
*
1770+
* @skipsource
17631771
* @cfg {String} [scayt_moreSuggestions='on']
17641772
* @member CKEDITOR.config
17651773
*/
@@ -1790,6 +1798,7 @@ CKEDITOR.on('scaytReady', function() {
17901798
* // Show "Add Word", "Ignore" and "Ignore All" in the context menu.
17911799
* config.scayt_contextCommands = 'add|ignore|ignoreall';
17921800
*
1801+
* @skipsource
17931802
* @cfg {String} [scayt_contextCommands='ignoreall|add']
17941803
* @member CKEDITOR.config
17951804
*/
@@ -1808,6 +1817,7 @@ CKEDITOR.on('scaytReady', function() {
18081817
* // Sets SCAYT to German.
18091818
* config.scayt_sLang = 'de_DE';
18101819
*
1820+
* @skipsource
18111821
* @cfg {String} [scayt_sLang='en_US']
18121822
* @member CKEDITOR.config
18131823
*/
@@ -1823,6 +1833,7 @@ CKEDITOR.on('scaytReady', function() {
18231833
* // Hides the "Languages" tab.
18241834
* config.scayt_uiTabs = '1,0,1';
18251835
*
1836+
* @skipsource
18261837
* @cfg {String} [scayt_uiTabs='1,1,1']
18271838
* @member CKEDITOR.config
18281839
*/
@@ -1835,6 +1846,7 @@ CKEDITOR.on('scaytReady', function() {
18351846
* // Defines the protocol for the WebSpellChecker service (ssrv.cgi) path.
18361847
* config.scayt_serviceProtocol = 'https';
18371848
*
1849+
* @skipsource
18381850
* @cfg {String} [scayt_serviceProtocol='http']
18391851
* @member CKEDITOR.config
18401852
*/
@@ -1847,6 +1859,7 @@ CKEDITOR.on('scaytReady', function() {
18471859
* // Defines the host for the WebSpellChecker service (ssrv.cgi) path.
18481860
* config.scayt_serviceHost = 'my-host';
18491861
*
1862+
* @skipsource
18501863
* @cfg {String} [scayt_serviceHost='svc.webspellchecker.net']
18511864
* @member CKEDITOR.config
18521865
*/
@@ -1859,6 +1872,7 @@ CKEDITOR.on('scaytReady', function() {
18591872
* // Defines the port for the WebSpellChecker service (ssrv.cgi) path.
18601873
* config.scayt_servicePort = '2330';
18611874
*
1875+
* @skipsource
18621876
* @cfg {String} [scayt_servicePort='80']
18631877
* @member CKEDITOR.config
18641878
*/
@@ -1871,6 +1885,7 @@ CKEDITOR.on('scaytReady', function() {
18711885
* // Defines the path to the WebSpellChecker service (ssrv.cgi).
18721886
* config.scayt_servicePath = 'my-path/ssrv.cgi';
18731887
*
1888+
* @skipsource
18741889
* @cfg {String} [scayt_servicePath='spellcheck31/script/ssrv.cgi']
18751890
* @member CKEDITOR.config
18761891
*/
@@ -1885,6 +1900,7 @@ CKEDITOR.on('scaytReady', function() {
18851900
*
18861901
* config.scayt_srcUrl = "http://my-host/spellcheck/lf/scayt/scayt.js";
18871902
*
1903+
* @skipsource
18881904
* @cfg {String} [scayt_srcUrl='//svc.webspellchecker.net/spellcheck31/wscbundle/wscbundle.js']
18891905
* @member CKEDITOR.config
18901906
*/
@@ -1900,6 +1916,7 @@ CKEDITOR.on('scaytReady', function() {
19001916
*
19011917
* config.scayt_customDictionaryIds = '3021,3456,3478';
19021918
*
1919+
* @skipsource
19031920
* @cfg {String} [scayt_customDictionaryIds='']
19041921
* @member CKEDITOR.config
19051922
*/
@@ -1915,7 +1932,9 @@ CKEDITOR.on('scaytReady', function() {
19151932
*
19161933
* config.scayt_userDictionaryName = 'MyDictionary';
19171934
*
1935+
* @skipsource
19181936
* @cfg {String} [scayt_userDictionaryName='']
1937+
*
19191938
* @member CKEDITOR.config
19201939
*/
19211940

@@ -1934,6 +1953,7 @@ CKEDITOR.on('scaytReady', function() {
19341953
*
19351954
* config.scayt_contextMenuItemsOrder = 'moresuggest|control|suggest';
19361955
*
1956+
* @skipsource
19371957
* @cfg {String} [scayt_contextMenuItemsOrder='suggest|moresuggest|control']
19381958
* @member CKEDITOR.config
19391959
*/
@@ -1947,6 +1967,7 @@ CKEDITOR.on('scaytReady', function() {
19471967
*
19481968
* config.scayt_handleCheckDirty = 'false';
19491969
*
1970+
* @skipsource
19501971
* @cfg {String} [scayt_handleCheckDirty='true']
19511972
* @member CKEDITOR.config
19521973
*/
@@ -1961,6 +1982,7 @@ CKEDITOR.on('scaytReady', function() {
19611982
*
19621983
* config.scayt_handleUndoRedo = 'false';
19631984
*
1985+
* @skipsource
19641986
* @cfg {String} [scayt_handleUndoRedo='true']
19651987
* @member CKEDITOR.config
19661988
*/
@@ -1974,6 +1996,7 @@ CKEDITOR.on('scaytReady', function() {
19741996
*
19751997
* config.scayt_ignoreAllCapsWords = true;
19761998
*
1999+
* @skipsource
19772000
* @since 4.5.6
19782001
* @cfg {Boolean} [scayt_ignoreAllCapsWords=false]
19792002
* @member CKEDITOR.config
@@ -1988,6 +2011,7 @@ CKEDITOR.on('scaytReady', function() {
19882011
*
19892012
* config.scayt_ignoreDomainNames = true;
19902013
*
2014+
* @skipsource
19912015
* @since 4.5.6
19922016
* @cfg {Boolean} [scayt_ignoreDomainNames=false]
19932017
* @member CKEDITOR.config
@@ -2002,6 +2026,7 @@ CKEDITOR.on('scaytReady', function() {
20022026
*
20032027
* config.scayt_ignoreWordsWithMixedCases = true;
20042028
*
2029+
* @skipsource
20052030
* @since 4.5.6
20062031
* @cfg {Boolean} [scayt_ignoreWordsWithMixedCases=false]
20072032
* @member CKEDITOR.config
@@ -2016,6 +2041,7 @@ CKEDITOR.on('scaytReady', function() {
20162041
*
20172042
* config.scayt_ignoreWordsWithNumbers = true;
20182043
*
2044+
* @skipsource
20192045
* @since 4.5.6
20202046
* @cfg {Boolean} [scayt_ignoreWordsWithNumbers=false]
20212047
* @member CKEDITOR.config
@@ -2044,6 +2070,7 @@ CKEDITOR.on('scaytReady', function() {
20442070
* config.scayt_disableOptionsStorage = ['lang', 'ignore-domain-names', 'ignore-words-with-numbers'];
20452071
*
20462072
*
2073+
* @skipsource
20472074
* @cfg {String|Array} [scayt_disableOptionsStorage = '']
20482075
* @member CKEDITOR.config
20492076
*/
@@ -2056,6 +2083,7 @@ CKEDITOR.on('scaytReady', function() {
20562083
*
20572084
* config.scayt_elementsToIgnore = 'del,pre';
20582085
*
2086+
* @skipsource
20592087
* @cfg {String} [scayt_elementsToIgnore='style']
20602088
* @member CKEDITOR.config
20612089
*/

0 commit comments

Comments
 (0)