Document code with YARD

1 files changed, 11 insertions, 0 deletions

diff --git a/lib/gender.rb b/lib/gender.rb
index 9bd3b06..a4f1b60 100644
--- a/lib/gender.rb
+++ b/lib/gender.rb
@@ -1,13 +1,24 @@
 # frozen_string_literal: true
 
+# Gender class to handle gender-related operations.
 class Gender
+  # Constant representing male gender.
   MALE = 'male'
+
+  # Constant representing female gender.
   FEMALE = 'female'
 
+  # Returns all defined genders.
+  #
+  # @return [Array<String>] An array of all genders.
   def self.all
     [MALE, FEMALE]
   end
 
+  # Checks if the provided gender is valid.
+  #
+  # @param gender [String] The gender to validate.
+  # @return [Boolean] True if the gender is valid, false otherwise.
   def self.valid?(gender)
     return false unless gender.is_a?(String)