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

[docs] partial docs pass for code loc format strings

Browse Source
This commit is contained in:
Ryan Fleury
2021-10-08 17:47:38 -06:00
parent 85ca106e15
commit 6aadfcc34b
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/metadesk_reference.mdesk
+10
View File
@@ -1929,6 +1929,16 @@ MD_ParseWholeFile:
return: MD_String8, return: MD_String8,
} }
@send(Nodes)
@doc('Returns the format string for code locations that matches normal encodings of code locations (in error or warning messages by compilers, namely). This string is @code `"%.*s:%i:%i"`. Used with @code "MD_CodeLocVArg", can be used for easily printing code locations.')
@see(MD_CodeLocVArg)
@macro MD_FmtCodeLoc: {}
@send(Nodes)
@doc("Expands to the appropriate C format string arguments for an MD_CodeLoc @code 'loc' matching the format string for code-locations provided by MD_FmtCodeLoc.")
@see(MD_FmtCodeLoc)
@macro MD_CodeLocVArg: {loc}
@send(Nodes) @send(Nodes)
@doc("Prints a message to @code 'out', corresponding with the source code location encoded by @code 'loc'.") @doc("Prints a message to @code 'out', corresponding with the source code location encoded by @code 'loc'.")
@see(MD_PrintMessageFmt) @see(MD_PrintMessageFmt)