How to document Ruby code using Doxygen?

Question

Question: How can I document Ruby code using Doxygen?

Disclaimer: I know ruby already has a system for documentation built in and there are probably other ways to do it as well, but the specific constraint I am operating under is how to get Doxygen to do the job (assuming it is possible).

score 18 · Accepted Answer · answered Jun 29 '09 at 18:54

18

Short answer, no. Long answer, still no. Doxygen will come to Ruby eventually, but I don't have the sense that it's going to happen any time soon. In the short term, you're stuck with either RDoc or YARD.

answered Jun 29 '09 at 18:54

Pesto

23,810
2
71
76

Nice no-frills blunt answer. +1 – dreftymac Jun 29 '09 at 20:54
1

YARD is amazing, I'd go with that :) – Aram Kocharyan May 05 '13 at 13:28

score 2 · Answer 2 · answered Feb 06 '11 at 16:29

2

You can try out a testing version at https://github.com/fourmond/doxygen-ruby-patch. It is still experimental though, but through testing it will hopefully be integrated into mainstream doxygen.

answered Feb 06 '11 at 16:29

Vincent Fourmond

21
1

"fourmond authored 3 years ago", I guess this never went back into upstream? – JeanMertz Apr 14 '14 at 11:16

How to document Ruby code using Doxygen?

2 Answers2