Though sometimes it happens especially when having different systems.). Is, in my opinion, not valid, developers should test their code / generated the documentation before committing it (one shouldn't commit code that doesn't compile either. Theīut 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 The cases like " it might be missing images" would possibly result in formulas at the wrong place (and when not corrected confuse the reader even more than in case the bare LaTeX code is shown. I think that your formulation:Įither case is caught with error codes and does not seem to impact the final output other than it might be missing images, images with incorrect formatting, or images out of order if a page in the _formulas.tex is skipped. still generating the images in subsequent steps). Regarding continuing after and error (i.e. The formulation is not correct either as it would also be used for RTF and Docbook output as well. I don't see any reason anymore to leave this handling in the code / documentation as now always the -interaction=batchmode is used (this makes sense to me for the reasons mentioned in my original comment, when it wouldn't make sense the -interaction=batchmode should be removed again). It has been forgotten to remove the LATEX_BATCHMODE for the formulas (like I didn't see it when I wrote my initial comment). Though this is probably a low priority issue since it's only useful for debugging.Ĭommit: 10b2b8fc694b60a17ccd2642f3a40c851e33b9da 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. 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. 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. Either case is caught with error codes and does not seem to impact the final output other than it might be missing images, images with incorrect formatting, or images out of order if a page in the _formulas.tex is skipped. Seems like they either succeed, or something goes wrong and images are generated incorrectly or error out and do not get generated. What are the possible outcomes of generating latex equation images? Maybe an update or clarification is needed? I see in the code that -interaction=batchmode is passed in, however it looks like it was added only 18 months ago. This statement is confusing if the LATEX_BATCHMODE is not actually used. This option is also used when generating formulas in HTML. It is not known what will happen in the different stages when we would continue after an error as it is not known what the effect of an error is and what the severity is (the test case looks like to give still reasonable output), the safest is to stop generating the images. Why is the choice for the termination of the generation of the formulas?Īll the formulas are in one go converted from the tex version to a dvi file (so latex only has to be invoked only once, a speed issue). The LATEX_BATCHMODE is useful in automatic processes where also a pdf is generated. The LATEX_BATCHMODE is only for generation of the pdf in the latex directory (so the user can choose to stop at the first error and handle it or continue and scan the log file). The generation of formulas by means of LaTeX is always done in batchmode, otherwise the doxygen generation process would hang on an incorrect formula. This tag requires that the tag GENERATE_LATEX is set to YES. This will instruct LATEX to keep running if errors occur, instead of asking the LATEX_BATCHMODE If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode command Executing external command `latex -interaction=batchmode _formulas.tex >/dev/nullĪnd when setting LATEX_BATCHMODE=NO this is still the case.
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |