Documentation for modules and classes

Author: anakinj

.rubocop.yml

@@ -6,9 +6,6 @@ AllCops:
     - 'gemfiles/*.gemfile'
     - 'vendor/**/*'
 
-Style/Documentation:
-  Enabled: false
-
 Metrics/AbcSize:
   Max: 25
 

lib/jwt/deprecations.rb

@@ -2,6 +2,7 @@
 
 module JWT
   # Deprecations module to handle deprecation warnings in the gem
+  # @api private
   module Deprecations
     class << self
       def context

lib/jwt/encoded_token.rb

@@ -111,15 +111,15 @@ def valid_signature?(algorithm:, key:)
     def decode_payload
       raise JWT::DecodeError, 'Encoded payload is empty' if encoded_payload == ''
 
-      if unecoded_payload?
+      if unencoded_payload?
         verify_claims!(crit: ['b64'])
         return parse_unencoded(encoded_payload)
       end
 
       parse_and_decode(encoded_payload)
     end
 
-    def unecoded_payload?
+    def unencoded_payload?
       header['b64'] == false
     end
 

lib/jwt/json.rb

@@ -3,7 +3,7 @@
 require 'json'
 
 module JWT
-  # JSON wrapper
+  # @api private
   class JSON
     class << self
       def generate(data)

lib/jwt/jwa/ecdsa.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # ECDSA signing algorithm
     class Ecdsa
       include JWT::JWA::SigningAlgorithm
 

lib/jwt/jwa/eddsa.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # Implementation of the EdDSA family of algorithms
     class Eddsa
       include JWT::JWA::SigningAlgorithm
 

lib/jwt/jwa/hmac.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # Implementation of the HMAC family of algorithms
     class Hmac
       include JWT::JWA::SigningAlgorithm
 

lib/jwt/jwa/hmac_rbnacl.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # Implementation of the HMAC family of algorithms (using RbNaCl)
     class HmacRbNaCl
       include JWT::JWA::SigningAlgorithm
 

lib/jwt/jwa/hmac_rbnacl_fixed.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # Implementation of the HMAC family of algorithms (using RbNaCl prior to a certain version)
     class HmacRbNaClFixed
       include JWT::JWA::SigningAlgorithm
 

lib/jwt/jwa/none.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # Implementation of the none algorithm
     class None
       include JWT::JWA::SigningAlgorithm