Двор и С расширение

Question

У меня есть расширение C ruby, которое я документирую с помощью rdoc. Существуют как файлы C, так и файлы ruby, которые анализируются с помощью rdoc.

Может ли ярд сделать то же самое, и существует ли "легкий путь" (я имею в виду наиболее часто используемый способ) для перехода от rdoc во двор?

Answer 1

Как сказал @Neil Slater, Yard может анализировать документацию в стиле rdoc с одним исключением: :call-seq тег от rdoc. Его эквивалент @overload со двора. (см. rdoc, darkfish и тег:call-seq:)

Для меня я использовал задачу Rake для генерации документации rdoc:

require "rdoc/task"

RDOC_FILES = FileList["README.rdoc", "ext/clangc/clangc.c", "ext/clangc/constants.c", "ext/clangc/class_Index.c", "ext/clangc/class_TranslationUnit.c", "lib/clangc.rb"]

Rake::RDocTask.new do |rd|
  rd.main = "README.rdoc"
  rd.rdoc_dir = "doc"
  rd.rdoc_files.include(RDOC_FILES)
end

Я просто должен запустить rake rdoc

Чтобы использовать Yard вместо этого, мне просто нужно создать задачу Rake:

require "yard"
YARD_FILES = FileList["ext/clangc/clangc.c", "ext/clangc/class_Index.c", "ext/clangc/class_TranslationUnit.c", "lib/clangc.rb"]

YARD::Rake::YardocTask.new do |t|
  t.files   = YARD_FILES   # optional
  t.options = %w(-o yard_documentation --readme README.rdoc) # optional
end

Тогда я использую rake yard, Есть еще некоторые ошибки, но это хорошее начало.