Regenerated the source documentation.

Wed, 23 Oct 2019 20:00:27 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Wed, 23 Oct 2019 20:00:27 +0200
changeset 7307
b695cab23f00
parent 7306
7cb88e04e4c0
child 7308
7b932d80c838

Regenerated the source documentation.

eric6/APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
eric6/APIs/Python3/eric6.bas file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.QScintilla.Editor.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.QScintilla.Exporters.ExporterHTML.html file | annotate | diff | comparison | revisions
--- a/eric6/APIs/Python3/eric6.api	Wed Oct 23 19:59:23 2019 +0200
+++ b/eric6/APIs/Python3/eric6.api	Wed Oct 23 20:00:27 2019 +0200
@@ -7428,8 +7428,14 @@
 eric6.QScintilla.Exporters.ExporterHTML.ExporterHTML?1(editor, parent=None)
 eric6.QScintilla.Exporters.ExporterHTML.HTMLGenerator.generate?4(tabSize=4, useTabs=False, wysiwyg=True, folding=False, onlyStylesUsed=False, titleFullPath=False)
 eric6.QScintilla.Exporters.ExporterHTML.HTMLGenerator?1(editor)
-eric6.QScintilla.Exporters.ExporterHTML._StrikeThroughExtension.DEL_RE?7
-eric6.QScintilla.Exporters.ExporterHTML._StrikeThroughExtension.extendMarkdown?4(md, md_globals)
+eric6.QScintilla.Exporters.ExporterHTML._CaretExtension.INS_RE?7
+eric6.QScintilla.Exporters.ExporterHTML._CaretExtension.SUP_RE?7
+eric6.QScintilla.Exporters.ExporterHTML._CaretExtension.extendMarkdown?4(md, md_globals)
+eric6.QScintilla.Exporters.ExporterHTML._MarkExtension.MARK_RE?7
+eric6.QScintilla.Exporters.ExporterHTML._MarkExtension.extendMarkdown?4(md, md_globals)
+eric6.QScintilla.Exporters.ExporterHTML._TildeExtension.DEL_RE?7
+eric6.QScintilla.Exporters.ExporterHTML._TildeExtension.SUB_RE?7
+eric6.QScintilla.Exporters.ExporterHTML._TildeExtension.extendMarkdown?4(md, md_globals)
 eric6.QScintilla.Exporters.ExporterODT.ExporterODT.exportSource?4()
 eric6.QScintilla.Exporters.ExporterODT.ExporterODT?1(editor, parent=None)
 eric6.QScintilla.Exporters.ExporterPDF.ExporterPDF.exportSource?4()
--- a/eric6/APIs/Python3/eric6.bas	Wed Oct 23 19:59:23 2019 +0200
+++ b/eric6/APIs/Python3/eric6.bas	Wed Oct 23 20:00:27 2019 +0200
@@ -1027,5 +1027,4 @@
 ZoomValuesModel QAbstractTableModel
 _CaretExtension markdown.Extension
 _MarkExtension markdown.Extension
-_StrikeThroughExtension markdown.Extension
 _TildeExtension markdown.Extension
Binary file eric6/Documentation/Help/source.qch has changed
--- a/eric6/Documentation/Help/source.qhp	Wed Oct 23 19:59:23 2019 +0200
+++ b/eric6/Documentation/Help/source.qhp	Wed Oct 23 20:00:27 2019 +0200
@@ -4757,6 +4757,7 @@
       <keyword name="Editor.__setAutoCompletion" id="Editor.__setAutoCompletion" ref="eric6.QScintilla.Editor.html#Editor.__setAutoCompletion" />
       <keyword name="Editor.__setCallTips" id="Editor.__setCallTips" ref="eric6.QScintilla.Editor.html#Editor.__setCallTips" />
       <keyword name="Editor.__setEolMode" id="Editor.__setEolMode" ref="eric6.QScintilla.Editor.html#Editor.__setEolMode" />
