src/eric7/QScintilla/TypingCompleters/CompleterRuby.py

branch
eric7
changeset 10431
64157aeb0312
parent 10201
5beaa25bdfbe
child 10439
21c28b0f9e41
--- a/src/eric7/QScintilla/TypingCompleters/CompleterRuby.py	Wed Dec 20 19:28:22 2023 +0100
+++ b/src/eric7/QScintilla/TypingCompleters/CompleterRuby.py	Thu Dec 21 12:03:40 2023 +0100
@@ -25,8 +25,10 @@
         """
         Constructor
 
-        @param editor reference to the editor object (QScintilla.Editor)
-        @param parent reference to the parent object (QObject)
+        @param editor reference to the editor object
+        @type QScintilla.Editor
+        @param parent reference to the parent object
+        @type QObject
         """
         super().__init__(editor, parent)
 
@@ -57,7 +59,8 @@
         """
         Public slot called to handle the user entering a character.
 
-        @param charNumber value of the character entered (integer)
+        @param charNumber value of the character entered
+        @type int
         """
         char = chr(charNumber)
         if char not in ["(", ")", "{", "}", "[", "]", ",", "'", '"', "\n", " "]:
@@ -185,9 +188,12 @@
         """
         Private method to check, if the cursor is inside a comment.
 
-        @param line current line (integer)
-        @param col current position within line (integer)
-        @return flag indicating, if the cursor is inside a comment (boolean)
+        @param line current line
+        @type int
+        @param col current position within line
+        @type int
+        @return flag indicating, if the cursor is inside a comment
+        @rtype bool
         """
         txt = self.editor.text(line)
         if col == len(txt):
@@ -204,7 +210,8 @@
         string.
 
         @return flag indicating, if the cursor is inside a double
-            quoted string (boolean)
+            quoted string
+        @rtype bool
         """
         return self.editor.currentStyle() == QsciLexerRuby.DoubleQuotedString
 
@@ -214,7 +221,8 @@
         string.
 
         @return flag indicating, if the cursor is inside a single
-            quoted string (boolean)
+            quoted string
+        @rtype bool
         """
         return self.editor.currentStyle() == QsciLexerRuby.SingleQuotedString
 
@@ -223,7 +231,7 @@
         Private method to check, if the cursor is within a here document.
 
         @return flag indicating, if the cursor is inside a here document
-            (boolean)
+        @rtype bool
         """
         return self.editor.currentStyle() == QsciLexerRuby.HereDocument
 
@@ -232,7 +240,7 @@
         Private method to check, if the cursor is within an inline document.
 
         @return flag indicating, if the cursor is inside an inline document
-            (boolean)
+        @rtype bool
         """
         return self.editor.currentStyle() == QsciLexerRuby.POD
 

eric ide

mercurial