From 30a4398bebee1e8bb3cfa523a39cc20b23b916f2 Mon Sep 17 00:00:00 2001
From: InAnYan <ruslanpopov1512@gmail.com>
Date: Tue, 3 Dec 2024 19:59:52 +0200
Subject: [PATCH] Add documentation to `format_tools`

---
 module/core/format_tools/src/format/print.rs | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/module/core/format_tools/src/format/print.rs b/module/core/format_tools/src/format/print.rs
index e102eb5372..f1aa104c24 100644
--- a/module/core/format_tools/src/format/print.rs
+++ b/module/core/format_tools/src/format/print.rs
@@ -229,9 +229,13 @@ mod private
   #[ derive( Debug, Default ) ]
   pub struct RowDescriptor
   {
+    /// Index of the row.
     pub irow : usize,
+    /// Height of the row.
     pub height : usize,
+    /// Type of the line: header or regular.
     pub typ : LineType,
+    /// Visibility of the row.
     pub vis : bool,
   }
 
@@ -240,8 +244,11 @@ mod private
   #[ derive( Debug, Default ) ]
   pub struct ColDescriptor< 'label >
   {
+    /// Index of the column.
     pub icol : usize,
+    /// Column width.
     pub width : usize,
+    /// Label of the column.
     pub label : &'label str,
   }