From 23906d3b219c13bca3fbe79acc8f8402b2cccadb Mon Sep 17 00:00:00 2001 From: Kevin Harrison Date: Mon, 14 Nov 2016 21:39:02 -0500 Subject: [PATCH] Updated Documentation (markdown) --- Documentation.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation.md b/Documentation.md index e4fa2e0..84d18d3 100644 --- a/Documentation.md +++ b/Documentation.md @@ -64,9 +64,9 @@ End the current frame. Call this once every [love.update](https://love2d.org/wik ## Window -#### open = nk.window_begin(title, x, y, width, height, flags...) -#### open = nk.window_begin(name, title, x, y, width, height, flags...) -Create or update a window with the given `name`. The `name` is a unique identifier used internally to differentiate between windows. If unspecified, the `name` defaults to the `title`. The `x`, `y`, `width`, and `height` parameters describe the window's initial bounds. All additional arguments are interpreted as window flags. +#### open = nk.window_begin(title, x, y, width, height, [flags](#flags)...) +#### open = nk.window_begin(name, title, x, y, width, height, [flags](#flags)...) +Create or update a window with the given `name`. The `name` is a unique identifier used internally to differentiate between windows. If unspecified, the `name` defaults to the `title`. The `x`, `y`, `width`, and `height` parameters describe the window's initial bounds. All additional arguments are interpreted as window [flags](#flags). Returns `true` if the window is open and `false` if it is closed or collapsed. @@ -235,7 +235,7 @@ Convert a pixel width to a ratio suitable for a dynamic layout. ### Groups -#### open = nk.group_begin(title, flags...) +#### open = nk.group_begin(title, [flags](#flags)...) Start a group. Groups can have titles and scrollbars just like windows. Return `true` if the group is open and `false` otherwise. @@ -261,8 +261,8 @@ Ends a tree. Call this at the end of an open tree item. ### Popups -#### open = nk.popup_begin('dynamic'/'static', title, x, y, width, height, flags...) -Start a popup with the given size and flags. Bounds can be given as either dynamic ratios or static pixel counts. +#### open = nk.popup_begin('dynamic'/'static', title, x, y, width, height, [flags](#flags)...) +Start a popup with the given size and [flags](#flags). Bounds can be given as either dynamic ratios or static pixel counts. Return `true` if the popup is open, and `false` otherwise. @@ -276,8 +276,8 @@ End a popup. Be sure to call this when ending an open popup. ### Context Menus -#### open = nk.contextual_begin(width, height, trigger_x, trigger_y, trigger_width, trigger_height, flags...) -Set up a context menu of the given size and trigger bounds. Also takes window flags. +#### open = nk.contextual_begin(width, height, trigger_x, trigger_y, trigger_width, trigger_height, [flags](#flags)...) +Set up a context menu of the given size and trigger bounds. Also takes window [flags](#flags). Return `true` if the context menu is open, and `false` otherwise.