Латекс Javadoc поколения - PullRequest
6 голосов
/ 03 мая 2011

Есть ли способ создать латексный документ из документации моего исходного файла java? Я не хочу включать элементы LaTeX в комментарии к документации, я просто хочу создавать файлы LaTeX вместо HTML.

Спасибо

Ответы [ 3 ]

6 голосов
/ 03 мая 2011

Альтернативой Texdoclet является ltxdoclet, который я создал.

Я думаю, что основное отличие состоит в том, что он также включает в себя исходный код, а не только комментарии Javadoc, хотя вы можетеотключите это.

Это не очень хорошо задокументировано на сайте github - просто загрузите код и выполните ant pdfdoku для примера вывода (ant latexdoku, если вам нужны только файлы LaTeX).(Хотя это задокументировано на немецком языке.)

Я действительно должен добавить туда файл readme.


А пока, вот файл jar - скачатьэто где-то, а затем используйте

 javadoc -docletpath ltxdoclet.jar -doclet de.dclj.paul.ltxdoclet.DocletStart -help

, чтобы увидеть список доступных опций.(Это будет на немецком языке, если у вас нет английской локали. Добавьте префикс «LC_ALL = en_US» или аналогичный для bash, чтобы получить английскую версию, или вместо этого посмотрите help_en.txt , если вы нене знаю немецкого.)

Я работаю над веб-страницей с дополнительной документацией, но я не уверен, когда она будет готова.


Теперь у нас есть веб-страница тоже.Он связывает файл jar, а также в качестве примера javadocs применительно к себе .

4 голосов
/ 03 мая 2011

Texdoclet , кажется, то, что вам нужно.Что касается того, как его использовать: как и любой другой доклет .

0 голосов
/ 07 декабря 2018

Если вы не хотите полагаться на какую-либо зависимость от doclet, а скорее на javascript, вы можете просто добавить следующий параметр javadoc:

-header "<script type='text/javascript' src='http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>"

и просто используйте чистый латекс внутри ваших комментариев, таких как \(\sum_i a_i\) или \[\sum_i a_i\]

...