ed/metadesk
1
0
Fork 0
mirror of https://github.com/Ed94/metadesk.git synced 2026-08-02 12:48:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

error/warning message helper docs

Browse Source
This commit is contained in:
ryanfleury
2021-06-30 23:00:34 -06:00
parent f15fc77bfa
commit 07d9bdf609
1 changed files with 49 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/metadesk_reference.md
+49 -17
View File
@@ -1572,36 +1572,68 @@ MD_ParseWholeFile:
//~ Error/Warning Helpers //~ Error/Warning Helpers
@send(Nodes) @send(Nodes)
@doc("Prints a message to @code 'out', corresponding with the source code location encoded by @code 'loc'.")
@see(MD_MessageF)
@see(MD_NodeMessage)
@see(MD_NodeMessageF)
@func MD_Message: { @func MD_Message: {
out: *FILE, @doc("The file to print the message to.")
loc: MD_CodeLoc, out: *FILE,
kind: MD_MessageKind, @doc("The source code location for which the message is intended.")
str: MD_String8, loc: MD_CodeLoc,
@doc("The kind/severity of the message.")
kind: MD_MessageKind,
@doc("The message contents.")
str: MD_String8,
}; };
@send(Nodes) @send(Nodes)
@func MD_Message: { @doc("Prints a C format string message to @code 'out', corresponding with the source code location encoded by @code 'loc'.")
out: *FILE, @see(MD_Message)
loc: MD_CodeLoc, @see(MD_NodeMessage)
kind: MD_MessageKind, @see(MD_NodeMessageF)
fmt: *char, @func MD_MessageF: {
@doc("The file to print the message to.")
out: *FILE,
@doc("The source code location for which the message is intended.")
loc: MD_CodeLoc,
@doc("The kind/severity of the message.")
kind: MD_MessageKind,
@doc("The format string to form the message contents.")
fmt: *char,
"..." "..."
}; };
@send(Nodes) @send(Nodes)
@see(MD_Message)
@see(MD_MessageF)
@see(MD_NodeMessageF)
@doc("Prints a message to @code 'out', corresponding with the source code location of @code 'node'.")
@func MD_NodeMessage: { @func MD_NodeMessage: {
out: *FILE, @doc("The file to print the message to.")
node: *MD_Node, out: *FILE,
kind: MD_MessageKind, @doc("The node for which the message is intended.")
str: MD_String8, node: *MD_Node,
@doc("The kind/severity of the message.")
kind: MD_MessageKind,
@doc("The message contents.")
str: MD_String8,
}; };
@send(Nodes) @send(Nodes)
@doc("Prints a C format string message to @code 'out', corresponding with the source code location of @code 'node'.")
@see(MD_Message)
@see(MD_MessageF)
@see(MD_NodeMessage)
@func MD_NodeMessageF: { @func MD_NodeMessageF: {
out: *FILE, @doc("The file to print the message to.")
node: *MD_Node, out: *FILE,
kind: MD_MessageKind, @doc("The node for which the message is intended.")
fmt: *char, node: *MD_Node,
@doc("The kind/severity of the message.")
kind: MD_MessageKind,
@doc("The format string to form the message contents.")
fmt: *char,
"..." "..."
}; };