Создание документации Ruby для классов/исходного кода Java

Поскольку я недавно начал использовать JRuby, а точнее создавать приложения Java с использованием кода Ruby, я начал использовать библиотеки Java, такие как LWJGL и Slick.

Я знаю, что JRuby меняет имена методов Java на более рубиновую структуру, мой вопрос в том, есть ли какой-либо текущий способ генерировать документацию Ruby либо из исходного кода, либо путем преобразования текущей документации, либо даже на основе того, что JRuby предоставляет сами методы как?


person Port3M5    schedule 20.02.2012    source источник


Ответы (1)


В какой-то момент, когда JRuby 1.6.7 выйдет, я планирую очистить этот действительно грубый проект именно для такой вещи:

https://github.com/enebo/noridoc

Намерение состоит в том, что он объединит синтаксис Java и Ruby и предоставит разумную документацию для рубиста, желающего знать все методы Ruby. В его текущей форме вы должны быть в состоянии сгенерировать разумный набор HTML-документов кода Java, показывающих вам все методы с псевдонимами ruby. Вам нужно будет повозиться с комментарием javadoc.

О, и мы планируем сделать этот инструмент доступным из коробки в JRuby, как только он будет достаточно хорош для слияния.

person Thomas Enebo    schedule 20.02.2012