From e3edbd5a6f727d07d55adc2799eab8fb35dcc7b0 Mon Sep 17 00:00:00 2001 From: C3pa <41503714+C3pa@users.noreply.github.com> Date: Wed, 18 Jun 2025 08:55:51 +0200 Subject: [PATCH] Small documentation improvements (#408) doc: add syntax highlighting to std::ptr::NullablePtr example, fix description of type::escape_bytes Co-authored-by: paxcut <53811119+paxcut@users.noreply.github.com> --- includes/std/ptr.pat | 4 ++-- includes/type/magic.pat | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/includes/std/ptr.pat b/includes/std/ptr.pat index 22d4b1d..a1fbeb7 100644 --- a/includes/std/ptr.pat +++ b/includes/std/ptr.pat @@ -47,9 +47,9 @@ namespace auto std::ptr { Example: A struct field called `p_myInfo` which is a nullable 64-bit pointer to an element of type `MyInfoTy` would be written as: - ``` + ```rust struct MyStruct { - std::ptr::NullablePtr p_myInfo; + std::ptr::NullablePtr p_myInfo; } ``` */ diff --git a/includes/type/magic.pat b/includes/type/magic.pat index d8a2451..64b8517 100644 --- a/includes/type/magic.pat +++ b/includes/type/magic.pat @@ -11,7 +11,7 @@ namespace auto type { /** - Escapes all bytes in a string to only contain printable characters. All non-printable bytes will be transformed to sequences in the form form \xFF + Escapes all bytes in a string to only contain printable characters. All non-printable bytes will be transformed to sequences in the \xFF form @param value Byte array to escape @return Escaped string */