diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.UI.CodeDocumentationViewerTemplate.html --- a/eric6/Documentation/Source/eric6.UI.CodeDocumentationViewerTemplate.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.UI.CodeDocumentationViewerTemplate.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,96 +18,122 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.UI.CodeDocumentationViewerTemplate</h1> + <p> Module implementing functions to prepare an HTML documentation view. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Functions</h3> + <table> + <tr> <td><a href="#prepareDocumentationViewerHtmlDocWarningDocument">prepareDocumentationViewerHtmlDocWarningDocument</a></td> <td>Public function to prepare a HTML warning document.</td> -</tr><tr> +</tr> +<tr> <td><a href="#prepareDocumentationViewerHtmlDocument">prepareDocumentationViewerHtmlDocument</a></td> <td>Public function to prepare the HTML document.</td> -</tr><tr> +</tr> +<tr> <td><a href="#prepareDocumentationViewerHtmlWarningDocument">prepareDocumentationViewerHtmlWarningDocument</a></td> <td>Public function to prepare a HTML warning document.</td> </tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="prepareDocumentationViewerHtmlDocWarningDocument" ID="prepareDocumentationViewerHtmlDocWarningDocument"></a> <h2>prepareDocumentationViewerHtmlDocWarningDocument</h2> <b>prepareDocumentationViewerHtmlDocWarningDocument</b>(<i>text</i>) + <p> Public function to prepare a HTML warning document. -</p><dl> +</p> +<dl> + <dt><i>text</i> (str)</dt> <dd> warning text to be shown </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> prepared HTML document </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="prepareDocumentationViewerHtmlDocument" ID="prepareDocumentationViewerHtmlDocument"></a> <h2>prepareDocumentationViewerHtmlDocument</h2> <b>prepareDocumentationViewerHtmlDocument</b>(<i>documentationInfo</i>) + <p> Public function to prepare the HTML document. -</p><dl> +</p> +<dl> + <dt><i>documentationInfo</i> (dict)</dt> <dd> dictionary containing the various documentation parts </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> prepared HTML document </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="prepareDocumentationViewerHtmlWarningDocument" ID="prepareDocumentationViewerHtmlWarningDocument"></a> <h2>prepareDocumentationViewerHtmlWarningDocument</h2> <b>prepareDocumentationViewerHtmlWarningDocument</b>(<i>text</i>) + <p> Public function to prepare a HTML warning document. -</p><dl> +</p> +<dl> + <dt><i>text</i> (str)</dt> <dd> warning text to be shown </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> prepared HTML document </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str