Feature #1086

CにYARDで書くと@optionが効かない問題を調べる

Added by haruka yoshihara over 6 years ago. Updated almost 6 years ago.

Status:完了チェック待ちStart date:09/29/2011
Priority:HighDue date:10/06/2011
Assignee:haruka yoshihara% Done:

0%

Category:-
Target version:-

Description

h2. 問題

rroongaのCのソースコードにYARDでドキュメントを書くと、@paramに関しては生成されるが、その下に@optionを指定すると、@optionで指定した内容がドキュメントに表示されない。

h2. 期待する状態

Cのソースコードに@optionを指定すると正しくドキュメント化される。

h2. 解決方法

Cにドキュメントを書く。その後YARDのソースを見て原因を調べる。 もしくは他の書き方があるのかを調べる。

History

#1 Updated by haruka yoshihara over 6 years ago

  • Due date set to 10/06/2011
  • Priority changed from Normal to High

#2 Updated by haruka yoshihara almost 6 years ago

調べたところ、CのソースコードにYARDでドキュメントを書く場合、@overloadタグを用いてメソッド名や引数を指定しないとメソッド名や引数を認識できないというのがわかった。

参考:https://github.com/lsegal/yard/issues/524

そのため、@optionタグを使いたい場合は、まず@overloadタグを利用してメソッド名や引数を明示する必要がある。

#3 Updated by haruka yoshihara almost 6 years ago

  • Status changed from 新規 to 担当者作業中

#4 Updated by haruka yoshihara almost 6 years ago

  • Status changed from 担当者作業中 to 完了チェック待ち

Also available in: Atom PDF