[GoldenLayout] Adjust comments

aardvark-platform · Mar 6, 2024 · 6e99565 · 6e99565
1 parent b08e67e
commit 6e99565
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 16 deletions.
diff --git a/src/Aardvark.UI.Primitives/Golden/GoldenLayout.fs b/src/Aardvark.UI.Primitives/Golden/GoldenLayout.fs
@@ -75,7 +75,7 @@ module Builders =
               Size      = Size.Weight 1
               KeepAlive = true }
 
-        /// Title shown in the header.
+        /// Title shown in the header tab. Default is "Untitled".
         [<CustomOperation("title")>]
         member inline x.Title(e : Element, title : string) =
             { e with Title = title }
@@ -85,12 +85,12 @@ module Builders =
         member inline x.Closable(e : Element, closable : bool) =
             { e with Closable = closable }
 
-        /// Determines the position of the header or if one is shown at all.
+        /// Determines the position of the header or if one is shown at all. Default is Header.Top.
         [<CustomOperation("header")>]
         member inline x.Header(e : Element, header : Header option) =
             { e with Header = header }
 
-        /// Determines the position of the header.
+        /// Determines the position of the header. Default is Header.Top.
         [<CustomOperation("header")>]
         member inline x.Header(e : Element, header : Header) =
             { e with Header = Some header }
@@ -110,7 +110,7 @@ module Builders =
         member inline x.Size(e : Element, size : Size) =
             { e with Size = size }
 
-        /// Size of the element in case the parent is a row or column container.
+        /// Size of the element (in percent) in case the parent is a row or column container.
         [<CustomOperation("size")>]
         member inline x.Size(e : Element, sizeInPercent : int) =
             { e with Size = Size.Percentage sizeInPercent }
@@ -156,7 +156,7 @@ module Builders =
         member inline x.Size(s : Stack, size : Size) =
             { s with Size = size }
 
-        /// Size of the stack in case the parent is a row or column container.
+        /// Size of the stack (in percent) in case the parent is a row or column container.
         [<CustomOperation("size")>]
         member inline x.Size(s : Stack, sizeInPercent : int) =
             { s with Size = Size.Percentage sizeInPercent }
@@ -196,7 +196,7 @@ module Builders =
         member inline x.Size(rc : RowOrColumn, size : Size) =
             { rc with Size = size }
 
-        /// Size of the container in case the parent is a row or column container.
+        /// Size of the container (in percent) in case the parent is a row or column container.
         [<CustomOperation("size")>]
         member inline x.Size(rc : RowOrColumn, sizeInPercent : int) =
             { rc with Size = Size.Percentage sizeInPercent }

diff --git a/src/Aardvark.UI.Primitives/Golden/GoldenLayoutModel.fs b/src/Aardvark.UI.Primitives/Golden/GoldenLayoutModel.fs
@@ -32,7 +32,7 @@ type Element =
         /// Unique name to identify the element in the view function.
         Id        : string
 
-        /// Title shown in the header.
+        /// Title shown in the header tab.
         Title     : string
 
         /// Determines if the element can be closed via buttons in the header and tab.
@@ -93,26 +93,26 @@ type Theme =
 
 type LayoutConfig =
     {
-        /// The color theme to use.
+        /// The color theme to use. Default is Theme.BorderlessDark.
         Theme : Theme
 
-        /// Determines whether popouts are automatically docked when the window is closed.
-        /// Shows a small dock button in popouts if false.
+        /// Determines whether items in popout windows are automatically docked when the window is closed.
+        /// Shows a small dock button in popout windows if false. Default is true.
         PopInOnClose : bool
 
-        /// Determines whether popout affects the whole stack or just the active tab.
+        /// Determines whether the popout header button affects the whole stack or just the active tab. Default is true.
         PopOutWholeStack : bool
 
-        /// Determines whether elements may be dragged from one window to another.
+        /// Determines whether elements may be dragged from one window to another. Default is true.
         DragBetweenWindows : bool
 
-        /// Determines whether elements may be dragged and dropped outside the containing window creating a new popout.
+        /// Determines whether elements may be dragged and dropped outside the containing window creating a new popout window. Default is true.
         DragToNewWindow : bool
 
         /// Default buttons to be displayed in the headers.
         HeaderButtons : Buttons
 
-        /// Determines whether the document.title of popouts is set and updated automatically to the document.title of the main window.
+        /// Determines whether the document.title of popout windows is set and updated automatically to the document.title of the main window.
         SetPopoutTitle : bool
 
         /// Default minimum width (in pixels) of any item. Default is 20.
@@ -121,10 +121,10 @@ type LayoutConfig =
         /// Default minimum height (in pixels) of any item. Default is 20.
         MinItemHeight : int
 
-        /// Width (in pixels) of drag proxy elements. Default is 300.
+        /// Width (in pixels) of drag proxy / preview elements. Default is 300.
         DragProxyWidth : int
 
-        /// Height (in pixels) of drag proxy elements. Default is 200.
+        /// Height (in pixels) of drag proxy / preview elements. Default is 200.
         DragProxyHeight : int
 
         /// Tooltip label of minimize button.