Updated docs for 'fixup

Signed-off-by: Matteo Collina <[email protected]>'
platformatic · Jan 13, 2025 · 51e7f1c · 51e7f1c
1 parent b648841
commit 51e7f1c
Show file tree

Hide file tree

Showing 58 changed files with 66 additions and 66 deletions.
diff --git a/current/AdminClient.html b/current/AdminClient.html
@@ -1424,7 +1424,7 @@ <h5 class="subsection-title">Properties:</h5>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/Client.html b/current/Client.html
@@ -3838,7 +3838,7 @@ <h5 class="subsection-title">Properties:</h5>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/HighLevelProducer.html b/current/HighLevelProducer.html
@@ -4973,7 +4973,7 @@ <h5 class="subsection-title">Properties:</h5>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/KafkaConsumer.html b/current/KafkaConsumer.html
@@ -5178,11 +5178,11 @@ <h5>Returns:</h5>
 
 
       <p>
-        <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-example-588-1">
+        <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-example-917-1">
           Open Example 1
         </button>
       </p>
-      <div class="modal hide" id="modal-example-588-1">
+      <div class="modal hide" id="modal-example-917-1">
         <div class="modal-header">
           <a href="#" class="close" data-dismiss="modal" onclick="return false;">
             <i class="icon-remove icon-white"></i></a>
@@ -6506,11 +6506,11 @@ <h5>Returns:</h5>
 
 
       <p>
-        <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-example-498-1">
+        <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-example-161-1">
           Open Example 1
         </button>
       </p>
-      <div class="modal hide" id="modal-example-498-1">
+      <div class="modal hide" id="modal-example-161-1">
         <div class="modal-header">
           <a href="#" class="close" data-dismiss="modal" onclick="return false;">
             <i class="icon-remove icon-white"></i></a>
@@ -7452,7 +7452,7 @@ <h5 class="subsection-title">Properties:</h5>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/KafkaConsumerStream.html b/current/KafkaConsumerStream.html
@@ -561,7 +561,7 @@ <h4 class="heading-3">Parameters:</h4>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/LibrdKafkaError.html b/current/LibrdKafkaError.html
@@ -4455,7 +4455,7 @@ <h5 class="subsection-title">Properties:</h5>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/Producer.html b/current/Producer.html
@@ -4812,7 +4812,7 @@ <h5 class="subsection-title">Properties:</h5>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/ProducerStream.html b/current/ProducerStream.html
@@ -330,7 +330,7 @@ <h3 class="heading-2">Extends:</h3>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/admin.js.html b/current/admin.js.html
@@ -312,7 +312,7 @@ <h1>Source: admin.js</h1>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/client.js.html b/current/client.js.html
@@ -652,7 +652,7 @@ <h1>Source: client.js</h1>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/error.js.html b/current/error.js.html
@@ -553,7 +553,7 @@ <h1>Source: error.js</h1>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/global.html b/current/global.html
@@ -642,7 +642,7 @@ <h5>Returns:</h5>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/index.html b/current/index.html
@@ -760,7 +760,7 @@ <h2>Admin Client</h2>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/kafka-consumer-stream.js.html b/current/kafka-consumer-stream.js.html
@@ -476,7 +476,7 @@ <h1>Source: kafka-consumer-stream.js</h1>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/kafka-consumer.js.html b/current/kafka-consumer.js.html
@@ -777,7 +777,7 @@ <h1>Source: kafka-consumer.js</h1>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/producer-stream.js.html b/current/producer-stream.js.html
@@ -386,7 +386,7 @@ <h1>Source: producer-stream.js</h1>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/producer.js.html b/current/producer.js.html
@@ -454,7 +454,7 @@ <h1>Source: producer.js</h1>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/producer_high-level-producer.js.html b/current/producer_high-level-producer.js.html
@@ -402,7 +402,7 @@ <h1>Source: producer/high-level-producer.js</h1>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/tools_ref-counter.js.html b/current/tools_ref-counter.js.html
@@ -131,7 +131,7 @@ <h1>Source: tools/ref-counter.js</h1>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/topic-partition.js.html b/current/topic-partition.js.html
@@ -167,7 +167,7 @@ <h1>Source: topic-partition.js</h1>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/topic.js.html b/current/topic.js.html
@@ -121,7 +121,7 @@ <h1>Source: topic.js</h1>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/tutorial-consumer-flow.html b/current/tutorial-consumer-flow.html
@@ -151,7 +151,7 @@ <h2>consumer-flow</h2>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/tutorial-consumer.html b/current/tutorial-consumer.html
@@ -120,7 +120,7 @@ <h2>consumer</h2>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/tutorial-docker-alpine.html b/current/tutorial-docker-alpine.html
@@ -104,7 +104,7 @@ <h2>docker-alpine</h2>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/tutorial-high-level-producer.html b/current/tutorial-high-level-producer.html
@@ -108,7 +108,7 @@ <h2>high-level-producer</h2>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/tutorial-metadata.html b/current/tutorial-metadata.html
@@ -103,7 +103,7 @@ <h2>metadata</h2>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/tutorial-oauthbearer-default-flow.html b/current/tutorial-oauthbearer-default-flow.html
@@ -152,7 +152,7 @@ <h2>oauthbearer-default-flow</h2>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/tutorial-producer-cluster.html b/current/tutorial-producer-cluster.html
@@ -179,7 +179,7 @@ <h2>producer-cluster</h2>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/current/tutorial-producer_.html b/current/tutorial-producer_.html
@@ -149,7 +149,7 @@ <h2>producer</h2>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/v3.2.1/AdminClient.html b/v3.2.1/AdminClient.html
@@ -1424,7 +1424,7 @@ <h5 class="subsection-title">Properties:</h5>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/v3.2.1/Client.html b/v3.2.1/Client.html
@@ -3838,7 +3838,7 @@ <h5 class="subsection-title">Properties:</h5>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/v3.2.1/HighLevelProducer.html b/v3.2.1/HighLevelProducer.html
@@ -4973,7 +4973,7 @@ <h5 class="subsection-title">Properties:</h5>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">

diff --git a/v3.2.1/KafkaConsumer.html b/v3.2.1/KafkaConsumer.html
@@ -5178,11 +5178,11 @@ <h5>Returns:</h5>
 
 
       <p>
-        <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-example-588-1">
+        <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-example-917-1">
           Open Example 1
         </button>
       </p>
-      <div class="modal hide" id="modal-example-588-1">
+      <div class="modal hide" id="modal-example-917-1">
         <div class="modal-header">
           <a href="#" class="close" data-dismiss="modal" onclick="return false;">
             <i class="icon-remove icon-white"></i></a>
@@ -6506,11 +6506,11 @@ <h5>Returns:</h5>
 
 
       <p>
-        <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-example-498-1">
+        <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-example-161-1">
           Open Example 1
         </button>
       </p>
-      <div class="modal hide" id="modal-example-498-1">
+      <div class="modal hide" id="modal-example-161-1">
         <div class="modal-header">
           <a href="#" class="close" data-dismiss="modal" onclick="return false;">
             <i class="icon-remove icon-white"></i></a>
@@ -7452,7 +7452,7 @@ <h5 class="subsection-title">Properties:</h5>
     <div class="footer-content">
       <div class="grid-75">
         <div class="legal">
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:54:44 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Mon Jan 13 2025 07:55:11 GMT+0100 (Central European Standard Time)
         </div>
       </div>
       <div class="grid-25">