[Docs] Added some basic class descriptions

GumpDev · Jun 12, 2022 · 3af8596 · 3af8596
1 parent 2995c5e
commit 3af8596
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 9 deletions.
diff --git a/docs/ctrl_inventory.md b/docs/ctrl_inventory.md
@@ -6,7 +6,7 @@ Inherited by: [`CtrlInventoryStacked`](./ctrl_inventory_stacked.md)
 
 ## Description
 
-TODO
+A UI control representing a basic `Inventory`. Displays a list of items in the inventory.
 
 ## Properties
 

diff --git a/docs/ctrl_inventory_grid.md b/docs/ctrl_inventory_grid.md
@@ -4,7 +4,7 @@ Inherits: [CtrlInventory](./ctrl_inventory.md)
 
 ## Description
 
-TODO
+A UI control representing a grid based inventory (`InventoryGrid`). Displays a grid based on the inventory capacity (width and height) and the contained items on the grid. The items can be moved around in the inventory by dragging.
 
 ## Properties
 

diff --git a/docs/ctrl_inventory_stacked.md b/docs/ctrl_inventory_stacked.md
@@ -4,7 +4,7 @@ Inherits: [CtrlInventory](./ctrl_inventory.md)
 
 ## Description
 
-TODO
+A UI control representing a stack based inventory (`InventoryStacked`). It lists the contained items and shows an optional progress bar displaying the capacity and fullness of the inventory.
 
 ## Properties
 

diff --git a/docs/inventory.md b/docs/inventory.md
@@ -6,7 +6,7 @@ Inherited by: [`InventoryStacked`](./inventory_stacked.md), [`InventoryGrid`](./
 
 ## Description
 
-TODO
+Basic inventory class. Supports basic inventory operations (adding, removing, transferring items etc.). Can contain an unlimited amount of items.
 
 ## Properties
 

diff --git a/docs/inventory_grid.md b/docs/inventory_grid.md
@@ -4,7 +4,7 @@ Inherits: [`Inventory`](./inventory.md)
 
 ## Description
 
-TODO
+Inventory that has a limited capacity in terms of space. The inventory capacity is defined by its width and height.
 
 ## Properties
 

diff --git a/docs/inventory_item.md b/docs/inventory_item.md
@@ -4,7 +4,7 @@ Inherits: [Node](https://docs.godotengine.org/en/stable/classes/class_node.html)
 
 ## Description
 
-TODO
+Inventory item class. It is based on an item prototype from an [`ItemProtoset`](./item_protoset.md) resource. Can hold additional properties.
 
 ## Properties
 

diff --git a/docs/inventory_stacked.md b/docs/inventory_stacked.md
@@ -4,7 +4,7 @@ Inherits: [`Inventory`](./inventory.md)
 
 ## Description
 
-TODO
+Inventory that has a limited item capacity in terms of weight.
 
 ## Properties
 

diff --git a/docs/item_protoset.md b/docs/item_protoset.md
@@ -4,7 +4,7 @@ Inherits: [Resource](https://docs.godotengine.org/en/stable/classes/class_resour
 
 ## Description
 
-TODO
+A resource type holding a set of inventory item prototypes in JSON format.
 
 ## Properties
 

diff --git a/docs/item_slot.md b/docs/item_slot.md
@@ -4,7 +4,7 @@ Inherits: [Node](https://docs.godotengine.org/en/stable/classes/class_node.html)
 
 ## Description
 
-TODO
+Holds a reference to a given item from a given inventory. The slot can be cleared or bound to one item at a time. In case the item is removed from the inventory or the slot is bound to a different inventory, the slot is automatically cleared.
 
 ## Properties
-Original file line number
+Diff line change
@@ Expand Up @@
     ## Description
-    TODO
+    A UI control representing a basic `Inventory`. Displays a list of items in the inventory.
     ## Properties
@@ Expand Down @@