You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@sis.apache.org by Martin Desruisseaux <de...@apache.org> on 2014/05/02 16:01:48 UTC

Mathematical formulas in javadoc

Hello all

JDK 8 javadoc tools performs much stricter checks on HTML validity
(which I think is good). However it rejects MathML as unknown HTML tags.
To work around this issue, I moved MathML formulas in a separated file
[1] and introduced a new javadoc taglet, {@include}, for including
portion of an external document. OpenJDK is also considering to add such
{@include} taglet in the standard tool [2], so our custom taglet may
just be anticipating.

A side effect of this change is to simplify the Java source files, since
MathML formulas tend to be quite verbose.

    Martin


[1]
http://svn.apache.org/repos/asf/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/formulas.html
[2]
http://mail.openjdk.java.net/pipermail/javadoc-dev/2014-March/000122.html