From 36a19182bec171d6376e51f5689aaf70b9d6fbad Mon Sep 17 00:00:00 2001 From: jacqueline Date: Thu, 7 Mar 2024 17:22:06 +1100 Subject: Use luals-stubs as the source of truth for docs, instead of maintaining separate docs stubs Includes introducing a cool new script to turn lua-language-server's json output into markdown documentation. --- ldoc-stubs/queue.lua | 32 -------------------------------- 1 file changed, 32 deletions(-) delete mode 100644 ldoc-stubs/queue.lua (limited to 'ldoc-stubs/queue.lua') diff --git a/ldoc-stubs/queue.lua b/ldoc-stubs/queue.lua deleted file mode 100644 index b3000040..00000000 --- a/ldoc-stubs/queue.lua +++ /dev/null @@ -1,32 +0,0 @@ ---- Properties and functions for inspecting and manipulating the track playback queue --- @module queue - -local queue = {} - ---- The index in the queue of the currently playing track. This may be zero if the queue is empty. --- @see types.Property -queue.position = types.Property - ---- The total number of tracks in the queue, including tracks which have already been played. --- @see types.Property -queue.size = types.Property - ---- Determines whether or not the queue will be restarted after the final track is played. --- @see types.Property -queue.replay = types.Property - --- Determines whether or not the current track will repeat indefinitely --- @see types.Property -queue.repeat_track = types.Property - ---- Determines whether, when progressing to the next track in the queue, the next track will be chosen randomly. The random selection algorithm used is a Miller Shuffle, which guarantees that no repeat selections will be made until every item in the queue has been played. --- @see types.Property -queue.random = types.Property - ---- Moves forward in the play queue, looping back around to the beginning if repeat is on. -function queue.next() end - ---- Moves backward in the play queue, looping back around to the end if repeat is on. -function queue.previous() end - -return queue -- cgit v1.2.3