ed/metadesk
1
0
Fork 0
mirror of https://github.com/Ed94/metadesk.git synced 2026-08-07 16:18:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix some typos; use code for character symbols in docs

Browse Source
This commit is contained in:
ryanfleury
2021-03-31 20:39:07 -06:00
parent 4eaeaf5cd0
commit f19849db87
1 changed files with 631 additions and 629 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/md_docs.md
+19 -17
View File
@@ -1,3 +1,5 @@
title: "Metadesk Reference"
//////////////////////////////// ////////////////////////////////
//~ Basic Unicode string types. //~ Basic Unicode string types.
@@ -20,7 +22,7 @@
size: MD_u64, size: MD_u64,
}; };
@doc("A node in an MD_String8List") @doc("A node in an MD_String8List.")
@struct MD_String8Node: { @struct MD_String8Node: {
next: *MD_String8Node, next: *MD_String8Node,
string: MD_String8, string: MD_String8,
@@ -80,7 +82,7 @@
@doc("A File node represents parsed metadesk source text.") @doc("A File node represents parsed metadesk source text.")
File, File,
@doc("A List node serves as the root of an externally chained list of nodes. It's children are nodes with the MD_NodeKind_Reference kind.") @doc("A List node serves as the root of an externally chained list of nodes. Its children are nodes with the MD_NodeKind_Reference kind.")
List, List,
@doc("A Reference node is an indirection to another node. The node field 'ref_target' contains a pointer to the referenced node. These nodes are typically used for creating externally chained linked lists that gather nodes from a parse tree.") @doc("A Reference node is an indirection to another node. The node field 'ref_target' contains a pointer to the referenced node. These nodes are typically used for creating externally chained linked lists that gather nodes from a parse tree.")
@@ -106,40 +108,40 @@
@prefix(MD_NodeFlag) @prefix(MD_NodeFlag)
@base_type(MD_u32) @base_type(MD_u32)
@flags MD_NodeFlags: { @flags MD_NodeFlags: {
@doc("The node has children in an open/close symbol pair and '(' is the open symbol.") @doc("The node has children in an open/close symbol pair and @code '(' is the open symbol.")
ParenLeft, ParenLeft,
@doc("The node has children in an open/close symbol pair and ')' is the close .") @doc("The node has children in an open/close symbol pair and @code ')' is the close .")
ParenRight, ParenRight,
@doc("The node has children in an open/close symbol pair and '[' is the open symbol.") @doc("The node has children in an open/close symbol pair and @code '[' is the open symbol.")
BracketLeft, BracketLeft,
@doc("The node has children in an open/close symbol pair and ']' is the close symbol.") @doc("The node has children in an open/close symbol pair and @code ']' is the close symbol.")
BracketRight, BracketRight,
@doc("The node has children in an open/close symbol pair and '{' is the close symbol.") @doc("The node has children in an open/close symbol pair and @code '{' is the close symbol.")
BraceLeft, BraceLeft,
@doc("The node has children in an open/close symbol pair and '}' is the close symbol.") @doc("The node has children in an open/close symbol pair and @code '}' is the close symbol.")
BraceRight, BraceRight,
@doc("The delimiter between this node and it's next sibling is a ';'") @doc("The delimiter between this node and its next sibling is a @code ';'.")
BeforeSemicolon, BeforeSemicolon,
@doc("The delimiter between this node and it's next sibling is a ','") @doc("The delimiter between this node and its next sibling is a @code ','.")
BeforeComma, BeforeComma,
@doc("The delimiter between this node and it's previous sibling is a ';'") @doc("The delimiter between this node and its previous sibling is a @code ';'.")
AfterSemicolon, AfterSemicolon,
@doc("The delimiter between this node and it's previous sibling is a ','") @doc("The delimiter between this node and its previous sibling is a @code ','.")
AfterComma, AfterComma,
@doc("The label on this node comes from a token with the MD_TokenKind_NumericLiteral kind.") @doc("The label on this node comes from a token with the @code MD_TokenKind_NumericLiteral kind.")
Numeric, Numeric,
@doc("The label on this node comes from a token with the MD_TokenKind_Identifier kind.") @doc("The label on this node comes from a token with the @code MD_TokenKind_Identifier kind.")
Identifier, Identifier,
@doc("The label on this node comes from a token with the MD_TokenKind_StringLiteral kind.") @doc("The label on this node comes from a token with the @code MD_TokenKind_StringLiteral kind.")
StringLiteral, StringLiteral,
@doc("The label on this node comes from a token with the MD_TokenKind_CharLiteral kind.") @doc("The label on this node comes from a token with the @code MD_TokenKind_CharLiteral kind.")
CharLiteral, CharLiteral,
}; };
@doc("Controls matching rules in routines that compare MD_Node trees") @doc("Controls matching rules in routines that compare MD_Node trees.")
@prefix(MD_NodeMatchFlag) @prefix(MD_NodeMatchFlag)
@base_type(MD_u32) @base_type(MD_u32)
@flags MD_NodeMatchFlags: { @flags MD_NodeMatchFlags: {