Project

General

Profile

Meeting #233

Create a doxygen main page and verify if the latex formulas are working correctly

Added by André Neto over 9 years ago. Updated almost 6 years ago.

Status:
Closed
Priority:
Normal
Target version:
-
Start date:
29.09.2015
Due date:
% Done:

0%

Estimated time:

Description

Doxygen is able to interpret latex formulas and converting them into a readable format using externals tools or, in the case of HTML, a JavaScript library called MathJax. In order to use the MathJax feature, the doxygen configuration file must have the property USE_MATHJAX set to YES.


Related issues

related to Meeting #227: MARTe 2 Sprint report (v0.5)Closed08.09.201529.09.2015

Associated revisions

Revision fe34a1b5 (diff)
Added by Ivan Herrero about 9 years ago

#233 - Set Doxygen's MATHJAX_RELPATH property using an https prefix
instead of an http one. Otherwise, when MathJax is loaded from a web
page that is served using HTTPS, the URL is blocked by the browser for
security reasons.

History

#1 Updated by Ivan Herrero over 9 years ago

  • Parent task deleted (#227)

#2 Updated by Ivan Herrero over 9 years ago

  • related to Meeting #227: MARTe 2 Sprint report (v0.5) added

#3 Updated by Ivan Herrero about 9 years ago

  • Description updated (diff)

#4 Updated by Ivan Herrero about 9 years ago

The Doxygen's USE_MATHJAX property has been set to YES, so the HTML generated by Doxygen uses the MathJax feature.

Moreover, the Doxygen's MATHJAX_RELPATH property has been set using an https prefix instead of an http one, otherwise when MathJax is loaded from a web page that is served using HTTPS, the URL is blocked by the browser for security reasons.

Note: The MathJax feature into the HTML page is enabled importing the script http://cdn.mathjax.org/mathjax/latest/MathJax.js and configuring a javaScript object called MathJax.Hub.Config. This is done automatically by Doxygen when USE_MATHJAX property is set to YES.

Note: The MathJax library is documented at https://www.mathjax.org/.

#5 Updated by André Neto almost 6 years ago

  • Status changed from New to Closed

Also available in: Atom PDF