Sat, 23 Dec 2023 19:43:44 +0100
Converted some source code documentation to the new style.
--- a/ExtensionCorba/Documentation/source/Plugin_Extension_Corba.ExtensionCorba.LexerIDL.html Sat Dec 23 15:48:47 2023 +0100 +++ b/ExtensionCorba/Documentation/source/Plugin_Extension_Corba.ExtensionCorba.LexerIDL.html Sat Dec 23 19:43:44 2023 +0100 @@ -94,7 +94,7 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QObject)</dt> <dd> parent widget of this lexer </dd> @@ -108,15 +108,21 @@ </p> <dl> -<dt><i>kwSet</i></dt> +<dt><i>kwSet</i> (int)</dt> <dd> -number of the keyword set (integer) +number of the keyword set </dd> </dl> <dl> <dt>Return:</dt> <dd> -string giving the keywords (string) or None +string giving the keywords or None +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="LexerIDL.initProperties" ID="LexerIDL.initProperties"></a> @@ -135,15 +141,21 @@ </p> <dl> -<dt><i>style</i></dt> +<dt><i>style</i> (int)</dt> <dd> -style to check (integer) +style to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating a comment style (boolean) +flag indicating a comment style +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="LexerIDL.isStringStyle" ID="LexerIDL.isStringStyle"></a> @@ -155,15 +167,21 @@ </p> <dl> -<dt><i>style</i></dt> +<dt><i>style</i> (int)</dt> <dd> -style to check (integer) +style to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating a string style (boolean) +flag indicating a string style +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="LexerIDL.maximumKeywordSet" ID="LexerIDL.maximumKeywordSet"></a> @@ -176,7 +194,13 @@ <dl> <dt>Return:</dt> <dd> -maximum keyword set (integer) +maximum keyword set +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/ExtensionCorba/Documentation/source/Plugin_Extension_Corba.ExtensionCorba.ProjectInterfacesBrowser.html Sat Dec 23 15:48:47 2023 +0100 +++ b/ExtensionCorba/Documentation/source/Plugin_Extension_Corba.ExtensionCorba.ProjectInterfacesBrowser.html Sat Dec 23 19:43:44 2023 +0100 @@ -232,23 +232,29 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -filename of the .idl file to be compiled (string) +filename of the .idl file to be compiled </dd> -<dt><i>noDialog</i></dt> +<dt><i>noDialog</i> (bool)</dt> <dd> -flag indicating silent operations (boolean) +flag indicating silent operations </dd> -<dt><i>progress</i></dt> +<dt><i>progress</i> (EricProgressDialog)</dt> <dd> -reference to the progress dialog (EricProgressDialog) +reference to the progress dialog </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the compile process (QProcess) +reference to the compile process +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QProcess </dd> </dl> <a NAME="ProjectInterfacesBrowser.__compileIDLDone" ID="ProjectInterfacesBrowser.__compileIDLDone"></a> @@ -260,13 +266,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="ProjectInterfacesBrowser.__compileInterface" ID="ProjectInterfacesBrowser.__compileInterface"></a> @@ -365,9 +371,9 @@ </p> <dl> -<dt><i>coord</i></dt> +<dt><i>coord</i> (QPoint)</dt> <dd> -the position of the mouse pointer (QPoint) +the position of the mouse pointer </dd> </dl> <a NAME="ProjectInterfacesBrowser._createPopupMenus" ID="ProjectInterfacesBrowser._createPopupMenus"></a>
--- a/ExtensionCorba/LexerIDL.py Sat Dec 23 15:48:47 2023 +0100 +++ b/ExtensionCorba/LexerIDL.py Sat Dec 23 19:43:44 2023 +0100 @@ -23,6 +23,7 @@ Constructor @param parent parent widget of this lexer + @type QObject """ QsciLexerIDL.__init__(self, parent) Lexer.__init__(self) @@ -59,8 +60,10 @@ """ Public method to check, if a style is a comment style. - @param style style to check (integer) - @return flag indicating a comment style (boolean) + @param style style to check + @type int + @return flag indicating a comment style + @rtype bool """ return style in [ QsciLexerIDL.Comment, @@ -73,8 +76,10 @@ """ Public method to check, if a style is a string style. - @param style style to check (integer) - @return flag indicating a string style (boolean) + @param style style to check + @type int + @return flag indicating a string style + @rtype bool """ return style in [ QsciLexerIDL.DoubleQuotedString, @@ -87,8 +92,10 @@ """ Public method to get the default keywords. - @param kwSet number of the keyword set (integer) - @return string giving the keywords (string) or None + @param kwSet number of the keyword set + @type int + @return string giving the keywords or None + @rtype str """ return QsciLexerIDL.keywords(self, kwSet) @@ -96,6 +103,7 @@ """ Public method to get the maximum keyword set. - @return maximum keyword set (integer) + @return maximum keyword set + @rtype int """ return 4
--- a/ExtensionCorba/ProjectInterfacesBrowser.py Sat Dec 23 15:48:47 2023 +0100 +++ b/ExtensionCorba/ProjectInterfacesBrowser.py Sat Dec 23 19:43:44 2023 +0100 @@ -434,7 +434,8 @@ """ Protected slot to show the context menu. - @param coord the position of the mouse pointer (QPoint) + @param coord the position of the mouse pointer + @type QPoint """ if not self.project.isOpen(): return @@ -720,8 +721,10 @@ """ Private slot to handle the finished signal of the omniidl process. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ pixmapSuffix = "dark" if ericApp().usesDarkPalette() else "light" pixmap = EricPixmapCache.getPixmap( @@ -762,10 +765,14 @@ """ Private method to compile a .idl file to python. - @param fn filename of the .idl file to be compiled (string) - @param noDialog flag indicating silent operations (boolean) - @param progress reference to the progress dialog (EricProgressDialog) - @return reference to the compile process (QProcess) + @param fn filename of the .idl file to be compiled + @type str + @param noDialog flag indicating silent operations + @type bool + @param progress reference to the progress dialog + @type EricProgressDialog + @return reference to the compile process + @rtype QProcess """ params = self.project.getProjectData(dataKey="IDLPARAMS")
--- a/PluginCorba.epj Sat Dec 23 15:48:47 2023 +0100 +++ b/PluginCorba.epj Sat Dec 23 19:43:44 2023 +0100 @@ -66,7 +66,7 @@ "CopyrightAuthor": "", "CopyrightMinFileSize": 0, "DocstringType": "eric_black", - "EnabledCheckerCategories": "C, D, E, I, M, NO, N, Y, U, W", + "EnabledCheckerCategories": "C, D, E, I, L, M, NO, N, Y, U, W", "ExcludeFiles": "*/ThirdParty/*, */coverage/*, */Ui_*.py, */Examples/*, */pycodestyle.py,*/pyflakes/checker.py,*/mccabe.py,*/eradicate.py,*/ast_unparse.py,*/piplicenses.py,*/pipdeptree.py", "ExcludeMessages": "C101,E203,E265,E266,E305,E402,M201,M301,M302,M303,M304,M305,M306,M307,M308,M311,M312,M313,M314,M315,M321,M701,M702,M811,M834,M852,N802,N803,N807,N808,N821,W293,W503,Y119,Y401,Y402", "FixCodes": "",