.yardopts
ファイルに次のようなカスタム タグをいくつか作成しました。
--name-tag optfield:"Field that is not required to be filled out by the user."
--name-tag nonfield:"Parameter that is not a field to be filled out by the user."
それらを Web ブラウザーで表示すると非常にきれいに表示されますが、クラスを表示しようとするとyri
、カスタム タグが表示されません。
たとえば、このクラス
#This is a boring class
class Boring
# This function is the index.
# @param required_field [String] Required!
# @optfield optional_argument [String] Totally not required dude.
# @nonfield webData [WebData] Not even an option.
def index(optional_argument = "", webData = $wedData)
end
end
yri
実行するとこのように表示されますyri Boring#index
------------------------------------------------ Method: #index (Boring)
(Defined in: YardTest.rb)
boring.index(optional_argument = "", webData = $wedData) -> Object
------------------------------------------------------------------------
This function is the index.
Parameters:
-----------
(String) required_field - Required!
yri
カスタム タグを表示するように構成する方法はありますか?