src/eric7/QScintilla/DocstringGenerator/BaseDocstringGenerator.py

branch
eric7
changeset 9500
5771348ded12
parent 9497
8beca4047c53
child 9653
e67609152c5e
equal deleted inserted replaced
9499:dd389c57c2f0 9500:5771348ded12
194 self.visibility = "" 194 self.visibility = ""
195 # function visibility with allowed values: 195 # function visibility with allowed values:
196 # public, protected, private or special (i.e. starting and 196 # public, protected, private or special (i.e. starting and
197 # ending with '__' 197 # ending with '__'
198 198
199 def parseDefinition(self, text, quote, quoteReplace):
200 """
201 Public method to parse the function definition text.
202
203 Note: This method should be overwritten in subclasses.
204
205 @param text text containing the function definition
206 @type str
207 @param quote quote string to be replaced
208 @type str
209 @param quoteReplace quote string to replace the original
210 @type str
211 """
212 pass
213
214 def parseBody(self, text):
215 """
216 Public method to parse the function body text.
217
218 Note: This method should be overwritten in subclasses.
219
220 @param text function body text
221 @type str
222 """
223 pass
224
199 225
200 class DocstringMenuForEnterOnly(QMenu): 226 class DocstringMenuForEnterOnly(QMenu):
201 """ 227 """
202 Class implementing a special menu reacting to the enter/return keys only. 228 Class implementing a special menu reacting to the enter/return keys only.
203 229

eric ide

mercurial