Hi Luc. > > [...] > > > > Talking about monstrosity, HTML beats LaTeX by far (IMHO). > > The rule could be that only single formula can documented with LaTeX. > > > > My proposal is in line with using "xml" in the user guide. Instead of LaTeX > > it could some other markup language that can properly represents > > mathematical notation. I'm afraid that LaTeX is the most readable of all. > > A tool would able to automatically convert the <chosen_format> into an image > > for inclusion in the generated documention (as is done for the user manual). > > This does make sense in the user manual, but not in javadoc. We are > stuck with the general javadoc tool here. > > For user manual, we thought about introducing mathml a while ago, but as > there was no support for it in maven, we gave up.
I understand that there are limitations that are maybe impossible to overcome. It was just an idea. It was meant to be balanced with the ugliness of long variable names in mathematical formulae[1] as this is the primary aim of in-code documentation. Then, if we *could* have an automated conversion tool that would insert a PNG figure inside the generated documnetation, it would be far more readable than the mix of math and pseudo-code that we have now. Best, Gilles [1] Expressed in LaTeX, such a formula is still fairly legible IMO. --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org For additional commands, e-mail: dev-h...@commons.apache.org
