Merge pull request #159 from JuliaImGui/docstring-escape

Escape null-terminators properly in docstrings
JuliaImGui · Dec 22, 2024 · 3d6df46 · 3d6df46
2 parents eccc819 + 403eb7b
commit 3d6df46
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/gen/generator.jl b/gen/generator.jl
@@ -54,6 +54,7 @@ function create_docstring(func_name, overload)
 
     comment = get(overload, :comment, "")
     if !isempty(comment)
+        comment = replace(comment, "\\0" => "\\\\0")
         formatted_comment = chopprefix(comment, "//") |> strip |> uppercasefirst
         if !isempty(formatted_comment) && formatted_comment[end] ∉ ('.', '!', '?')
             formatted_comment *= "."
@@ -561,10 +562,10 @@ function generate()
             for w in wrappers
                 write(io,
                       """
-                          \"\"\"
-                          $(w.docstring)
-                          \"\"\"
-                          """)
+                      \"\"\"
+                      $(w.docstring)
+                      \"\"\"
+                      """)
                 write(io, string(w.expr), "\n\n")
             end
 

diff --git a/src/wrapper.jl b/src/wrapper.jl
@@ -1420,7 +1420,7 @@ Combo(
 """
 $(TYPEDSIGNATURES)
 
-Separate items with \0 within a string, end item-list with \0\0. e.g. "One\0Two\0Three\0".
+Separate items with \\0 within a string, end item-list with \\0\\0. e.g. "One\\0Two\\0Three\\0".
 
 [Upstream link](https://github.com/ocornut/imgui/blob/v1.91.6-docking/imgui.h#L585).
 """