Opened 7 years ago
Closed 6 years ago
#4802 closed defect (worksforme)
Documentation html not composed correctly
| Reported by: | Owned by: | Adeel Asghar | |
|---|---|---|---|
| Priority: | high | Milestone: | 1.14.0 |
| Component: | OMEdit | Version: | v1.12.0 |
| Keywords: | Cc: |
Description
See attached screenshot, while html annotation for model documentation and revision is correct, the documentation browser shows the revision html a plain text at the end of the documentation - probably some small mistake in composing the html-string for the QTextBrowser widget.
Attachments (4)
Change History (12)
by , 7 years ago
| Attachment: | documentation_browser_bug.png added |
|---|
comment:1 by , 7 years ago
by , 7 years ago
| Attachment: | doc_render_bug_omedit_nightly_0.13.png added |
|---|
Bug persists on OMEdit 0.13 (nightly)
by , 7 years ago
| Attachment: | DocumentationWidget.html added |
|---|
The documentation html file generated by OM Edit and shown in the view. The HTML is wrong, the viewer works.
comment:4 by , 7 years ago
| Milestone: | Future → 1.13.0 |
|---|
comment:5 by , 7 years ago
On Ubuntu 16.04, building from source, the documentation html is generated correctly.
Code analysis:
The "revisions" doc block normally only holds an HTML formatted text, no pre and post plain text block. Therefore, the correctly generated HTML looks like:
Revisions
-
May 19, 2017, by Mirko Engelpracht:
Added missing documentation (see issue 391). -
October 17, 2016, by Philipp Mehrfeld:
Implemented especially for comparison to simple heat pump model.
with an empty <div class="textDoc"><p></div> block before and after the actual revision text.
The documentation block is generated by the script-API in function OpenModelicaScriptingAPIQt.cpp#OMCInterface::getDocumentationAnnotation(QString cl)
For some reason, the script generates an additional html block after the first html revision block, and that only on Ubuntu 17.10.
comment:7 by , 6 years ago
I just tested it with
Ubuntu 18.04.2 LTS
Qt 5.9.5
Everything seems to work fine.
by , 6 years ago
| Attachment: | DocumentationBrowser.png added |
|---|
comment:8 by , 6 years ago
| Resolution: | → worksforme |
|---|---|
| Status: | new → closed |
Reopen the ticket if the problem persists.
This seems to render correctly on my machine (Linux / nightly builds)