야드, 문서에 이미지를 포함시키는 방법?

Question

야드 생성 문서에 이미지를 포함시키고 싶지만 어디서나 찾을 수는 없습니다 ...이 작업을 수행하는 방법을 아는 사람이 있습니까?

Answer 1

당신은 당신의 문서를 <img /> 태그를 추가 할 수 있습니다

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

end 

Answer 2

마크 업 형식에 따라 다른 메커니즘을 사용 할 수 있습니다. 예를 들어 Markdown을 사용하는 경우 구문은 ![Alt text](/path/to/img.jpg)입니다. RDoc에서 img 태그가 작동해야하지만 특별한 마크 업 구문이 추가되었는지 확인할 수 있습니다. RDoc은 아마도 XHTML을 좋아하지 않을 것입니다 (잘 모름). 끝이없는 /를 사용해야합니다.

Answer 3

사용 rdoc-image: 링크 :

# Gets foo. 
# 
# rdoc-image:img/1.png 
def foo(bar) 
    "foo" 
end 

는

rdoc-images:는 독립 *.rdoc 파일에서 작동

<p>Gets foo.</p> 
<p><img src="img/1.png"></p> 

에 YARD에 의해 렌더링됩니다.