diff -r 19970127c936 -r 47df4b69f699 RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexCalculator.html --- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexCalculator.html Sat May 27 15:34:14 2023 +0200 +++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexCalculator.html Wed Aug 30 13:20:08 2023 +0200 @@ -43,7 +43,7 @@ </tr> <tr> <td><a href="#maintainabilityIndex">maintainabilityIndex</a></td> -<td></td> +<td>Private function to calculate the maintainability index of one file.</td> </tr> <tr> <td><a href="#workerTask">workerTask</a></td> @@ -151,8 +151,34 @@ <hr /> <a NAME="maintainabilityIndex" ID="maintainabilityIndex"></a> <h2>maintainabilityIndex</h2> -<b>maintainabilityIndex</b>(<i>file, text=""</i>) +<b>maintainabilityIndex</b>(<i>file, text="", </i>) + +<p> + Private function to calculate the maintainability index of one file. +</p> +<dl> +<dt><i>file</i> (str)</dt> +<dd> +source filename +</dd> +<dt><i>text</i> (str)</dt> +<dd> +source text +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the result dictionary +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +(tuple of dict) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />