diff options
author | 2020-09-13 22:08:19 -0400 | |
---|---|---|
committer | 2020-09-13 22:08:19 -0400 | |
commit | 8d20bce133389221acc5de7dab7e7fabfdee24b0 (patch) | |
tree | 2fd60a40356b4c70ac1b71d9c8068765a713d0fe | |
parent | b80f5edb93492050638887ca974e2298f30df283 (diff) | |
download | textadept-8d20bce133389221acc5de7dab7e7fabfdee24b0.tar.gz textadept-8d20bce133389221acc5de7dab7e7fabfdee24b0.zip |
Updated LuaDoc to avoid writing '{{'.
This confuses Jekyll's Liquid tag processing.
-rw-r--r-- | core/ui.lua | 4 | ||||
-rw-r--r-- | docs/api.md | 4 | ||||
-rw-r--r-- | modules/lua/ta_api | 2 |
3 files changed, 5 insertions, 5 deletions
diff --git a/core/ui.lua b/core/ui.lua index 30187098..90b43d90 100644 --- a/core/ui.lua +++ b/core/ui.lua @@ -584,8 +584,8 @@ local goto_view -- menu. '_' characters are treated as a menu mnemonics. If the menu item is -- empty, a menu separator item is created. Submenus are just nested -- menu-structure tables. Their title text is defined with a `title` key. --- @usage ui.menu{{'_New', 1}, {'_Open', 2}, {''}, {'_Quit', 4}} --- @usage ui.menu{{'_New', 1, string.byte('n'), 4}} -- 'Ctrl+N' +-- @usage ui.menu{ {'_New', 1}, {'_Open', 2}, {''}, {'_Quit', 4} } +-- @usage ui.menu{ {'_New', 1, string.byte('n'), 4} } -- 'Ctrl+N' -- @see events.MENU_CLICKED -- @see textadept.menu.menubar -- @see textadept.menu.context_menu diff --git a/docs/api.md b/docs/api.md index 3f19a743..b358cf10 100644 --- a/docs/api.md +++ b/docs/api.md @@ -7825,8 +7825,8 @@ Parameters: Usage: -* `ui.menu{{'_New', 1}, {'_Open', 2}, {''}, {'_Quit', 4}}` -* `ui.menu{{'_New', 1, string.byte('n'), 4}} -- 'Ctrl+N'` +* `ui.menu{ {'_New', 1}, {'_Open', 2}, {''}, {'_Quit', 4} }` +* `ui.menu{ {'_New', 1, string.byte('n'), 4} } -- 'Ctrl+N'` See also: diff --git a/modules/lua/ta_api b/modules/lua/ta_api index 87541d1e..4b170a76 100644 --- a/modules/lua/ta_api +++ b/modules/lua/ta_api @@ -690,7 +690,7 @@ match_case ui.find.match_case (bool)\nMatch search text case sensitively.\nThe d match_case_label_text ui.find.match_case_label_text (string, Write-only)\nThe text of the "Match case" label.\nThis is primarily used for localization. maximized ui.maximized (bool)\nWhether or not Textadept's window is maximized. menu textadept.menu (module)\nDefines the menus used by Textadept.\nMenus are simply tables of menu items and submenus and may be edited in\nplace. A menu item itself is a table whose first element is a menu label and\nwhose second element is a menu command to run. Submenus have `title` keys\nassigned to string text. -menu ui.menu(menu_table)\nLow-level function for creating a menu from table *menu_table* and returning\nthe userdata.\nYou probably want to use the higher-level `textadept.menu.menubar`,\n`textadept.menu.context_menu`, or `textadept.menu.tab_context_menu` tables.\nEmits a `MENU_CLICKED` event when a menu item is selected.\n@param menu_table A table defining the menu. It is an ordered list of tables\n with a string menu item, integer menu ID, and optional GDK keycode and\n modifier mask. The latter two are used to display key shortcuts in the\n menu. '_' characters are treated as a menu mnemonics. If the menu item is\n empty, a menu separator item is created. Submenus are just nested\n menu-structure tables. Their title text is defined with a `title` key.\n@usage ui.menu{{'_New', 1}, {'_Open', 2}, {''}, {'_Quit', 4}}\n@usage ui.menu{{'_New', 1, string.byte('n'), 4}} -- 'Ctrl+N'\n@see events.MENU_CLICKED\n@see textadept.menu.menubar\n@see textadept.menu.context_menu\n@see textadept.menu.tab_context_menu +menu ui.menu(menu_table)\nLow-level function for creating a menu from table *menu_table* and returning\nthe userdata.\nYou probably want to use the higher-level `textadept.menu.menubar`,\n`textadept.menu.context_menu`, or `textadept.menu.tab_context_menu` tables.\nEmits a `MENU_CLICKED` event when a menu item is selected.\n@param menu_table A table defining the menu. It is an ordered list of tables\n with a string menu item, integer menu ID, and optional GDK keycode and\n modifier mask. The latter two are used to display key shortcuts in the\n menu. '_' characters are treated as a menu mnemonics. If the menu item is\n empty, a menu separator item is created. Submenus are just nested\n menu-structure tables. Their title text is defined with a `title` key.\n@usage ui.menu{ {'_New', 1}, {'_Open', 2}, {''}, {'_Quit', 4} }\n@usage ui.menu{ {'_New', 1, string.byte('n'), 4} } -- 'Ctrl+N'\n@see events.MENU_CLICKED\n@see textadept.menu.menubar\n@see textadept.menu.context_menu\n@see textadept.menu.tab_context_menu menubar textadept.menu.menubar (table)\nThe default main menubar.\nIndividual menus, submenus, and menu items can be retrieved by name in\naddition to table index number. menubar ui.menubar (table)\nA table of menus defining a menubar. (Write-only).\nThis is a low-level field. You probably want to use the higher-level\n`textadept.menu.menubar`.\n@see textadept.menu.menubar mode keys.mode (string)\nThe current key mode.\nWhen non-`nil`, all key bindings defined outside of `keys[mode]` are\nignored.\nThe default value is `nil`. |