Search code examples
rubyyard

yard, How to include image to documentation?


I want to include image in yard-genereted documentation, but can't find anywhere how to do this... Does anyone know how to do this?


Solution

  • You can just add <img /> tag to your documentation:

     # Blah-blah 
     # 
     # <img src=img/1.png />
     # @param [String] blah
     # @return [String] blah
     def foo(bar) 
    
     end