CODEWITHSUNDEEP
mathjavadoc
Carl
Carl

Reputation: 7554

Javadoc with Equations?

I'm only familiar with the no-frills javadoc generator, however I'd like to include some mathematical equations in my javadoc (rather than constantly referencing another document).

Is there a convenient option to do something like include/properly render LaTeX (most preferred - then I could just cut-n-paste) or MathML tags?

Upvotes: 19

Views: 6093

Answers (3)

nsanders
nsanders

Reputation: 12656

Check out Doxygen.

It's blazing fast, free, and supports embedded LaTeX.

Upvotes: 4

apiri
apiri

Reputation: 1633

While I haven't done it personally, there are ways to create your own using the Doclet or Taglet API to create your own Doclet or Taglet. Several of these have already been done according to a quick search providing one such example http://www.ohloh.net/p/latextaglet

If you're feeling daring enough the latextaglet project is open source, so you might be able to further adapt it to your needs.

Upvotes: 0

duffymo
duffymo

Reputation: 308948

Maybe something like MathJax or jsMath could be your solution. They're both JavaScript libraries, so you'll have to find a way to add them into your javadocs pages.

Upvotes: 1

Related Questions