+      <keyword name="Editor.__setFileName" id="Editor.__setFileName" ref="eric6.QScintilla.Editor.html#Editor.__setFileName" />
       <keyword name="Editor.__setLineMarkerColours" id="Editor.__setLineMarkerColours" ref="eric6.QScintilla.Editor.html#Editor.__setLineMarkerColours" />
       <keyword name="Editor.__setMarginsDisplay" id="Editor.__setMarginsDisplay" ref="eric6.QScintilla.Editor.html#Editor.__setMarginsDisplay" />
       <keyword name="Editor.__setSpelling" id="Editor.__setSpelling" ref="eric6.QScintilla.Editor.html#Editor.__setSpelling" />
@@ -16881,16 +16882,20 @@
       <keyword name="ZoomValuesModel.headerData" id="ZoomValuesModel.headerData" ref="eric6.WebBrowser.ZoomManager.ZoomValuesModel.html#ZoomValuesModel.headerData" />
       <keyword name="ZoomValuesModel.removeRows" id="ZoomValuesModel.removeRows" ref="eric6.WebBrowser.ZoomManager.ZoomValuesModel.html#ZoomValuesModel.removeRows" />
       <keyword name="ZoomValuesModel.rowCount" id="ZoomValuesModel.rowCount" ref="eric6.WebBrowser.ZoomManager.ZoomValuesModel.html#ZoomValuesModel.rowCount" />
+      <keyword name="_CaretExtension" id="_CaretExtension" ref="eric6.QScintilla.Exporters.ExporterHTML.html#_CaretExtension" />
       <keyword name="_CaretExtension" id="_CaretExtension" ref="eric6.UI.Previewers.PreviewerHTML.html#_CaretExtension" />
+      <keyword name="_CaretExtension.extendMarkdown" id="_CaretExtension.extendMarkdown" ref="eric6.QScintilla.Exporters.ExporterHTML.html#_CaretExtension.extendMarkdown" />
       <keyword name="_CaretExtension.extendMarkdown" id="_CaretExtension.extendMarkdown" ref="eric6.UI.Previewers.PreviewerHTML.html#_CaretExtension.extendMarkdown" />
       <keyword name="_ClbrBase" id="_ClbrBase" ref="eric6.Utilities.ClassBrowsers.ClbrBaseClasses.html#_ClbrBase" />
       <keyword name="_ClbrBase (Constructor)" id="_ClbrBase (Constructor)" ref="eric6.Utilities.ClassBrowsers.ClbrBaseClasses.html#_ClbrBase.__init__" />
       <keyword name="_ClbrBase.setEndLine" id="_ClbrBase.setEndLine" ref="eric6.Utilities.ClassBrowsers.ClbrBaseClasses.html#_ClbrBase.setEndLine" />
+      <keyword name="_MarkExtension" id="_MarkExtension" ref="eric6.QScintilla.Exporters.ExporterHTML.html#_MarkExtension" />
       <keyword name="_MarkExtension" id="_MarkExtension" ref="eric6.UI.Previewers.PreviewerHTML.html#_MarkExtension" />
+      <keyword name="_MarkExtension.extendMarkdown" id="_MarkExtension.extendMarkdown" ref="eric6.QScintilla.Exporters.ExporterHTML.html#_MarkExtension.extendMarkdown" />
       <keyword name="_MarkExtension.extendMarkdown" id="_MarkExtension.extendMarkdown" ref="eric6.UI.Previewers.PreviewerHTML.html#_MarkExtension.extendMarkdown" />
