Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions include/prism.h
Original file line number Diff line number Diff line change
Expand Up @@ -322,10 +322,10 @@ PRISM_EXPORTED_FUNCTION pm_string_query_t pm_string_query_method_name(const uint
* to want to use and be aware of are:
*
* * `pm_parser_t` - the main parser structure
* * `pm_parser_init` - initialize a parser
* * `pm_parse` - parse and return the root node
* * `pm_node_destroy` - deallocate the root node returned by `pm_parse`
* * `pm_parser_free` - free the internal memory of the parser
* * `pm_parser_init()` - initialize a parser
* * `pm_parse()` - parse and return the root node
* * `pm_node_destroy()` - deallocate the root node returned by `pm_parse()`
* * `pm_parser_free()` - free the internal memory of the parser
*
* Putting all of this together would look something like:
*
Expand All @@ -342,8 +342,8 @@ PRISM_EXPORTED_FUNCTION pm_string_query_t pm_string_query_method_name(const uint
* }
* ```
*
* All of the nodes "inherit" from `pm_node_t` by embedding those structures as
* their first member. This means you can downcast and upcast any node in the
* All of the nodes "inherit" from `pm_node_t` by embedding those structures
* as their first member. This means you can downcast and upcast any node in the
* tree to a `pm_node_t`.
*
* @section serializing Serializing
Expand All @@ -355,9 +355,9 @@ PRISM_EXPORTED_FUNCTION pm_string_query_t pm_string_query_method_name(const uint
* use and be aware of are:
*
* * `pm_buffer_t` - a small buffer object that will hold the serialized AST
* * `pm_buffer_free` - free the memory associated with the buffer
* * `pm_serialize` - serialize the AST into a buffer
* * `pm_serialize_parse` - parse and serialize the AST into a buffer
* * `pm_buffer_free()` - free the memory associated with the buffer
* * `pm_serialize()` - serialize the AST into a buffer
* * `pm_serialize_parse()` - parse and serialize the AST into a buffer
*
* Putting all of this together would look something like:
*
Expand All @@ -375,7 +375,7 @@ PRISM_EXPORTED_FUNCTION pm_string_query_t pm_string_query_method_name(const uint
* @section inspecting Inspecting
*
* Prism provides the ability to inspect the AST by pretty-printing nodes. You
* can do this with the `pm_prettyprint` function, which you would use like:
* can do this with the `pm_prettyprint()` function, which you would use like:
*
* ```c
* void prettyprint(const uint8_t *source, size_t length) {
Expand Down
4 changes: 2 additions & 2 deletions include/prism/util/pm_string.h
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ typedef struct {
/** This is a slice of another string, and should not be freed. */
PM_STRING_SHARED,

/** This string owns its memory, and should be freed using `pm_string_free`. */
/** This string owns its memory, and should be freed using `pm_string_free()`. */
PM_STRING_OWNED,

#ifdef PRISM_HAS_MMAP
/** This string is a memory-mapped file, and should be freed using `pm_string_free`. */
/** This string is a memory-mapped file, and should be freed using `pm_string_free()`. */
PM_STRING_MAPPED
#endif
} type;
Expand Down
Loading