New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Embedded latex images not generated when any error occurs in _formulas.tex when LATEX_BATCHMODE = YES #8604
Comments
When looking at the debufg output with
and on linux type systems:
and when setting From the documentation:
The generation of formulas by means of LaTeX is always done in batchmode, otherwise the doxygen generation process would hang on an incorrect formula. The Why is the choice for the termination of the generation of the formulas? |
Regarding Documentation
This statement is confusing if the Regarding error cases I can see how this does not fit all situations, but for projects with many developers it can become difficult to debug doxygen generation on ones own code when others may have an error in a project. Would you consider adding a configuration tag to allow continuing latex formula image generation on errors? For a large percentage of the cases with small latex syntax errors, an output will still be generated, it just may not be what is desired. Maybe a long term goal could be changing how each equation is linked to a source file in Doxygen rather than page number of the dvi file? Maybe use dvips -i option to split into multiple files based on section with a section named after the Doxygen source name? That way, if a single equation is not rendered and that page is skipped, the indexes do not shift. Though this is probably a low priority issue since it's only useful for debugging. |
|
Regarding the usage of the usage in the formulas of |
While I agree if this is an ideal world, in reality this is not always the case. I don't necessarily agree its easy to locate a problem in _formulas.log since latex error logs can be very verbose for small issues. It can also add unnecessary burden to developers to fix all other issues before testing their own. This becomes even more an issue when previous version of Doxygen (I am not sure of the exact version) did not error out in this manor and generated the images even with latex errors. So for a mixed group of developers some may commit small errors not easily caught by eye on their system (where the images are generated with errors) versus a developer were it does not produce any images due to errors. Due to this change in functionality, does it seem unreasonable to add an override of the new functionality and allow generating images with latex errors reported (but default it to the new functionality)? |
I am also having this issue, and would like to have a switch to allow some errors. I work in a large project (1500+ source files) with ~20 developers, so it isn't always feasible to expect all docs to have proper LaTeX. Especially since there isn't a way to check the LaTeX syntax in the editor. |
issue #8604 `LATEX_BATCHMODE` not used for formulas anymore
Code has been integrated in master on GitHub (please don't close the issue as this will be done at the moment of an official release). |
This issue was previously marked 'fixed but not released', |
Describe the bug
Latex images are not generated when LATEX_BATCHMODE = YES and there is an error with one of the equations
Expected behavior
Only equations with errors are not generated correctly
To Reproduce
See example here: doxygen_latex_bug.tar.gz
Version
Compiled from source.
1.9.2 (6fc45ba)
Distributor ID: Ubuntu
Description: Ubuntu 20.04.2 LTS
Release: 20.04
Codename: focal
Additional context
I believe the issue is due to the if statement here:
doxygen/src/formula.cpp
Lines 198 to 205 in 592aaa4
The text was updated successfully, but these errors were encountered: