Updates to documentation

* Fixed typos in README
* Added Server/Client/Shared kinds to documentation
* Documentation now includes readme

5 files changed, 13 insertions, 8 deletions

diff --git a/gamemode/core/inventory/common/items.lua b/gamemode/core/inventory/common/items.lua
index a7a1858..4b52a97 100644
--- a/gamemode/core/inventory/common/items.lua
+++ b/gamemode/core/inventory/common/items.lua
@@ -1,6 +1,6 @@
 ---Some common functions for working with items.
 -- Just one function for now
---@module items.lua
+--@shared items.lua
 
 local items = {}
 
diff --git a/gamemode/core/inventory/common/weapons.lua b/gamemode/core/inventory/common/weapons.lua
index 3ced3b1..065d1a6 100644
--- a/gamemode/core/inventory/common/weapons.lua
+++ b/gamemode/core/inventory/common/weapons.lua
@@ -1,6 +1,6 @@
 ---Common functionality used in a lot of weapons.
 -- Bits an peices that most weapons need
---@module weapons.lua
+--@shared weapons.lua
 
 local com = {}
 
diff --git a/gamemode/core/inventory/inventory.lua b/gamemode/core/inventory/inventory.lua
index 69e8181..1290519 100644
--- a/gamemode/core/inventory/inventory.lua
+++ b/gamemode/core/inventory/inventory.lua
@@ -1,6 +1,6 @@
 ---The main file needed to register create new inventory types.
 -- Helps you register inventories that work with the rest of artery
---@module inventory.lua
+--@shared inventory.lua
 
 --[[
 	Public functions:
diff --git a/gamemode/core/inventory/item.lua b/gamemode/core/inventory/item.lua
index 1e6a0cf..9a6a293 100644
--- a/gamemode/core/inventory/item.lua
+++ b/gamemode/core/inventory/item.lua
@@ -1,6 +1,6 @@
 ---The main module to use when createing new items.
 -- Registers items that will work with the inventory system
---@module item.lua
+--@shared item.lua
 --[[
 	An itemsystem
 	public functions:
diff --git a/gamemode/core/inventory/sv_invtracker.lua b/gamemode/core/inventory/sv_invtracker.lua
index 32388d7..e009828 100644
--- a/gamemode/core/inventory/sv_invtracker.lua
+++ b/gamemode/core/inventory/sv_invtracker.lua
@@ -1,6 +1,8 @@
 ---Utilities to help deal with inventories.
 -- Helps you display, manage, and manipulate inventories
---@module sv_invtracker.lua
+--@server sv_invtracker.lua
+
+--@domain Server
 
 --[[
 	some accessability functions
@@ -222,7 +224,7 @@ end
 
 ---A shortcut to remove an item from a player.
 -- Removes an item from a player and returns the item
---@metamethod plymeta:RemoveItem(tbl)
+--@metamethod player:RemoveItem(tbl)
 --@tparam table tbl The position the item is in (returned by plymeta:HasItem())
 --@treturn itemtbl The item that was removed
 function plymeta:RemoveItem(tbl)
@@ -234,7 +236,7 @@ end
 
 ---A shortcut for giving an item to a player.
 -- Gives an item to a player
---@metamethod plymeta:GiveItem(tbl)
+--@metamethod player:GiveItem(tbl)
 --@param itemtbl tbl The item to give the player
 --@raises "Uanble to find place to put item" Raises an exception if we cannot find a location to put the item.
 function plymeta:GiveItem(tbl)
@@ -285,7 +287,10 @@ end
 
 ---Prints a player's inventory to the console.
 --@concommand artery_ShowMyInventories
-concommand.Add("artery_ShowMyInventories",function(ply,cmd,args)
+--@reqadmin
+concommand.Add("artery_ShowMyInventories",
+
+function(ply,cmd,args)
 	PrintTable(ply.data.inventories)
 end)