Updated the plug-in documentation.

Sun, 19 Nov 2017 19:14:51 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 19 Nov 2017 19:14:51 +0100
changeset 5987
6e33e83b215d
parent 5986
1e78a1aa438b
child 5988
3cd2d5b75cdb

Updated the plug-in documentation.

Documentation/eric6-plugin.odt file | annotate | diff | comparison | revisions
Documentation/eric6-plugin.pdf file | annotate | diff | comparison | revisions
QScintilla/Editor.py file | annotate | diff | comparison | revisions
UI/CodeDocumentationViewer.py file | annotate | diff | comparison | revisions
Binary file Documentation/eric6-plugin.odt has changed
Binary file Documentation/eric6-plugin.pdf has changed
--- a/QScintilla/Editor.py	Sun Nov 19 14:43:20 2017 +0100
+++ b/QScintilla/Editor.py	Sun Nov 19 19:14:51 2017 +0100
@@ -4578,7 +4578,6 @@
     ## auto-completion hook interfaces
     #################################################################
     
-    # TODO: document this hook in chapter 6.2 of plug-in document
     def addCompletionListHook(self, key, func, async=False):
         """
         Public method to set an auto-completion list provider.
@@ -4617,7 +4616,6 @@
         else:
             self.__completionListHookFunctions[key] = func
     
-    # TODO: document this hook in chapter 6.2 of plug-in document
     def removeCompletionListHook(self, key):
         """
         Public method to remove a previously registered completion list
@@ -4638,7 +4636,6 @@
                 self.setAutoCompletionThreshold(
                     Preferences.getEditor("AutoCompletionThreshold"))
     
-    # TODO: document this hook in chapter 6.2 of plug-in document
     def getCompletionListHook(self, key):
         """
         Public method to get the registered completion list provider.
@@ -4721,7 +4718,6 @@
             if Preferences.getEditor("AutoCompletionScintillaOnFail"):
                 self.__acWatchdog.start()
     
-    # TODO: document this hook in chapter 6.2 of plug-in document
     def completionsListReady(self, completions, acText):
         """
         Public method to show the completions determined by a completions
@@ -4841,7 +4837,6 @@
     ## call-tip hook interfaces
     #################################################################
     
-    # TODO: document this hook in chapter 6.2 of plug-in document
     def addCallTipHook(self, key, func):
         """
         Public method to set a calltip provider.
@@ -4867,7 +4862,6 @@
         
         self.__ctHookFunctions[key] = func
     
-    # TODO: document this hook in chapter 6.2 of plug-in document
     def removeCallTipHook(self, key):
         """
         Public method to remove a previously registered calltip provider.
@@ -4878,7 +4872,6 @@
         if key in self.__ctHookFunctions:
             del self.__ctHookFunctions[key]
     
-    # TODO: document this hook in chapter 6.2 of plug-in document
     def getCallTipHook(self, key):
         """
         Public method to get the registered calltip provider.
--- a/UI/CodeDocumentationViewer.py	Sun Nov 19 14:43:20 2017 +0100
+++ b/UI/CodeDocumentationViewer.py	Sun Nov 19 19:14:51 2017 +0100
@@ -317,7 +317,6 @@
         if index == 0:
             self.__showDisabledMessage()
     
-    # TODO: document this hook in the plug-in document
     def registerProvider(self, providerName, providerDisplay, provider,
                          supported):
         """
@@ -344,7 +343,6 @@
         
         self.providerAdded.emit()
     
-    # TODO: document this hook in the plug-in document
     def unregisterProvider(self, providerName):
         """
         Public method register a source docu provider.
@@ -413,7 +411,6 @@
             self.__richTextViewer.clear()
             self.__providers[self.__selectedProvider][0](editor)
     
-    # TODO: document this hook in the plug-in document
     def documentationReady(self, documentationInfo, isWarning=False,
                            isDocWarning=False):
         """

eric ide

mercurial