diff options
| author | John MacFarlane <jgm@berkeley.edu> | 2016-04-26 21:39:51 -0700 |
|---|---|---|
| committer | John MacFarlane <jgm@berkeley.edu> | 2016-04-26 21:41:16 -0700 |
| commit | 42ea18599f66a3af00887280770aa9479c453b21 (patch) | |
| tree | 60eb8cf89a92b3ea7e11758a93dde00320268bc4 /man | |
| parent | 2aa269f8dcbc0b091a92f89045ff7f6b16ffa09b (diff) | |
Clarify that it's the caller's responsibility to free the buffer...
returned by cmark_render_html etc. Closes #124.
Diffstat (limited to 'man')
| -rw-r--r-- | man/man3/cmark.3 | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/man/man3/cmark.3 b/man/man3/cmark.3 index cf0874a..7808aa9 100644 --- a/man/man3/cmark.3 +++ b/man/man3/cmark.3 @@ -1,4 +1,4 @@ -.TH cmark 3 "April 09, 2016" "LOCAL" "Library Functions Manual" +.TH cmark 3 "April 26, 2016" "LOCAL" "Library Functions Manual" .SH NAME .PP @@ -599,32 +599,37 @@ Rendering \fIchar *\f[] \fBcmark_render_xml\f[](\fIcmark_node *root\f[], \fIint options\f[]) .PP -Render a \f[I]node\f[] tree as XML. +Render a \f[I]node\f[] tree as XML. It is the caller's responsibility to +free the returned buffer. .PP \fIchar *\f[] \fBcmark_render_html\f[](\fIcmark_node *root\f[], \fIint options\f[]) .PP Render a \f[I]node\f[] tree as an HTML fragment. It is up to the user to -add an appropriate header and footer. +add an appropriate header and footer. It is the caller's responsibility +to free the returned buffer. .PP \fIchar *\f[] \fBcmark_render_man\f[](\fIcmark_node *root\f[], \fIint options\f[], \fIint width\f[]) .PP -Render a \f[I]node\f[] tree as a groff man page, without the header. +Render a \f[I]node\f[] tree as a groff man page, without the header. It +is the caller's responsibility to free the returned buffer. .PP \fIchar *\f[] \fBcmark_render_commonmark\f[](\fIcmark_node *root\f[], \fIint options\f[], \fIint width\f[]) .PP -Render a \f[I]node\f[] tree as a commonmark document. +Render a \f[I]node\f[] tree as a commonmark document. It is the caller's +responsibility to free the returned buffer. .PP \fIchar *\f[] \fBcmark_render_latex\f[](\fIcmark_node *root\f[], \fIint options\f[], \fIint width\f[]) .PP -Render a \f[I]node\f[] tree as a LaTeX document. +Render a \f[I]node\f[] tree as a LaTeX document. It is the caller's +responsibility to free the returned buffer. .SS Options |