RDOC, Darkfish и A: Call-Seq: Tag

Question

Я в процессе документирования проекта Ruby RDOC, и я обнаружил Darkfish RDOC Formatter. Мне очень нравится это, но :call-seq: Тег больше не работает. Вместо этого он ставит буквальную строку :call-seq: В документации и затем форматирует саму последовательность вызовов в качестве блока кода. Я не хочу просто взять все: Call-Seq: блокирует мой код, так как большая часть моей документации должна обратиться к именам экземпляров и имена параметров, приведенных в :call-seq: блокировать. У кого-нибудь еще возникла такая проблема? Что мне делать, и есть обходной путь? Я уверен, что :call-seq: Тег работала до того, как я использовал Formatter по умолчанию, но я не могу быть уверен, потому что я не могу выяснить, как вернуться к созданию оригинального формата (вызов RDOC без аргументов, кроме файлов, генерирующих вывод данных сейчас, даже если Я удаляю папку DOC!) Кто-нибудь знает, как это исправить?

Answer 1

Я настоятельно рекомендую перейти от RDOC до ПЛОЩАДКА. Отказ Это не поддерживает старый сам Call-Seq, но вместо этого есть теги, и особенно @overload. Тег вышел, заменит call-seq. Вся документация на Rubydoc.info. также генерируется с использованием двора.

Вот пример для @overload из двора документации:

# @overload set(key, value)
#   Sets a value on key
#   @param [Symbol] key describe key param
#   @param [Object] value describe value param
# @overload set(value)
#   Sets a value on the default key `:foo`
#   @param [Object] value describe value param
def set(*args)
end