Mercurial Repositories > Radon Code Metrics / changeset
changeset
Converted some source code documentation to the new style.
Sat, 23 Dec 2023 16:11:05 +0100
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Sat, 23 Dec 2023 16:11:05 +0100
- branch
- eric7
- changeset 111
- 897c71cbc967
- parent 110
- 261babeb7cc6
- child 112
- df1e86e89b24
Converted some source code documentation to the new style.
--- a/PluginMetricsRadon.epj Sat Dec 23 15:48:48 2023 +0100 +++ b/PluginMetricsRadon.epj Sat Dec 23 16:11:05 2023 +0100 @@ -66,9 +66,9 @@ "CopyrightAuthor": "", "CopyrightMinFileSize": 0, "DocstringType": "eric_black", - "EnabledCheckerCategories": "C, D, E, I, M, NO, N, S, Y, U, W", + "EnabledCheckerCategories": "C, D, E, I, L, M, NO, N, S, Y, U, W", "ExcludeFiles": "*/Ui_*.py, */*_rc.py", - "ExcludeMessages": "C101,E265,E266,E305,E402,M201,M301,M302,M303,M304,M305,M306,M307,M308,M311,M312,M313,M314,M315,M321,M701,M702,M811,M834,N802,N803,N807,N808,N821,U200,W293,W503,Y119,Y401,Y402", + "ExcludeMessages": "C101,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,U200,W293,W503,Y119,Y401,Y402", "FixCodes": "", "FixIssues": false, "FutureChecker": "",
--- a/RadonMetrics/CodeMetricsCalculator.py Sat Dec 23 15:48:48 2023 +0100 +++ b/RadonMetrics/CodeMetricsCalculator.py Sat Dec 23 16:11:05 2023 +0100 @@ -15,7 +15,8 @@ """ Initialize the service and return the entry point. - @return the entry point for the background client (function) + @return the entry point for the background client + @rtype function """ return rawCodeMetrics @@ -24,7 +25,8 @@ """ Initialize the batch service and return the entry point. - @return the entry point for the background client (function) + @return the entry point for the background client + @rtype function """ return batchRawCodeMetrics
--- a/RadonMetrics/CyclomaticComplexityCalculator.py Sat Dec 23 15:48:48 2023 +0100 +++ b/RadonMetrics/CyclomaticComplexityCalculator.py Sat Dec 23 16:11:05 2023 +0100 @@ -15,7 +15,8 @@ """ Initialize the service and return the entry point. - @return the entry point for the background client (function) + @return the entry point for the background client + @rtype function """ return cyclomaticComplexity @@ -24,7 +25,8 @@ """ Initialize the batch service and return the entry point. - @return the entry point for the background client (function) + @return the entry point for the background client + @rtype function """ return batchCyclomaticComplexity
--- a/RadonMetrics/CyclomaticComplexityDialog.py Sat Dec 23 15:48:48 2023 +0100 +++ b/RadonMetrics/CyclomaticComplexityDialog.py Sat Dec 23 16:11:05 2023 +0100 @@ -604,7 +604,8 @@ """ Private slot to show the context menu of the resultlist. - @param coord the position of the mouse pointer (QPoint) + @param coord the position of the mouse pointer + @type QPoint """ if self.resultList.topLevelItemCount() > 0: self.__menu.popup(self.mapToGlobal(coord))
--- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CodeMetricsCalculator.html Sat Dec 23 15:48:48 2023 +0100 +++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CodeMetricsCalculator.html Sat Dec 23 16:11:05 2023 +0100 @@ -158,7 +158,13 @@ <dl> <dt>Return:</dt> <dd> -the entry point for the background client (function) +the entry point for the background client +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +function </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -174,7 +180,13 @@ <dl> <dt>Return:</dt> <dd> -the entry point for the background client (function) +the entry point for the background client +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +function </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CyclomaticComplexityCalculator.html Sat Dec 23 15:48:48 2023 +0100 +++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CyclomaticComplexityCalculator.html Sat Dec 23 16:11:05 2023 +0100 @@ -227,7 +227,13 @@ <dl> <dt>Return:</dt> <dd> -the entry point for the background client (function) +the entry point for the background client +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +function </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -243,7 +249,13 @@ <dl> <dt>Return:</dt> <dd> -the entry point for the background client (function) +the entry point for the background client +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +function </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CyclomaticComplexityDialog.html Sat Dec 23 15:48:48 2023 +0100 +++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CyclomaticComplexityDialog.html Sat Dec 23 16:11:05 2023 +0100 @@ -338,9 +338,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="CyclomaticComplexityDialog.clear" ID="CyclomaticComplexityDialog.clear"></a>
--- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexCalculator.html Sat Dec 23 15:48:48 2023 +0100 +++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexCalculator.html Sat Dec 23 16:11:05 2023 +0100 @@ -127,7 +127,13 @@ <dl> <dt>Return:</dt> <dd> -the entry point for the background client (function) +the entry point for the background client +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +function </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -143,7 +149,13 @@ <dl> <dt>Return:</dt> <dd> -the entry point for the background client (function) +the entry point for the background client +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +function </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.RawMetricsDialog.html Sat Dec 23 15:48:48 2023 +0100 +++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.RawMetricsDialog.html Sat Dec 23 16:11:05 2023 +0100 @@ -236,13 +236,13 @@ </p> <dl> -<dt><i>col0</i></dt> +<dt><i>col0</i> (str)</dt> <dd> -string for column 0 (string) +string for column 0 </dd> -<dt><i>col1</i></dt> +<dt><i>col1</i> (str)</dt> <dd> -string for column 1 (string) +string for column 1 </dd> </dl> <a NAME="RawMetricsDialog.__finish" ID="RawMetricsDialog.__finish"></a>
--- a/RadonMetrics/MaintainabilityIndexCalculator.py Sat Dec 23 15:48:48 2023 +0100 +++ b/RadonMetrics/MaintainabilityIndexCalculator.py Sat Dec 23 16:11:05 2023 +0100 @@ -15,7 +15,8 @@ """ Initialize the service and return the entry point. - @return the entry point for the background client (function) + @return the entry point for the background client + @rtype function """ return maintainabilityIndex @@ -24,7 +25,8 @@ """ Initialize the batch service and return the entry point. - @return the entry point for the background client (function) + @return the entry point for the background client + @rtype function """ return batchMaintainabilityIndex
--- a/RadonMetrics/RawMetricsDialog.py Sat Dec 23 15:48:48 2023 +0100 +++ b/RadonMetrics/RawMetricsDialog.py Sat Dec 23 16:11:05 2023 +0100 @@ -495,8 +495,10 @@ """ Private slot to create a new item in the summary list. - @param col0 string for column 0 (string) - @param col1 string for column 1 (string) + @param col0 string for column 0 + @type str + @param col1 string for column 1 + @type str """ itm = QTreeWidgetItem(self.summaryList, [col0, col1]) itm.setTextAlignment(1, Qt.AlignmentFlag.AlignRight)
