Browse Source

Updated inline documentation

Marcin Ziąbek 11 months ago
parent
commit
cfd266c470

+ 6 - 2
Source/QuestPDF/Fluent/DebugExtensions.cs

@@ -31,8 +31,12 @@ namespace QuestPDF.Fluent
         }
         }
 
 
         /// <summary>
         /// <summary>
-        /// <para>Inserts a virtual debug element visible in the "element trace" provided along with the <see cref="DocumentLayoutException" />.</para>
-        /// <para>Helps with understanding and navigation of that "element trace" tree hierarchy.</para>
+        /// <para>
+        ///     Inserts a virtual debug element visible in the document hierarchy tree in the QuestPDF Companion App,
+        ///     as well as in the enhanced debugging message provided by the <see cref="DocumentLayoutException" />.
+        /// </para>
+        /// 
+        /// <para>It helps with understanding and navigation of the document hierarchy.</para>
         /// <a href="https://www.questpdf.com/api-reference/debug-pointer.html">Learn more</a>
         /// <a href="https://www.questpdf.com/api-reference/debug-pointer.html">Learn more</a>
         /// </summary>
         /// </summary>
         /// <remarks>
         /// <remarks>

+ 7 - 6
Source/QuestPDF/Fluent/ElementExtensions.cs

@@ -108,7 +108,7 @@ namespace QuestPDF.Fluent
         }
         }
         
         
         /// <summary>
         /// <summary>
-        /// Constrains its content to maintain a given aspect ratio.
+        /// Constrains its content to maintain a given width-to-height ratio.
         /// <a href="https://www.questpdf.com/api-reference/aspect-ratio.html">Learn more</a>
         /// <a href="https://www.questpdf.com/api-reference/aspect-ratio.html">Learn more</a>
         /// </summary>
         /// </summary>
         /// <remarks>
         /// <remarks>
@@ -160,13 +160,14 @@ namespace QuestPDF.Fluent
         }
         }
 
 
         /// <summary>
         /// <summary>
-        /// If the container spans multiple pages, its content appears only on the first one.
+        /// <para>The ShowOnce element modifies how content is displayed across multiple pages.</para>
+        /// <para>
+        /// By default, all elements are fully rendered only once and never repeated.
+        /// However, in some contexts such as page headers and footers, as well as decoration before and after slots, the content is repeated on every page.
+        /// To prevent this, you can use the ShowOnce element.
+        /// </para>
         /// <a href="https://www.questpdf.com/api-reference/show-once.html">Learn more</a>
         /// <a href="https://www.questpdf.com/api-reference/show-once.html">Learn more</a>
         /// </summary>
         /// </summary>
-        /// <remarks>
-        /// <para>This element is useful if you wish to display a header on every page but want certain elements visible only on the first page.</para>
-        /// <para>Depending on the content, certain elements (such as Row or Table) may repeatedly draw their items across multiple pages. Use the ShowOnce element to modify this behavior if it's not desired.</para>
-        /// </remarks>
         /// <example>
         /// <example>
         /// <para>Combine this element with SkipOnce to achieve more complex behaviors, e.g.:</para>
         /// <para>Combine this element with SkipOnce to achieve more complex behaviors, e.g.:</para>
         /// <para><c>.SkipOnce().ShowOnce()</c> ensures the child element is displayed only on the second page.</para>
         /// <para><c>.SkipOnce().ShowOnce()</c> ensures the child element is displayed only on the second page.</para>