📝 Complete inline YARD docs

Author: pboling

.rubocop_gradual.lock

@@ -1,6 +1,6 @@
 {
-  "lib/omniauth-ldap/adaptor.rb:928056405": [
-    [68, 7, 413, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 105664470]
+  "lib/omniauth-ldap/adaptor.rb:4205312053": [
+    [134, 7, 413, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 105664470]
   ],
   "spec/integration/middleware_spec.rb:2185613788": [
     [3, 16, 39, "RSpec/DescribeClass: The first argument to describe should be the class or module being tested.", 638096201],

CHANGELOG.md

@@ -23,6 +23,7 @@ Please file a bug if you notice a violation of semantic versioning.
 ### Added
 
 - Documentation cleanup & updates
+- YARD documentation covering 94% of the code
 
 ### Changed
 

docs/OmniAuth.html

@@ -78,14 +78,49 @@
 
   <dl>
     <dt>Defined in:</dt>
-    <dd>lib/omniauth-ldap/adaptor.rb<span class="defines">,<br />
-  lib/omniauth-ldap/version.rb,<br /> lib/omniauth/strategies/ldap.rb</span>
+    <dd>lib/omniauth/strategies/ldap.rb<span class="defines">,<br />
+  lib/omniauth-ldap/adaptor.rb,<br /> lib/omniauth-ldap/version.rb</span>
 </dd>
   </dl>
 
 </div>
 
-<h2>Defined Under Namespace</h2>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>OmniAuth strategies namespace.</p>
+
+<p>This file implements an LDAP authentication strategy for OmniAuth.<br />
+It provides both an interactive request phase (login form) and a<br />
+callback phase which binds to an LDAP directory to authenticate the<br />
+user or performs a lookup for header-based SSO.</p>
+
+<p>The strategy exposes a number of options (see <code>option</code> calls below)<br />
+that control LDAP connection, mapping of LDAP attributes to the<br />
+OmniAuth <code>info</code> hash, header-based SSO behavior, and SSL/timeouts.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <h4 class="tag_title">Examples:</h4>
+    
+      
+        <h5 class="example_title"><div class='inline'><p>Minimal Rack mounting</p>
+</div></h5>
+      
+      <pre class="example code"><code><span class='id identifier rubyid_use'>use</span> <span class='const'>OmniAuth</span><span class='op'>::</span><span class='const'>Builder</span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_provider'>provider</span> <span class='symbol'>:ldap</span><span class='comma'>,</span> <span class='lbrace'>{</span>
+    <span class='label'>host:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ldap.example.com</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+    <span class='label'>base:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dc=example,dc=com</span><span class='tstring_end'>&#39;</span></span>
+  <span class='rbrace'>}</span>
+<span class='kw'>end</span></code></pre>
+    
+  </div>
+
+
+</div><h2>Defined Under Namespace</h2>
 <p class="children">
 
 
@@ -107,7 +142,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Fri Nov  7 14:40:47 2025 by
+  Generated on Mon Nov 10 14:11:47 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.7).
 </div>

docs/OmniAuth/LDAP.html

@@ -109,13 +109,26 @@ <h2>
         <dt id="VERSION-constant" class="">VERSION =
           <div class="docstring">
   <div class="discussion">
-    <p>Make VERSION available in traditional way</p>
+    <p>Convenience constant for consumers that expect OmniAuth::LDAP::VERSION</p>
 
 
   </div>
 </div>
 <div class="tags">
 
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
 
 </div>
         </dt>
@@ -135,7 +148,7 @@ <h2>
 </div>
 
       <div id="footer">
-  Generated on Fri Nov  7 14:40:47 2025 by
+  Generated on Mon Nov 10 14:11:47 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.7).
 </div>