summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2015-01-23 14:23:18 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2015-01-23 14:23:18 -0800
commit6002fdbc030bb1c93f100d2b6a4df5cefec963f1 (patch)
tree8d7e92ec0504cc13b327d076de91bce916559ece /man
parent96a4e04522584aab4ea1fe444f971bec935abc8a (diff)
parent8a5b76740102dad3d7f1be154af1910174c973f0 (diff)
Merge pull request #296 from nwellnhof/version_info
Improve version information
Diffstat (limited to 'man')
-rw-r--r--man/man3/cmark.351
1 files changed, 38 insertions, 13 deletions
diff --git a/man/man3/cmark.3 b/man/man3/cmark.3
index f889521..4b24391 100644
--- a/man/man3/cmark.3
+++ b/man/man3/cmark.3
@@ -1,4 +1,4 @@
-.TH cmark 3 "January 20, 2015" "LOCAL" "Library Functions Manual"
+.TH cmark 3 "January 23, 2015" "LOCAL" "Library Functions Manual"
.SH
NAME
.PP
@@ -10,18 +10,6 @@ DESCRIPTION
Simple Interface
.PP
-.nf
-\fC
-.RS 0n
-#define CMARK_VERSION "0.1"
-.RE
-\f[]
-.fi
-
-.PP
-Current version of library.
-
-.PP
\fIchar *\f[] \fBcmark_markdown_to_html\f[](\fIconst char *text\f[], \fIint len\f[])
.PP
@@ -532,6 +520,43 @@ Render \f[C]softbreak\f[] elements as hard line breaks.
.PP
Normalize tree by consolidating adjacent text nodes.
+.SS
+Version information
+
+.PP
+.nf
+\fC
+.RS 0n
+extern const int cmark_version;
+.RE
+\f[]
+.fi
+
+.PP
+The library version as integer for runtime checks. Also available as
+macro CMARK_VERSION for compile time checks.
+.IP \[bu] 2
+Bits 16\-23 contain the major version.
+.IP \[bu] 2
+Bits 8\-15 contain the minor version.
+.IP \[bu] 2
+Bits 0\-7 contain the patchlevel.
+.PP
+In hexadecimal format, the number 0x010203 represents version 1.2.3.
+
+.PP
+.nf
+\fC
+.RS 0n
+extern const char cmark_version_string[];
+.RE
+\f[]
+.fi
+
+.PP
+The library version string for runtime checks. Also available as
+macro CMARK_VERSION_STRING for compile time checks.
+
.SH
AUTHORS
.PP