Opened 7 years ago

Closed 5 years ago

#4802 closed defect (worksforme)

Documentation html not composed correctly

Reported by: andreas.nicolai@… Owned by: adeas31
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)

documentation_browser_bug.png (479.1 KB) - added by Andreas Nicolai <andreas.nicolai@…> 7 years ago.
doc_render_bug_omedit_nightly_0.13.png (554.6 KB) - added by Andreas Nicolai <andreas.nicolai@…> 7 years ago.
Bug persists on OMEdit 0.13 (nightly)
DocumentationWidget.html (1.9 KB) - added by Andreas Nicolai <andreas.nicolai@…> 7 years ago.
The documentation html file generated by OM Edit and shown in the view. The HTML is wrong, the viewer works.
DocumentationBrowser.png (331.9 KB) - added by adeas31 6 years ago.

Download all attachments as: .zip

Change History (12)

Changed 7 years ago by Andreas Nicolai <andreas.nicolai@…>

comment:1 Changed 7 years ago by sjoelund.se

This seems to render correctly on my machine (Linux / nightly builds)

Changed 7 years ago by Andreas Nicolai <andreas.nicolai@…>

Bug persists on OMEdit 0.13 (nightly)

comment:2 Changed 7 years ago by sjoelund.se

And your OS version is?

comment:3 Changed 7 years ago by Andreas Nicolai <andreas.nicolai@…>

Ubuntu 17.10

Using Qt version 5.9.1 in /usr/lib/x86_64-linux-gnu

Changed 7 years ago by Andreas Nicolai <andreas.nicolai@…>

The documentation html file generated by OM Edit and shown in the view. The HTML is wrong, the viewer works.

comment:4 Changed 7 years ago by sjoelund.se

  • Milestone changed from Future to 1.13.0

comment:5 Changed 7 years ago by Andreas Nicolai <andreas.nicolai@…>

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:6 Changed 6 years ago by casella

  • Milestone changed from 1.13.0 to 1.14.0

Rescheduled to 1.14.0 after 1.13.0 releasee

comment:7 Changed 6 years ago by adeas31

I just tested it with

Ubuntu 18.04.2 LTS
Qt 5.9.5

Everything seems to work fine.

Changed 6 years ago by adeas31

comment:8 Changed 5 years ago by adeas31

  • Resolution set to worksforme
  • Status changed from new to closed

Reopen the ticket if the problem persists.

Note: See TracTickets for help on using tickets.