yard: update + mkd provider = CommonMarker

Author: noraj

.yardopts

@@ -1,4 +1,6 @@
 --output-dir docs/yard
+--markup markdown
+--markup-provider commonmarker
 -
 --main README.md
-LICENSE.txt
+LICENSE.txt

.yardopts-dev

@@ -1,6 +1,8 @@
 --output-dir docs/yard
 --protected
 --private
+--markup markdown
+--markup-provider commonmarker
 -
 --main README.md
-LICENSE.txt
+LICENSE.txt

Gemfile

@@ -23,8 +23,6 @@ group :development, :lint do
 end
 
 group :development, :docs do
-  gem 'commonmarker', '~> 0.21' # for GMF support in YARD
-  gem 'github-markup', '~> 4.0' # for GMF support in YARD
-  gem 'redcarpet', '~> 3.5' # for GMF support in YARD
-  gem 'yard', '~> 0.9'
+  gem 'commonmarker', '~> 0.21' # for markdown support in YARD
+  gem 'yard', ['>= 0.9.27', '< 0.10']
 end

Gemfile.lock

@@ -19,7 +19,6 @@ GEM
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.6)
-    redcarpet (3.5.1)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rubocop (1.23.0)
@@ -35,7 +34,9 @@ GEM
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.1.0)
-    yard (0.9.26)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   ruby
@@ -49,9 +50,8 @@ DEPENDENCIES
   minitest (~> 5.12)
   paint (~> 2.2)
   rake (~> 13.0)
-  redcarpet (~> 3.5)
   rubocop (~> 1.23)
-  yard (~> 0.9)
+  yard (>= 0.9.27, < 0.10)
 
 BUNDLED WITH
    2.2.15

docs/CHANGELOG.md

