Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.UI.CodeDocumentationViewer.html
Documentation/Source/eric6.UI.CodeDocumentationViewer.html
- changeset 5961
- 2a5232311a65
- parent 5926
- 69482290dbdd
- child 6266
- c7bc0e516cd6
equal
deleted
inserted
replaced
| 5960:be837f440186 | 5961:2a5232311a65 |
|---|---|
| 182 <h4>CodeDocumentationViewer.documentationReady</h4> | 182 <h4>CodeDocumentationViewer.documentationReady</h4> |
| 183 <b>documentationReady</b>(<i>documentationInfo, isWarning=False, isDocWarning=False</i>) | 183 <b>documentationReady</b>(<i>documentationInfo, isWarning=False, isDocWarning=False</i>) |
| 184 <p> | 184 <p> |
| 185 Public method to provide the documentation info to the viewer. | 185 Public method to provide the documentation info to the viewer. |
| 186 </p><p> | 186 </p><p> |
| 187 If documentationInfo is a dictionary, it should contains these keys | 187 If documentationInfo is a dictionary, it should contain these |
| 188 and data: | 188 (optional) keys and data: |
| 189 </p><p> | 189 </p><p> |
| 190 name: the name of the inspected object | 190 name: the name of the inspected object |
| 191 argspec: its argspec | 191 argspec: its arguments specification |
| 192 note: A phrase describing the type of object (function or method) and | 192 note: A phrase describing the type of object (function or method) and |
| 193 the module it belongs to. | 193 the module it belongs to. |
| 194 docstring: its documentation string | 194 docstring: its documentation string |
| 195 typ: its type information | |
| 195 </p><dl> | 196 </p><dl> |
| 196 <dt><i>documentationInfo</i> (dict or str)</dt> | 197 <dt><i>documentationInfo</i> (dict or str)</dt> |
| 197 <dd> | 198 <dd> |
| 198 dictionary containing the source docu data | 199 dictionary containing the source docu data |
| 199 </dd><dt><i>isWarning</i> (bool)</dt> | 200 </dd><dt><i>isWarning</i> (bool)</dt> |
