Сборка Ruby документации для классов Java / Source - PullRequest
3 голосов
/ 21 февраля 2012

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

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

1 Ответ

2 голосов
/ 21 февраля 2012

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

https://github.com/enebo/noridoc

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

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

...