diff --git a/docs/references/elements/Container.md b/docs/references/elements/Container.md index 79cb46a..10308e8 100644 --- a/docs/references/elements/Container.md +++ b/docs/references/elements/Container.md @@ -1,5 +1,5 @@ # Container : VisualElement -The Container class serves as a fundamental building block for organizing UI elements. It acts as a parent element that can hold and manage child elements, providing layout management, event propagation, and rendering capabilities. Used as base class for Frames, Windows, and other container-like elements. +The Container class serves as a fundamental building block for organizing UI elements. It acts as a parent element that can hold and manage child elements. ### Usage ```lua diff --git a/docs/references/elements/Graph.md b/docs/references/elements/Graph.md index ca87964..e59f214 100644 --- a/docs/references/elements/Graph.md +++ b/docs/references/elements/Graph.md @@ -30,7 +30,7 @@ end) |Method|Returns|Description| |---|---|---| |[Graph:addPoint](#graph-addpoint)|Graph|Adds a point to a series -|[Graph:addSeries](#graph-addseries)|-|Adds a series to the graph +|[Graph:addSeries](#graph-addseries)|Graph|Adds a series to the graph |[Graph:changeSeriesVisibility](#graph-changeseriesvisibility)|Graph|Changes the visibility of a series |[Graph:clear](#graph-clear)|Graph|Clears all points from a series |[Graph:focusSeries](#graph-focusseries)|Graph|Focuses a series @@ -64,6 +64,9 @@ end) * `fgCol` `number` The foreground color of the series * `pointCount` `number` The number of points in the series +### Returns +* `Graph` `self` The graph instance + ## Graph:changeSeriesVisibility(name, visible) ### Parameters diff --git a/docs/references/plugins/benchmark.md b/docs/references/plugins/benchmark.md index 82636ec..d28c6a9 100644 --- a/docs/references/plugins/benchmark.md +++ b/docs/references/plugins/benchmark.md @@ -1,5 +1,7 @@ -# BenchmarkAPI -Benchmark API methods +# Benchmark +This is the benchmark plugin. It provides performance measurement tools for elements and methods, +with support for hierarchical profiling and detailed statistics. The plugin is meant to be used for very big projects +where performance is critical. It allows you to measure the time taken by specific methods and log the results. ## Functions diff --git a/docs/references/plugins/benchmark_BaseElement.md b/docs/references/plugins/benchmark_BaseElement.md index a29f8b7..2add632 100644 --- a/docs/references/plugins/benchmark_BaseElement.md +++ b/docs/references/plugins/benchmark_BaseElement.md @@ -1,7 +1,4 @@ # BaseElement -This is the benchmark plugin. It provides performance measurement tools for elements and methods, -with support for hierarchical profiling and detailed statistics. -The following methods are available for BaseElement ## Functions diff --git a/docs/references/plugins/reactive.md b/docs/references/plugins/reactive.md index 30ba8b9..637d74c 100644 --- a/docs/references/plugins/reactive.md +++ b/docs/references/plugins/reactive.md @@ -2,5 +2,14 @@ This module provides reactive functionality for elements, it adds no new functionality for elements. It is used to evaluate expressions in property values and update the element when the expression changes. +### Usage + ```lua +local button = main:addButton({text="Exit"}) +button:setX("{parent.x - 12}") +button:setBackground("{self.clicked and colors.red or colors.green}") +button:setWidth("{self.text:len() + 2}") +``` + +