-      <keyword name="_StrikeThroughExtension" id="_StrikeThroughExtension" ref="eric6.QScintilla.Exporters.ExporterHTML.html#_StrikeThroughExtension" />
-      <keyword name="_StrikeThroughExtension.extendMarkdown" id="_StrikeThroughExtension.extendMarkdown" ref="eric6.QScintilla.Exporters.ExporterHTML.html#_StrikeThroughExtension.extendMarkdown" />
+      <keyword name="_TildeExtension" id="_TildeExtension" ref="eric6.QScintilla.Exporters.ExporterHTML.html#_TildeExtension" />
       <keyword name="_TildeExtension" id="_TildeExtension" ref="eric6.UI.Previewers.PreviewerHTML.html#_TildeExtension" />
+      <keyword name="_TildeExtension.extendMarkdown" id="_TildeExtension.extendMarkdown" ref="eric6.QScintilla.Exporters.ExporterHTML.html#_TildeExtension.extendMarkdown" />
       <keyword name="_TildeExtension.extendMarkdown" id="_TildeExtension.extendMarkdown" ref="eric6.UI.Previewers.PreviewerHTML.html#_TildeExtension.extendMarkdown" />
       <keyword name="__check" id="__check" ref="eric6.Plugins.CheckerPlugins.Tabnanny.Tabnanny.html#__check" />
       <keyword name="__checkCodeStyle" id="__checkCodeStyle" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html#__checkCodeStyle" />
--- a/eric6/Documentation/Source/eric6.QScintilla.Editor.html	Wed Oct 23 19:59:23 2019 +0200
+++ b/eric6/Documentation/Source/eric6.QScintilla.Editor.html	Wed Oct 23 20:00:27 2019 +0200
@@ -720,6 +720,10 @@
 <td>Private method to configure the eol mode of the editor.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__setFileName">__setFileName</a></td>
+<td>Private method to set the file name of the current file.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__setLineMarkerColours">__setLineMarkerColours</a></td>
 <td>Private method to set the line marker colours.</td>
 </tr>
@@ -3436,6 +3440,20 @@
 <p>
         Private method to configure the eol mode of the editor.
 </p>
+<a NAME="Editor.__setFileName" ID="Editor.__setFileName"></a>
+<h4>Editor.__setFileName</h4>
+<b>__setFileName</b>(<i>name</i>)
+
+<p>
+        Private method to set the file name of the current file.
+</p>
+<dl>
+
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the current file
+</dd>
+</dl>
 <a NAME="Editor.__setLineMarkerColours" ID="Editor.__setLineMarkerColours"></a>
 <h4>Editor.__setLineMarkerColours</h4>
 <b>__setLineMarkerColours</b>(<i></i>)
@@ -5487,17 +5505,29 @@
         Public method to check, if the given position is within a region, that
         should be spell checked.
 </p>
-<dl>
-
-<dt><i>pos</i></dt>
-<dd>
-position to be checked (integer)
+<p>
+        For files with a configured full text file extension all regions will
+        be regarded as to be checked. Depending on configuration, all unknown
+        files (i.e. those without a file extension) will be checked fully as
+        well.
+</p>
+<dl>
+
+<dt><i>pos</i> (int)</dt>
+<dd>
+position to be checked
 </dd>
 </dl>
 <dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating pos is in a spell check region (boolean)
+flag indicating pos is in a spell check region
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Editor.joinLines" ID="Editor.joinLines"></a>
--- a/eric6/Documentation/Source/eric6.QScintilla.Exporters.ExporterHTML.html	Wed Oct 23 19:59:23 2019 +0200
+++ b/eric6/Documentation/Source/eric6.QScintilla.Exporters.ExporterHTML.html	Wed Oct 23 20:00:27 2019 +0200
@@ -43,7 +43,15 @@
 <td>Class implementing an HTML generator for exporting source code.</td>
 </tr>
 <tr>