@@ -11,6 +11,9 @@
   - Windows Hello PIN/Password [#101][#101]
 - Chore:
   - MFA required for gem release
+- Dependencies:
+  - Update to yard [v0.9.27](https://github.com/lsegal/yard/releases/tag/v0.9.27)
+    - Move from Redcarpet to CommonMarker markdown provider
 
 [#101]:https://github.com/noraj/haiti/issues/101
 

docs/yard/HashIdentifier.html

@@ -6,7 +6,7 @@
 <title>
   Class: HashIdentifier
 
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
 
 </title>
 
@@ -108,8 +108,7 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    
-<p>The global Hash Identifier class</p>
+    <p>The global Hash Identifier class</p>
 
 
   </div>
@@ -183,8 +182,7 @@ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collaps
 
 
 
-    <span class="summary_desc"><div class='inline'>
-<p>The hash (as provided).</p>
+    <span class="summary_desc"><div class='inline'><p>The hash (as provided).</p>
 </div></span>
 
 </li>
@@ -212,8 +210,7 @@ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collaps
 
 
 
-    <span class="summary_desc"><div class='inline'>
-<p>List of <span class='object_link'><a href="HashIdentifier/Chf.html" title="HashIdentifier::Chf (class)">Chf</a></span> objects, representing the identified hashes.</p>
+    <span class="summary_desc"><div class='inline'><p>List of <span class='object_link'><a href="HashIdentifier/Chf.html" title="HashIdentifier::Chf (class)">Chf</a></span> objects, representing the identified hashes.</p>
 </div></span>
 
 </li>
@@ -251,8 +248,7 @@ <h2>
 
 
 
-    <span class="summary_desc"><div class='inline'>
-<p>A new instance of hash identifier.</p>
+    <span class="summary_desc"><div class='inline'><p>A new instance of hash identifier.</p>
 </div></span>
 
 </li>
@@ -281,8 +277,7 @@ <h3 class="signature first" id="initialize-instance_method">
 
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>A new instance of hash identifier</p>
+    <p>A new instance of hash identifier</p>
 
 
   </div>
@@ -301,8 +296,7 @@ <h3 class="signature first" id="initialize-instance_method">
 
 
         &mdash;
-        <div class='inline'>
-<p>the hash to identify</p>
+        <div class='inline'><p>the hash to identify</p>
 </div>
 
     </li>
@@ -353,8 +347,7 @@ <h3 class="signature first" id="hash-instance_method">
 
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>Returns the hash (as provided).</p>
+    <p>Returns the hash (as provided).</p>
 
 
   </div>
@@ -380,8 +373,7 @@ <h3 class="signature first" id="hash-instance_method">
 
 
         &mdash;
-        <div class='inline'>
-<p>the hash (as provided)</p>
+        <div class='inline'><p>the hash (as provided)</p>
 </div>
 
     </li>
@@ -422,8 +414,8 @@ <h3 class="signature " id="type-instance_method">
 
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>Returns list of <span class='object_link'><a href="HashIdentifier/Chf.html" title="HashIdentifier::Chf (class)">Chf</a></span> objects, representing the identified hashes.</p>
+    <p>Returns list of <span class='object_link'><a href="HashIdentifier/Chf.html" title="HashIdentifier::Chf (class)">Chf</a></span> objects, representing the identified
+hashes.</p>
 
 
   </div>
@@ -441,8 +433,8 @@ <h3 class="signature " id="type-instance_method">
 
 
         &mdash;
-        <div class='inline'>
-<p>list of <span class='object_link'><a href="HashIdentifier/Chf.html" title="HashIdentifier::Chf (class)">Chf</a></span> objects, representing the identified hashes</p>
+        <div class='inline'><p>list of <span class='object_link'><a href="HashIdentifier/Chf.html" title="HashIdentifier::Chf (class)">Chf</a></span> objects, representing the identified
+hashes</p>
 </div>
 
     </li>
@@ -476,9 +468,9 @@ <h3 class="signature " id="type-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Aug 24 15:46:02 2021 by
+  Generated on Tue Nov 30 17:29:07 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-3.0.1).
+  0.9.27 (ruby-3.0.1).
 </div>
 
     </div>

docs/yard/HashIdentifier/Chf.html

@@ -6,7 +6,7 @@
 <title>
   Class: HashIdentifier::Chf
 
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
 
 </title>
 
@@ -101,8 +101,7 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    
-<p>Cryptographic hash function object</p>
+    <p>Cryptographic hash function object</p>
 
 
   </div>
@@ -139,8 +138,7 @@ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collaps
 
 
 
-    <span class="summary_desc"><div class='inline'>
-<p>Display by default or not.</p>
+    <span class="summary_desc"><div class='inline'><p>Display by default or not.</p>
 </div></span>
 
 </li>
@@ -168,8 +166,7 @@ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collaps
 
 
 
-    <span class="summary_desc"><div class='inline'>
-<p>Hashcat hash ID.</p>
+    <span class="summary_desc"><div class='inline'><p>Hashcat hash ID.</p>
 </div></span>
 
 </li>
@@ -197,8 +194,7 @@ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collaps
 
 
 
-    <span class="summary_desc"><div class='inline'>
-<p>John the Ripper hash reference.</p>
+    <span class="summary_desc"><div class='inline'><p>John the Ripper hash reference.</p>
 </div></span>
 
 </li>
@@ -226,8 +222,7 @@ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collaps
 
 
 
-    <span class="summary_desc"><div class='inline'>
-<p>Name of the identified hash type.</p>
+    <span class="summary_desc"><div class='inline'><p>Name of the identified hash type.</p>
 </div></span>
 
 </li>
@@ -255,8 +250,7 @@ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collaps
 
 
 
-    <span class="summary_desc"><div class='inline'>
-<p>Examples of hashes.</p>
+    <span class="summary_desc"><div class='inline'><p>Examples of hashes.</p>
 </div></span>
 
 </li>
@@ -294,8 +288,7 @@ <h2>
 
 
 
-    <span class="summary_desc"><div class='inline'>
-<p>A new instance of Chf.</p>
+    <span class="summary_desc"><div class='inline'><p>A new instance of Chf.</p>
 </div></span>
 
 </li>
@@ -318,8 +311,7 @@ <h3 class="signature first" id="initialize-instance_method">
 
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>Returns a new instance of Chf.</p>
+    <p>Returns a new instance of Chf.</p>
 
 
   </div>
@@ -374,8 +366,8 @@ <h3 class="signature first" id="extended-instance_method">
 
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>Returns Display by default or not. If true it is displayed in extended mode only, mostly hash type using salt.</p>
+    <p>Returns Display by default or not. If true it is displayed in
+extended mode only, mostly hash type using salt.</p>
 
 
   </div>
@@ -393,8 +385,8 @@ <h3 class="signature first" id="extended-instance_method">
 
 
         &mdash;
-        <div class='inline'>
-<p>Display by default or not. If true it is displayed in extended mode only, mostly hash type using salt.</p>
+        <div class='inline'><p>Display by default or not. If true it is displayed in
+extended mode only, mostly hash type using salt.</p>
 </div>
 
     </li>
@@ -435,8 +427,7 @@ <h3 class="signature " id="hashcat-instance_method">
 
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>Returns Hashcat hash ID. nil if unknown.</p>
+    <p>Returns Hashcat hash ID. nil if unknown.</p>
 
 
   </div>
@@ -454,8 +445,7 @@ <h3 class="signature " id="hashcat-instance_method">
 
 
         &mdash;
-        <div class='inline'>
-<p>Hashcat hash ID. nil if unknown.</p>
+        <div class='inline'><p>Hashcat hash ID. nil if unknown.</p>
 </div>
 
     </li>
@@ -496,8 +486,7 @@ <h3 class="signature " id="john-instance_method">
 
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>Returns John the Ripper hash reference. nil if unknown.</p>
+    <p>Returns John the Ripper hash reference. nil if unknown.</p>
 
 
   </div>
@@ -515,8 +504,7 @@ <h3 class="signature " id="john-instance_method">
 
 
         &mdash;
-        <div class='inline'>
-<p>John the Ripper hash reference. nil if unknown.</p>
+        <div class='inline'><p>John the Ripper hash reference. nil if unknown.</p>
 </div>
 
     </li>
@@ -557,8 +545,7 @@ <h3 class="signature " id="name-instance_method">
 
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>Returns name of the identified hash type.</p>
+    <p>Returns name of the identified hash type.</p>
 
 
   </div>
@@ -576,8 +563,7 @@ <h3 class="signature " id="name-instance_method">
 
 
         &mdash;
-        <div class='inline'>
-<p>name of the identified hash type</p>
+        <div class='inline'><p>name of the identified hash type</p>
 </div>
 
     </li>
@@ -618,8 +604,7 @@ <h3 class="signature " id="samples-instance_method">
 
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>Returns Examples of hashes.</p>
+    <p>Returns Examples of hashes.</p>
 
 
   </div>
@@ -637,8 +622,7 @@ <h3 class="signature " id="samples-instance_method">
 
 
         &mdash;
-        <div class='inline'>
-<p>Examples of hashes</p>
+        <div class='inline'><p>Examples of hashes</p>
 </div>
 
     </li>
@@ -672,9 +656,9 @@ <h3 class="signature " id="samples-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Aug 24 15:46:02 2021 by
+  Generated on Tue Nov 30 17:29:07 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-3.0.1).
+  0.9.27 (ruby-3.0.1).
 </div>
 
     </div>