docs: document virt text property

Bekaboo · Sep 27, 2023 · 98af046 · 98af046
1 parent 540389b
commit 98af046
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1973,6 +1973,7 @@ multiple `dropbar_menu_entry_t` instances while a
 | `separator`  | [`dropbar_symbol_t`](#dropbar_symbol_t)   | separator to use in the entry                                               |
 | `padding`    | `{left: integer, right: integer}`         | padding to use between the menu entry and the menu border                   |
 | `components` | [`dropbar_symbol_t[]`](#dropbar_symbol_t) | components<sub>[`dropbar_symbol_t[]`](#dropbar_symbol_t)</sub> in the entry |
+| `virt_text`  | `string[][]?`                             | list of virtual text chunks to display below the entry                      |
 | `menu`       | [`dropbar_menu_t?`](#dropbar_menu_t)      | the menu the entry belongs to                                               |
 | `idx`        | `integer?`                                | the index of the entry in the menu                                          |
 

diff --git a/doc/dropbar.txt b/doc/dropbar.txt
@@ -1832,36 +1832,44 @@ contain multiple `dropbar_symbol_t` instances.
 
 `dropbar_menu_entry_t` has the following fields:
 
-dropbar_menu_t.separator                            *dropbar_menu_t.separator*
+dropbar_menu_entry_t.separator                      *dropbar_menu_t.separator*
 
  	Separator to use in the entry
 
 	Type ~
 	    `dropbar_symbol_t`
 
-dropbar_menu_t.padding                                *dropbar_menu_t.padding*
+dropbar_menu_entry_t.padding                          *dropbar_menu_t.padding*
 
  	Padding to use between the menu entry and the menu border
 
 	Type ~
 	    { left: integer, right: integer }
 
-dropbar_menu_t.components                          *dropbar_menu_t.components*
+dropbar_menu_entry_t.components                    *dropbar_menu_t.components*
 
 	Symbols got from sources |dropbar-developers-classes-dropbar_source_t|
 	in the entry
 
 	Type ~
 	    `dropbar_symbol_t`[]
 
-dropbar_menu_t.menu                                      *dropbar_menu_t.menu*
+dropbar_menu_entry_t.virt_text                      *dropbar_menu_t.virt_text*
+
+	Symbols got from sources |dropbar-developers-classes-dropbar_source_t|
+	in the entry
+
+	Type ~
+	    `string`[][]?
+
+dropbar_menu_entry_t.menu                                *dropbar_menu_t.menu*
 
  	The menu the entry belongs to
 
 	Type ~
 	    `dropbar_menu_t`?
 
-dropbar_menu_t.idx                                        *dropbar_menu_t.idx*
+dropbar_menu_entry_t.idx                                  *dropbar_menu_t.idx*
 
  	The index of the entry in the menu