I'm using YARD for my Ruby on Rails application documentation. I have simple model that looks like this:
# frozen_string_literal: true
# {Patient} is model responsible for storing patient personal informations.
#
# @!attribute id
# @return [UUID] ID of the {Patient} in UUID format.
#
# @!attribute name
# @return [String] Name of the {Patient}.
#
# @!attribute gender
# @return [String] Gender of the {Patient}.
#
# @!attribute date_of_birth
# @return [Date] Date of birth of the {Patient}.
#
# @!attribute created_at
# @return [DateTime] Time when {Patient} was created.
#
# @!attribute updated_at
# @return [DateTime] Time when {Patient} was updated.
class Patient < ApplicationRecord
# == Relationships ========================================================
belongs_to :organization
# == Validations ==========================================================
validates :name, presence: true
validates :date_of_birth, presence: true
validates :gender, inclusion: { in: Constants::GENDERS }
end
How can I document with YARD my Relationships and Validations? I saw that there is gem https://github.com/theodorton/yard-activerecord but it was not updated for 6 years.
