diff options
| author | Xavier Del Campo Romero <xavi.dcr@tutanota.com> | 2023-09-27 01:09:04 +0200 |
|---|---|---|
| committer | Xavier Del Campo Romero <xavi.dcr@tutanota.com> | 2023-09-27 21:55:58 +0200 |
| commit | adb0973bb355b9f7eb27d9842116e43c7f77d261 (patch) | |
| tree | 295eba8a1f2fde6e6d500fbe7b32ac5330d0bbbe /doc/man3/html_node_free.3 | |
| parent | 0d54bbf08674174c1e7b91ce39984c29b78cf0ba (diff) | |
| download | libweb-adb0973bb355b9f7eb27d9842116e43c7f77d261.tar.gz | |
Add man pages
Diffstat (limited to 'doc/man3/html_node_free.3')
| -rw-r--r-- | doc/man3/html_node_free.3 | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/man3/html_node_free.3 b/doc/man3/html_node_free.3 new file mode 100644 index 0000000..6efc9ed --- /dev/null +++ b/doc/man3/html_node_free.3 @@ -0,0 +1,48 @@ +.TH HTML_NODE_FREE 3 2023-09-16 0.1.0 "slweb Library Reference" + +.SH NAME +html_node_free \- free a HTML node and its children + +.SH SYNOPSIS +.LP +.nf +#include <slweb/html.h> +.P +void html_node_free(struct html_node *\fIn\fP); +.fi + +.SH DESCRIPTION +The +.IR html_node_free (3) +function frees the memory space pointed to by +.IR n , +which must have been returned by a previous call to +.IR html_node_alloc (3). +Children nodes are freed recursively. + +.SH RETURN VALUE +The +.IR html_node_free () +function returns no value. + +.SH ERRORS +No errors are defined. + +.SH NOTES +Since +.IR html_node_free (3) +frees nodes recursively, library users must not attempt to call +.IR html_node_free (3) +for a child node. + +.SH SEE ALSO +.BR html_node_alloc (3), +.BR slweb_html (7). + +.SH COPYRIGHT +Copyright (C) 2023 Xavier Del Campo Romero. +.P +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. |