Skip to content

Commit 7eb2e71

Browse files
SiegeLordExSiegeLord
authored andcommitted
Fix the docs for the return value of al_insert_menu_item.
Fixes #1648
1 parent 59eb9f5 commit 7eb2e71

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/src/refman/native_dialog.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -433,8 +433,8 @@ See also: [al_insert_menu_item], [al_remove_menu_item]
433433

434434
### API: al_insert_menu_item
435435

436-
Inserts a menu item at the spot specified. See the introductory text for a
437-
detailed explanation of how the `pos` parameter is interpreted.
436+
Inserts a menu item at the spot specified. See the [introductory text](#menus)
437+
for a detailed explanation of how the `pos` parameter is interpreted.
438438

439439
The `parent` menu can be a popup menu or a regular menu. To underline
440440
one character in the `title`, prefix it with an ampersand.
@@ -459,7 +459,8 @@ The `submenu` parameter indicates that this item contains a child menu.
459459
The child menu must have previously been created with `al_create_menu`,
460460
and not be associated with any other menu.
461461

462-
Returns `true` on success.
462+
Returns the index at which the item was inserted (which can be different than
463+
what is implied by `pos`), or -1 if there was an error.
463464

464465
Since: 5.1.0
465466

0 commit comments

Comments
 (0)