read-only fixes

library/renoise/application.lua

@@ -17,48 +17,60 @@ renoise.Application = {}
 
 ---@class renoise.Application
 ---
----**READ-ONLY** Access to the application's full log filename and path. Will
+---Access to the application's full log filename and path. Will
 ---already be opened for writing, but you nevertheless should be able to read
 ---from it.
+---**READ-ONLY**
 ---@field log_filename string
 ---
----**READ-ONLY** Get the apps main document, the song.
+---Get the apps main document, the song.
 ---The global "renoise.song()" function is, in fact, a shortcut to this property.
+---**READ-ONLY**
 ---@field current_song renoise.Song?
 ---
----**READ-ONLY** List of recently loaded song files.
+---List of recently loaded song files.
+---**READ-ONLY**
 ---@field recently_loaded_song_files string[]
----**READ-ONLY** List of recently saved song files.
+---List of recently saved song files.
+---**READ-ONLY**
 ---@field recently_saved_song_files string[]
 ---
----**READ-ONLY** Returns information about all currently installed tools.
+---Returns information about all currently installed tools.
+---**READ-ONLY**
 ---@field installed_tools table<string, string>
 ---Fired when the list of installed tools changed.
+---**READ-ONLY**
 ---@field installed_tools_observable renoise.Document.Observable
 ---
 ---Fired when the list of available audio plugin effects changed, for example
 ---when scanning for new plugins in the preferences.
 ---Use the component's `available_plugins` or `available_devices` properties
 ---to access currently available devices which are supported by the component
 ---such as the track device chains.
+---**READ-ONLY**
 ---@field audio_plugin_effects_observable renoise.Document.Observable
 ---Fired when the list of available audio plugin instruments changed, for example
 ---when scanning for new plugins in the preferences.
+---**READ-ONLY**
 ---@field audio_plugin_instruments_observable renoise.Document.Observable
 ---
 ---**Deprecated.** **READ-ONLY** Use `key_modifier_flags` instead
 ---@deprecated
 ---@field key_modifier_states table<string, string>
----**READ-ONLY** Access keyboard modifier states.
+---Access keyboard modifier states.
+---**READ-ONLY**
 ---@field key_modifier_flags ModifierFlags
 ---
----**READ-ONLY** Access to the application's window.
+---Access to the application's window.
+---**READ-ONLY**
 ---@field window renoise.ApplicationWindow
 ---
----**READ-ONLY** Access to the application's color theme.
+---Access to the application's color theme.
+---**READ-ONLY**
 ---@field theme renoise.ApplicationTheme
 ---Fired, when *any* theme color changed. e.g. when a new theme got loaded
 ---or when theme colors got edited in the theme preferences.
+---**READ-ONLY**
 ---@field theme_observable renoise.Document.Observable
 ---
 ---Range: (1 - 4) Get or set globally used clipboard "slots" in the application.
@@ -116,10 +128,11 @@ function renoise.Application:show_prompt(title, message, button_labels) end
 ---@class KeyEvent
 ---@field name string name of the key, like 'esc' or 'a'
 ---**Deprecated.** Use `modifier_flags` instead
----**READ-ONLY** the held down modifiers as a string
----@deprecated
+---the held down modifiers as a string
+---@deprecated **READ-ONLY**
 ---@field modifiers ModifierStates
----**READ-ONLY** the held down modifiers as flags
+---the held down modifiers as flags
+---**READ-ONLY**
 ---@field modifier_flags ModifierFlags
 ---possible character representation of the key
 ---@field character string?
@@ -148,7 +161,7 @@ function renoise.Application:show_prompt(title, message, button_labels) end
 
 ---Optional focus change notifier for a custom dialog.
 ---Will be called when the dialog gains of loses key focus. You maybe want to initialize
----your dloag's (modifier) keyboard states here.
+---your dialog's (modifier) keyboard states here.
 ---@alias FocusHandler fun(dialogs: renoise.Dialog, focused: boolean) : KeyEvent?
 ---@alias FocusHandlerMemberFunction fun(self: NotifierMemberContext, dialog: renoise.Dialog, focused: boolean): KeyEvent?
 ---@alias FocusHandlerMethod1 {[1]:NotifierMemberContext, [2]:FocusHandlerMemberFunction}
@@ -423,10 +436,12 @@ function renoise.Application:save_theme(filename) end
 ---create views for the dialog.
 ---@class renoise.Dialog
 ---
---- **READ-ONLY** Check if a dialog is alive and visible.
+---Check if a dialog is alive and visible.
+---**READ-ONLY**
 ---@field visible boolean
---- **READ-ONLY** Check if a dialog is visible and is the key window.
----@field focused boolean
+---Check if a dialog is visible and is the key window.
+---**READ-ONLY**
+---@field focused boolean 
 renoise.Dialog = {}
 
 ---### functions

library/renoise/application/theme.lua

@@ -127,31 +127,36 @@ renoise.ApplicationTheme = {}
 
 ---@class renoise.ApplicationTheme
 ---
----**READ-ONLY** Get all theme colors in a flat list of RGBColors.
+---Get all theme colors in a flat list of RGBColors.
 ---Color table keys are string identifiers as used in the theme XML file,
 ---but in lower case.
 ---
 ---Note that if you only need to access a single color from the theme,
 ---use `renoise.app().theme.color(color_name)` instead.
 ---
 ---To get notified of color changes, use `renoise.app().theme_observable`
+---**READ-ONLY**
 ---@field colors { [ThemeColor]: RGBColor }
 ---
----**READ-ONLY** Get theme's knob shade setting. Range: (1 - 2)
+---Get theme's knob shade setting. Range: (1 - 2)
+---**READ-ONLY**
 ---@field knob_shade number
----@field knob_shade_observable renoise.Document.Observable
+---@field knob_shade_observable renoise.Document.Observable **READ-ONLY**
 ---
----**READ-ONLY** Get theme's body shade setting. Range: (1 - 2)
+---Get theme's body shade setting. Range: (1 - 2)
+---**READ-ONLY**
 ---@field body_shade number
----@field body_shade_observable renoise.Document.Observable
+---@field body_shade_observable renoise.Document.Observable **READ-ONLY**
 ---
----**READ-ONLY** Get theme's contrast setting. Range: (-0.5 - 0.5)
+---Get theme's contrast setting. Range: (-0.5 - 0.5)
+---**READ-ONLY**
 ---@field contrast number
----@field contrast_observable renoise.Document.Observable
+---@field contrast_observable renoise.Document.Observable **READ-ONLY**
 ---
----**READ-ONLY** Get theme's texture set name
+---Get theme's texture set name
+---**READ-ONLY**
 ---@field texture_set string
----@field texture_set_observable renoise.Document.Observable
+---@field texture_set_observable renoise.Document.Observable **READ-ONLY**
 ---
 ---### functions
 

library/renoise/application/window.lua

@@ -76,10 +76,12 @@ renoise.ApplicationWindow = {
 ---Get/set if the application is running fullscreen.
 ---@field fullscreen boolean
 ---
----**READ-ONLY**. Window status flag.
+---Window status flag.
+---**READ-ONLY**
 ---@field is_maximized boolean
 ---
----**READ-ONLY**. Window status flag.
+---Window status flag.
+---**READ-ONLY**
 ---@field is_minimized boolean
 ---
 ---When true, the middle frame views (like the pattern editor) will
@@ -91,26 +93,26 @@ renoise.ApplicationWindow = {
 ---
 ---Diskbrowser Panel.
 ---@field disk_browser_is_visible boolean
----@field disk_browser_is_visible_observable renoise.Document.Observable
+---@field disk_browser_is_visible_observable renoise.Document.Observable **READ-ONLY**
 ---
 ---@field disk_browser_category renoise.ApplicationWindow.DiskBrowserCategory
----@field disk_browser_category_observable renoise.Document.Observable
+---@field disk_browser_category_observable renoise.Document.Observable **READ-ONLY**
 ---
 ---InstrumentBox
 ---@field instrument_box_is_visible boolean
----@field instrument_box_is_visible_observable renoise.Document.Observable
+---@field instrument_box_is_visible_observable renoise.Document.Observable **READ-ONLY**
 ---
 ---InstrumentBox slot size
 ---@field instrument_box_slot_size renoise.ApplicationWindow.InstrumentBoxSlotSize
----@field instrument_box_slot_size_observable renoise.Document.Observable
+---@field instrument_box_slot_size_observable renoise.Document.Observable **READ-ONLY**
 ---
 ---Instrument Editor detaching.
 ---@field instrument_editor_is_detached boolean
----@field instrument_editor_is_detached_observable renoise.Document.Observable
+---@field instrument_editor_is_detached_observable renoise.Document.Observable **READ-ONLY**
 ---
 ---InstrumentProperties (below InstrumentBox)
 ---@field instrument_properties_is_visible boolean
----@field instrument_properties_is_visible_observable renoise.Document.Observable
+---@field instrument_properties_is_visible_observable renoise.Document.Observable **READ-ONLY**
 ---@field instrument_properties_show_volume_transpose boolean
 ---@field instrument_properties_show_trigger_options boolean
 ---@field instrument_properties_show_scale_options boolean
@@ -123,47 +125,47 @@ renoise.ApplicationWindow = {
 ---
 ---SampleProperties (below SampleNavigator)
 ---@field sample_properties_is_visible boolean
----@field sample_properties_is_visible_observable renoise.Document.Observable
+---@field sample_properties_is_visible_observable renoise.Document.Observable **READ-ONLY**
 ---
 ---Mixer View detaching.
 ---@field mixer_view_is_detached boolean
----@field mixer_view_is_detached_observable renoise.Document.Observable
+---@field mixer_view_is_detached_observable renoise.Document.Observable **READ-ONLY**
 ---
 ---Frame with the scopes/master spectrum...
 ---@field upper_frame_is_visible boolean
----@field upper_frame_is_visible_observable renoise.Document.Observable
+---@field upper_frame_is_visible_observable renoise.Document.Observable **READ-ONLY**
 ---@field active_upper_frame renoise.ApplicationWindow.UpperFrame
----@field active_upper_frame_observable renoise.Document.Observable
+---@field active_upper_frame_observable renoise.Document.Observable **READ-ONLY**
 ---
 --Frame with the pattern editor, mixer...
 ---@field active_middle_frame renoise.ApplicationWindow.MiddleFrame
----@field active_middle_frame_observable renoise.Document.Observable
+---@field active_middle_frame_observable renoise.Document.Observable **READ-ONLY**
 ---
 ---Frame with the DSP chain view, automation, etc.
 ---@field lower_frame_is_visible boolean
----@field lower_frame_is_visible_observable renoise.Document.Observable
+---@field lower_frame_is_visible_observable renoise.Document.Observable **READ-ONLY**
 ---@field active_lower_frame renoise.ApplicationWindow.LowerFrame
----@field active_lower_frame_observable renoise.Document.Observable
+---@field active_lower_frame_observable renoise.Document.Observable **READ-ONLY**
 ---
 ---Frame with Disk Browser and Instrument Box.
 ---@field right_frame_is_visible boolean
----@field right_frame_is_visible_observable renoise.Document.Observable
+---@field right_frame_is_visible_observable renoise.Document.Observable **READ-ONLY**
 ---
 ---Pattern matrix, visible in pattern editor and mixer only...
 ---@field pattern_matrix_is_visible boolean
----@field pattern_matrix_is_visible_observable renoise.Document.Observable
+---@field pattern_matrix_is_visible_observable renoise.Document.Observable **READ-ONLY**
 ---
 ---Pattern advanced edit, visible in pattern editor only...
 ---@field pattern_advanced_edit_is_visible boolean
----@field pattern_advanced_edit_is_visible_observable renoise.Document.Observable
+---@field pattern_advanced_edit_is_visible_observable renoise.Document.Observable **READ-ONLY**
 ---
 ---Mixer views Pre/Post volume setting.
 ---@field mixer_view_post_fx boolean
----@field mixer_view_post_fx_observable renoise.Document.Observable
+---@field mixer_view_post_fx_observable renoise.Document.Observable **READ-ONLY**
 ---
 ---Mixer fader type setting.
 ---@field mixer_fader_type renoise.ApplicationWindow.MixerFader
----@field mixer_fader_type_observable renoise.Document.Observable
+---@field mixer_fader_type_observable renoise.Document.Observable **READ-ONLY**
 
 ---### functions
 

library/renoise/osc.lua

@@ -33,15 +33,18 @@ function renoise.Osc.from_binary_data(binary_data) end
 
 ---@class renoise.Osc.Message
 ---
----**READ-ONLY** The message pattern (e.g. "/renoise/transport/start")
+---The message pattern (e.g. "/renoise/transport/start")
+---**READ-ONLY**
 ---@field pattern string
 ---
----**READ-ONLY** Table of `{tag="X", value=SomeValue}` that represents the
+---Table of `{tag="X", value=SomeValue}` that represents the
 ---message arguments. See `renoise.Osc.Message.create` for more info.
+---**READ-ONLY**
 ---@field arguments OscValue[]
 ---
----**READ-ONLY** Raw binary representation of the message, as needed when e.g.
+---Raw binary representation of the message, as needed when e.g.
 ---sending the message over the network through sockets.
+---**READ-ONLY**
 ---@field binary_data string
 renoise.Osc.Message = {}
 
@@ -87,14 +90,17 @@ function renoise.Osc.Message(pattern, arguments) end
 
 ---@class renoise.Osc.Bundle
 ---
----**READ-ONLY** Time value of the bundle.
+---Time value of the bundle.
+---**READ-ONLY**
 ---@field timetag number
 ---
----**READ-ONLY** Access to the bundle elements (table of messages or bundles)
+---Access to the bundle elements (table of messages or bundles)
+---**READ-ONLY**
 ---@field elements (renoise.Osc.Message|renoise.Osc.Bundle)[]
 ---
--- **READ-ONLY** Raw binary representation of the bundle, as needed when e.g.
+---Raw binary representation of the bundle, as needed when e.g.
 ---sending the message over the network through sockets.
+---**READ-ONLY**
 ---@field binary_data string
 renoise.Osc.Bundle = {}
 

library/renoise/socket.lua

@@ -80,17 +80,20 @@ function renoise.Socket.create_client(server_address, server_port, protocol, tim
 ---SocketBase properties and functions are available for servers and clients.
 ---@class renoise.Socket.SocketBase
 ---
----**READ-ONLY** Returns true when the socket object is valid and connected.
+---Returns true when the socket object is valid and connected.
 ---Sockets can manually be closed (see socket:close()). Client sockets can also
 ---actively be closed/refused by the server. In this case the client:receive()
 ---calls will fail and return an error.
+---**READ-ONLY**
 ---@field is_open boolean
 ---
----**READ-ONLY** The socket's resolved local address (for example "127.0.0.1"
+---The socket's resolved local address (for example "127.0.0.1"
 ---when a socket is bound to "localhost")
+---**READ-ONLY**
 ---@field local_address string
 ---
----**READ-ONLY** The socket's local port number, as specified when instantiated.
+---The socket's local port number, as specified when instantiated.
+---**READ-ONLY**
 ---@field local_port integer
 renoise.Socket.SocketBase = {}
 
@@ -120,12 +123,14 @@ function renoise.Socket.SocketBase:close() end
 ---messages it will not block or timeout.
 ---@class renoise.Socket.SocketClient : renoise.Socket.SocketBase
 ---
----**READ-ONLY** Address of the socket's peer, the socket address this client
+---Address of the socket's peer, the socket address this client
 ---is connected to.
+---**READ-ONLY**
 ---@field peer_address string
 ---
----**READ-ONLY** Port of the socket's peer, the socket this client is
+---Port of the socket's peer, the socket this client is
 ---connected to.
+---**READ-ONLY**
 ---@field peer_port integer
 renoise.Socket.SocketClient = {}
 
@@ -192,7 +197,8 @@ function renoise.Socket.SocketClient:receive(mode, timeout_ms) end
 ---callbacks are invoked to respond to messages.
 ---@class renoise.Socket.SocketServer : renoise.Socket.SocketBase
 ---
----**READ-ONLY** true while the server is running, else false.
+---true while the server is running, else false.
+---**READ-ONLY**
 ---@field is_running boolean
 renoise.Socket.SocketServer = {}