Opened 14 years ago
Last modified 14 years ago
#1446 closed defect (fixed)
OMEdit does not show non-HTML documentation
| Reported by: | Per Östlund | Owned by: | Per Östlund |
|---|---|---|---|
| Priority: | high | Milestone: | |
| Component: | Version: | ||
| Keywords: | Cc: | Per Östlund, Adeel Asghar |
Description
OMEdit does not seem to show non-HTML documentation, such as in any of the Modelica.Math.Matrices.LAPACK classes.
Change History (8)
comment:1 by , 14 years ago
comment:2 by , 14 years ago
I will push a change in a little while that will make:
getDocumentationAnnotation(Modelica.Math.Matrices.LAPACK.dgeev);
return the correct string.
We haven't looked inside external declarations for the documentation annotations!
comment:3 by , 14 years ago
- partially fixed in revsion: 8148, see SCM Commits tab.
- now omc returns the documentation annotation from the external declaration.
- checks with OMEdit are needed to see if it works properly.
comment:4 by , 14 years ago
Ok, with Adrians changes OMEdit now shows the documentation. The formatting is not preserved though, which makes the documentation for the LAPACK models pretty much unreadable. This seems to be an issue with OMEdit, since the formatting is preserved in the test case Adrian added.
comment:5 by , 14 years ago
Yes, OMEdit should check if the string starts/ends with <html> and if not, preserve
the formatting, i.e. you could add pre (verbose) tags so that the html editor knows that
it need to preserve the formatting.
<pre> documentation that needs preserving </pre>
yes beacuse OMEdit uses the getDocumentationAnnotation API and since getDocumentaitonAnnotaiton API only reads the HTML section of the documentation annotation. I will check the API list and see if there is any command to get the full documentation.