docs: shuffle files to have the same logical hierarchy as on the generated doc

Also:
 - rename some files to remove redundant information from the filenames
 - rename many labels to match the filename and its place in the hierarchy
 - move lua_api under the scripting section
This commit is contained in:
George Kiagiadakis
2023-12-23 12:36:27 +02:00
parent 7dfc346a7b
commit f3f89b8fc1
87 changed files with 82 additions and 63 deletions

View File

@@ -0,0 +1,56 @@
.. _lua_log_api:
Debug Logging
=============
.. function:: Log.warning(object, message)
Logs a warning message, like :c:macro:`wp_warning_object`
:param object: optional object to associate the message with; you
may skip this and just start with the *message* as the first parameter
:type object: GObject or GBoxed
:param string message: the warning message to log
.. function:: Log.notice(object, message)
Logs a notice message, like :c:macro:`wp_notice_object`
:param object: optional object to associate the message with; you
may skip this and just start with the *message* as the first parameter
:type object: GObject or GBoxed
:param string message: the normal message to log
.. function:: Log.info(object, message)
Logs a info message, like :c:macro:`wp_info_object`
:param object: optional object to associate the message with; you
may skip this and just start with the *message* as the first parameter
:type object: GObject or GBoxed
:param string message: the info message to log
.. function:: Log.debug(object, message)
Logs a debug message, like :c:macro:`wp_debug_object`
:param object: optional object to associate the message with; you
may skip this and just start with the *message* as the first parameter
:type object: GObject or GBoxed
:param string message: the debug message to log
.. function:: Log.trace(object, message)
Logs a trace message, like :c:macro:`wp_trace_object`
:param object: optional object to associate the message with; you
may skip this and just start with the *message* as the first parameter
:type object: GObject or GBoxed
:param string message: the trace message to log
.. function:: Debug.dump_table(t)
Prints a table with all its contents, recursively, to stdout
for debugging purposes
:param table t: any table