-<td><a href="#_StrikeThroughExtension">_StrikeThroughExtension</a></td>
+<td><a href="#_CaretExtension">_CaretExtension</a></td>
+<td>Class is placed here, because it depends on imported markdown, and markdown import is lazy.</td>
+</tr>
+<tr>
+<td><a href="#_MarkExtension">_MarkExtension</a></td>
+<td>Class is placed here, because it depends on imported markdown, and markdown import is lazy.</td>
+</tr>
+<tr>
+<td><a href="#_TildeExtension">_TildeExtension</a></td>
 <td>Class is placed here, because it depends on imported markdown, and markdown import is lazy.</td>
 </tr>
 </table>
@@ -255,24 +263,23 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
-<a NAME="_StrikeThroughExtension" ID="_StrikeThroughExtension"></a>
-<h2>_StrikeThroughExtension</h2>
+<a NAME="_CaretExtension" ID="_CaretExtension"></a>
+<h2>_CaretExtension</h2>
 
 <p>
-                Class is placed here, because it depends on imported markdown,
-                and markdown import is lazy.
+                    Class is placed here, because it depends on imported
+                    markdown, and markdown import is lazy.
 </p>
 <p>
-                (see http://achinghead.com/
-                python-markdown-adding-insert-delete.html this page for
-                details)
+                    (see https://pythonhosted.org/Markdown/extensions/api.html
+                    this page for details)
 </p>
 <h3>Derived from</h3>
 markdown.Extension
 <h3>Class Attributes</h3>
 
 <table>
-<tr><td>DEL_RE</td></tr>
+<tr><td>INS_RE</td></tr><tr><td>SUP_RE</td></tr>
 </table>
 <h3>Class Methods</h3>
 
@@ -284,7 +291,7 @@
 <table>
 
 <tr>
-<td><a href="#_StrikeThroughExtension.extendMarkdown">extendMarkdown</a></td>
+<td><a href="#_CaretExtension.extendMarkdown">extendMarkdown</a></td>
 <td></td>
 </tr>
 </table>
@@ -294,8 +301,98 @@
 <tr><td>None</td></tr>
 </table>
 
-<a NAME="_StrikeThroughExtension.extendMarkdown" ID="_StrikeThroughExtension.extendMarkdown"></a>
-<h4>_StrikeThroughExtension.extendMarkdown</h4>
+<a NAME="_CaretExtension.extendMarkdown" ID="_CaretExtension.extendMarkdown"></a>
+<h4>_CaretExtension.extendMarkdown</h4>
+<b>extendMarkdown</b>(<i>md, md_globals</i>)
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="_MarkExtension" ID="_MarkExtension"></a>
+<h2>_MarkExtension</h2>
+
+<p>
+                    Class is placed here, because it depends on imported
+                    markdown, and markdown import is lazy.
+</p>
+<p>
+                    (see https://pythonhosted.org/Markdown/extensions/api.html
+                    this page for details)
+</p>
+<h3>Derived from</h3>
+markdown.Extension
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>MARK_RE</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#_MarkExtension.extendMarkdown">extendMarkdown</a></td>
+<td></td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="_MarkExtension.extendMarkdown" ID="_MarkExtension.extendMarkdown"></a>
+<h4>_MarkExtension.extendMarkdown</h4>
+<b>extendMarkdown</b>(<i>md, md_globals</i>)
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="_TildeExtension" ID="_TildeExtension"></a>
+<h2>_TildeExtension</h2>
+
+<p>
+                    Class is placed here, because it depends on imported
+                    markdown, and markdown import is lazy.
+</p>
+<p>
+                    (see https://pythonhosted.org/Markdown/extensions/api.html
+                    this page for details)
+</p>
+<h3>Derived from</h3>
+markdown.Extension
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>DEL_RE</td></tr><tr><td>SUB_RE</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#_TildeExtension.extendMarkdown">extendMarkdown</a></td>
+<td></td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="_TildeExtension.extendMarkdown" ID="_TildeExtension.extendMarkdown"></a>
+<h4>_TildeExtension.extendMarkdown</h4>
 <b>extendMarkdown</b>(<i>md, md_globals</i>)
 
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial