diff -r c4c17121eff8 -r a21d673a8f99 eric6/Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html --- a/eric6/Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html Sat Jan 16 16:51:23 2021 +0100 @@ -239,7 +239,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the deprecation status (boolean) </dd> @@ -262,7 +262,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> formatted entry (string) </dd> @@ -282,9 +282,9 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> -The formated contents of the documentation string. (string) +The formatted contents of the documentation string. (string) </dd> </dl> <dl> @@ -304,7 +304,7 @@ module. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The classes list section. (string) </dd> @@ -318,7 +318,7 @@ classes. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The classes details section. (string) </dd> @@ -343,7 +343,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The list section. (string) </dd> @@ -357,7 +357,7 @@ module. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The functions list section. (string) </dd> @@ -371,7 +371,7 @@ functions. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The functions details section. (string) </dd> @@ -392,7 +392,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The globals list section. (string) </dd> @@ -421,7 +421,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list section (string) </dd> @@ -449,7 +449,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> method list and method details section (tuple of two string) </dd> @@ -487,7 +487,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> methods list section (string) </dd> @@ -500,7 +500,7 @@ Private method to generate the body of the document. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The body of the document. (string) </dd> @@ -525,7 +525,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> Ready formatted paragraphs. (string) </dd> @@ -546,7 +546,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> formatted list section (string) </dd> @@ -576,7 +576,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The list section. (string) </dd> @@ -600,7 +600,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The classes list and classes details section. (tuple of two string) @@ -615,7 +615,7 @@ (Ruby only). </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The modules list section. (string) </dd> @@ -629,7 +629,7 @@ Ruby modules. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The Ruby modules details section. (string) </dd> @@ -654,7 +654,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The list section. (string) </dd> @@ -678,7 +678,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The short description. (string) </dd> @@ -698,7 +698,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> processed line with inline tags expanded (string) </dd> @@ -718,7 +718,7 @@ Public method used to get the description of the module. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The description of the module. (string) </dd> @@ -731,7 +731,7 @@ Public method to generate the source code documentation. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The source code documentation. (string) </dd> @@ -744,7 +744,7 @@ Public method to retrieve the parts for the QtHelp keywords section. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of tuples containing the name (string) and the ref (string). The ref is without the filename part. @@ -759,7 +759,7 @@ functions. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> Flag indicating an empty module (i.e. __init__.py without any contents) @@ -773,7 +773,7 @@ Public method used to get the module name. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The name of the module. (string) </dd> @@ -790,7 +790,7 @@ description. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The short description of the module. (string) </dd>