ruby - Using Yard in Rails -


i'm using yard document rails api. on side using annotate annotate models database fields.

i have few problems.

1) tried give models overview in yard. when combining yard , annotate have noticed have put comment this:

# holds books of book store #  # == schema information # ... class book; end 

now when run annotate again overview comment placed above class declaration , schema information comes @ beginning of file somehow ignores schema information when generating documentation again. somehow yard not documentation structure this.

2) tried apply groups models. example:

# @!group relations  belongs_to :bookstore  has_many :readers  # @!endgroup relations 

but when generating docs somehow not displayed. know how solve these problems?

thanks!


Comments

Popular posts from this blog

aws api gateway - SerializationException in posting new Records via Dynamodb Proxy Service in API -

asp.net - Problems sending emails from forum -