Menu
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).
666
Once specified, you can generate the comment stub by typing the respective “///” or “/**” above a function, or by using the (Ctrl+/) shortcut.
Putting the command @brief will generate a short description of the function when you generate the doxygen documentation. That short description can be extended if you want.
To create a Doxygen comment from scratch: Type one of the following symbols: /// , //! , /** or /*! and press Enter .
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.
194
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
