diff options
| author | Giuseppe Gadola <giusgadola@gmail.com> | 2023-02-09 01:15:25 +0100 |
|---|---|---|
| committer | Giuseppe Gadola <giusgadola@gmail.com> | 2023-02-10 16:05:59 +0100 |
| commit | ae8e68bc4abbd726e0aed587f22b60a80da546a3 (patch) | |
| tree | 2f47267c3a9e9e4e86df5ed26bb182ac6258b336 /lua/pets/pet.lua | |
| parent | refactor: removed old ShowPet function (diff) | |
docs: added some basic comments to explain functions
Diffstat (limited to 'lua/pets/pet.lua')
| -rw-r--r-- | lua/pets/pet.lua | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/lua/pets/pet.lua b/lua/pets/pet.lua index 30e3461..f1f04c3 100644 --- a/lua/pets/pet.lua +++ b/lua/pets/pet.lua @@ -2,6 +2,10 @@ local M = {} M.Pet = {} M.Pet.__index = M.Pet +-- @param name the actual name for the pet +-- @param type the species of the pet e.g. cat +-- @param style the color/style of the pet e.g. brown +-- @return a new Pet instance function M.Pet.new(name, type, style) local instance = setmetatable({}, M.Pet) instance.name = name |