]> gitweb.michael.orlitzky.com - libsvgtiny.git/commitdiff
README: document the new svgtiny_LIBCSS_ERROR code
authorMichael Orlitzky <michael@orlitzky.com>
Wed, 4 Oct 2023 03:51:14 +0000 (23:51 -0400)
committerMichael Orlitzky <michael@orlitzky.com>
Wed, 4 Oct 2023 04:11:43 +0000 (00:11 -0400)
README

diff --git a/README b/README
index 36f384259e222fee6e4e461f6269b7465dcba14e..de4639035b9888c49025672eef19822db8a86c62 100644 (file)
--- a/README
+++ b/README
@@ -162,8 +162,16 @@ error. The error is recorded in diagram->error_message and the line
 that caused it in diagram->error_line.
 
 svgtiny_LIBDOM_ERROR indicates that parsing the XML failed. The
-returned diagram will contain no shapes. svgtiny_NOT_SVG means that
-the XML did not contain a top-level <svg> element.
+returned diagram will contain no shapes.
+
+svgtiny_LIBCSS_ERROR indicates that something went wrong in
+libcss. Either it failed to initialize, or it failed to parse
+something within the SVG, or it failed un-initialize (free
+resources). Except in the last case, the returned diagram will be
+empty.
+
+svgtiny_NOT_SVG means that the XML did not contain a top-level
+<svg> element.
 
 To free memory used by a diagram, use svgtiny_free():