src/eric7/QScintilla/Lexers/Lexer.py

branch
eric7
changeset 9293
7d9d916a9a9f
parent 9221
bf71ee032bb4
child 9295
d14096c04126
--- a/src/eric7/QScintilla/Lexers/Lexer.py	Tue Aug 23 16:21:07 2022 +0200
+++ b/src/eric7/QScintilla/Lexers/Lexer.py	Tue Aug 23 19:14:35 2022 +0200
@@ -44,7 +44,8 @@
         """
         Public method to return the comment string.
 
-        @return comment string (string)
+        @return comment string
+        @type str
         """
         return self.commentString
 
@@ -53,7 +54,8 @@
         Public method to determine, whether the lexer language supports a
         block comment.
 
-        @return flag (boolean)
+        @return flag indicating block comment is available
+        @rtype bool
         """
         return self.commentString != ""
 
@@ -61,7 +63,8 @@
         """
         Public method to return the stream comment strings.
 
-        @return stream comment strings (dictionary with two strings)
+        @return dictionary containing the start and end stream comment strings
+        @type dict of {"start": str, "end": str}
         """
         return self.streamCommentString
 
@@ -70,7 +73,8 @@
         Public method to determine, whether the lexer language supports a
         stream comment.
 
-        @return flag (boolean)
+        @return flag indicating stream comment is available
+        @type bool
         """
         return (
             self.streamCommentString["start"] != ""
@@ -81,7 +85,8 @@
         """
         Public method to return the box comment strings.
 
-        @return box comment strings (dictionary with three QStrings)
+        @return dictionary containing the start, middle and end box comment strings
+        @type dict of {"start": str, "middle": str, "end": str}
         """
         return self.boxCommentString
 
@@ -90,7 +95,8 @@
         Public method to determine, whether the lexer language supports a
         box comment.
 
-        @return flag (boolean)
+        @return flag box comment is available
+        @type bool
         """
         return (
             (self.boxCommentString["start"] != "")

eric ide

mercurial