summaryrefslogtreecommitdiff
path: root/src/cmark.h
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2014-11-30 12:14:37 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2014-11-30 12:14:37 -0800
commit75be85f77f02c8185e8fff607bf3ccf3c8fe3a11 (patch)
treec55fa6651047afc37548e570e2bcb57a9cfc9702 /src/cmark.h
parent7686b7dad5c80d494b993158def220aa8b61ac6e (diff)
Create man 3 page without markdown intermediary.
Use proper man style, marking function types, arguments, etc. See #224.
Diffstat (limited to 'src/cmark.h')
-rw-r--r--src/cmark.h28
1 files changed, 16 insertions, 12 deletions
diff --git a/src/cmark.h b/src/cmark.h
index 9e38500..3b789cf 100644
--- a/src/cmark.h
+++ b/src/cmark.h
@@ -8,26 +8,30 @@
extern "C" {
#endif
-/** # NAME
+/** .Sh NAME
*
- * cmark - CommonMark parsing, manipulating, and rendering
+ * .Nm cmark
+ * .Nd CommonMark parsing, manipulating, and rendering
*/
-/** # SIMPLE INTERFACE
+/** .Sh SIMPLE INTERFACE
*/
/** Current version of library.
*/
#define CMARK_VERSION "0.1"
-/** Convert `text` (assumed to be a UTF-8 encoded string with length `len`)
+/** Convert
+ * .Fa text
+ * (assumed to be a UTF-8 encoded string with length
+ * .Fa len )
* from CommonMark Markdown to HTML, returning a null-terminated,
* UTF-8-encoded string.
*/
CMARK_EXPORT
char *cmark_markdown_to_html(const char *text, int len);
-/** # NODE STRUCTURE
+/** .Sh NODE STRUCTURE
*/
/**
@@ -83,7 +87,7 @@ typedef struct cmark_node cmark_node;
typedef struct cmark_parser cmark_parser;
/**
- * # CREATING AND DESTORYING NODES
+ * .Sh CREATING AND DESTORYING NODES
*/
/**
@@ -97,7 +101,7 @@ CMARK_EXPORT void
cmark_node_free(cmark_node *node);
/**
- * # TREE TRAVERSAL
+ * .Sh TREE TRAVERSAL
*/
CMARK_EXPORT cmark_node*
cmark_node_next(cmark_node *node);
@@ -123,7 +127,7 @@ CMARK_EXPORT cmark_node*
cmark_node_last_child(cmark_node *node);
/**
- * # ACCESSORS
+ * .Sh ACCESSORS
*/
/**
@@ -227,7 +231,7 @@ CMARK_EXPORT int
cmark_node_get_end_line(cmark_node *node);
/**
- * # TREE MANIPULATION
+ * .Sh TREE MANIPULATION
*/
/**
@@ -256,7 +260,7 @@ CMARK_EXPORT int
cmark_node_append_child(cmark_node *node, cmark_node *child);
/**
- * # PARSING
+ * .Sh PARSING
*/
/**
@@ -290,7 +294,7 @@ CMARK_EXPORT
cmark_node *cmark_parse_file(FILE *f);
/**
- * # RENDERING
+ * .Sh RENDERING
*/
/**
@@ -303,7 +307,7 @@ char *cmark_render_ast(cmark_node *root);
CMARK_EXPORT
char *cmark_render_html(cmark_node *root);
-/** # AUTHORS
+/** .Sh AUTHORS
*
* John MacFarlane, Vicent Marti, Kārlis Gaņģis, Nick Wellnhofer.
*/