Add docstring sections

This commit is contained in:
Jordan Irwin 2021-08-12 07:12:19 -07:00
parent 94ac1148a6
commit c4f6ffa5a7

View File

@ -4,6 +4,12 @@
-- @topic groups
--- Balloon
--
-- @section balloon
--- @sndgroup sounds.balloon_inflate
-- @snd balloon_inflate
sounds.balloon_inflate = SoundGroup({
@ -26,6 +32,13 @@ sounds.balloon_pop = SoundGroup({
-- @sndgroup sounds.balloon
sounds.balloon = sounds.balloon_inflate + sounds.balloon_pop
--- Bicycle
--
-- @section bicycle
--- @sndgroup sounds.bicycle_bell
-- @snd bicycle_bell
sounds.bicycle_bell = SoundGroup({
@ -61,24 +74,52 @@ sounds.bite = SoundGroup({
"apple_bite",
})
--- Bounce
--
-- @section bounce
--- @sndgroup sounds.bounce
-- @snd boing
sounds.bounce = SoundGroup({
"boing",
})
--- Clock
--
-- @section clock
--- @sndgroup sounds.clock
-- @snd clock_tick
sounds.clock = SoundGroup({
"clock_tick",
})
--- Coin
--
-- @section coin
--- @sndgroup sounds.coin
-- @snd coin
sounds.coin = SoundGroup({
"coin",
})
--- Door
--
-- @section door
--- @sndgroup sounds.door_close
-- @snd door_close_01
-- @snd door_close_02
@ -133,30 +174,65 @@ sounds.doorbell = SoundGroup({
sounds.door = sounds.door_close + sounds.door_creak + sounds.door_knock + sounds.door_open
+ sounds.doorbell
--- Entity
--
-- @section entity
--- @sndgroup sounds.entity_hit
-- @snd entity_hit
sounds.entity_hit = SoundGroup({
"entity_hit",
})
--- Explosion
--
-- @section explosion
--- @sndgroup sounds.explosion
-- @snd explosion
sounds.explosion = SoundGroup({
"explosion",
})
--- Fire
--
-- @section fire
--- @sndgroup sounds.fire
-- @snd fire_crackle (loopable)
sounds.fire = SoundGroup({
"fire_crackle",
})
--- Fuse
--
-- @section fuse
--- @sndgroup sounds.fuse
-- @snd fuse
sounds.fuse = SoundGroup({
"fuse",
})
--- Gallop
--
-- @section gallop
--- @sndgroup sounds.gallop
-- @snd gallop_01
-- @snd gallop_02
@ -165,12 +241,26 @@ sounds.gallop = SoundGroup({
"gallop_02",
})
--- Lava
--
-- @section laval
--- @sndgroup sounds.lava_cool
-- @snd[r3] lava_cool
sounds.lava_cool = SoundGroup({
"lava_cool",
})
--- Leaves
--
-- @section leaves
--- @sndgroup sounds.leaves
-- @snd leaves_01
-- @snd leaves_02
@ -179,12 +269,26 @@ sounds.leaves = SoundGroup({
"leaves_02",
})
--- Match
--
-- @section match
--- @sndgroup sounds.match
-- @snd match_ignite
sound.match = SoundGroup({
"match_ignite",
})
--- Pencil
--
-- @section pencil
--- @sndgroup sounds.pencil_erase
-- @snd pencil_erase
sounds.pencil_erase = SoundGroup({
@ -207,18 +311,39 @@ sounds.pencil_write = SoundGroup({
-- @sndgroup sounds.pencil
sounds.pencil = sounds.pencil_erase + sounds.pencil_write
--- Piano
--
-- @section piano
--- @sndgroup sounds.piano
-- @snd piano
sounds.piano = SoundGroup({
"piano",
})
--- Tool
--
-- @section tool
--- @sndgroup sounds.tool_break
-- @snd[r3] tool_break
sounds.tool_break = SoundGroup({
"tool_break",
})
--- Vomit
--
-- @section vomit
--- @sndgroup sounds.vomit
-- @snd vomit_01
-- @snd vomit_02
@ -233,18 +358,39 @@ sounds.vomit = SoundGroup({
"vomit_05",
})
--- Watch
--
-- @section watch
--- @sndgroup sounds.watch
-- @snd watch_tick
sounds.watch = SoundGroup({
"watch_tick",
})
--- Whistle
--
-- @section whistle
--- @sndgroup sounds.whistle
-- @snd whistle
sounds.whistle = SoundGroup({
"whistle",
})
--- Woosh
--
-- @section woosh
--- @sndgroup sounds.woosh
-- @snd woosh_01
-- @snd woosh_02
@ -257,6 +403,13 @@ sounds.woosh = SoundGroup({
"woosh_04",
})
--- Zipper
--
-- @section zipper
--- @sndgroup sounds.zipper
-- @snd zipper
sounds.zipper = SoundGroup({