From 4b7f32c2872b5baff53b3c2879fe9647214eded8 Mon Sep 17 00:00:00 2001 From: Eric Johnson Date: Fri, 15 Mar 2024 12:26:01 -0700 Subject: [PATCH] Update mem doc example formatting --- core/mem/doc.odin | 47 +++++++++++++++++++++++------------------------ 1 file changed, 23 insertions(+), 24 deletions(-) diff --git a/core/mem/doc.odin b/core/mem/doc.odin index e232428c2..5e6e1a929 100644 --- a/core/mem/doc.odin +++ b/core/mem/doc.odin @@ -5,31 +5,30 @@ package mem implements various types of allocators. An example of how to use the `Tracking_Allocator` to track subsequent allocations in your program and report leaks and bad frees: -```odin -package foo - -import "core:mem" -import "core:fmt" - -_main :: proc() { - do stuff -} - -main :: proc() { - track: mem.Tracking_Allocator - mem.tracking_allocator_init(&track, context.allocator) - defer mem.tracking_allocator_destroy(&track) - context.allocator = mem.tracking_allocator(&track) - - _main() - - for _, leak in track.allocation_map { - fmt.printf("%v leaked %m\n", leak.location, leak.size) +Example: + package foo + + import "core:mem" + import "core:fmt" + + _main :: proc() { + // do stuff } - for bad_free in track.bad_free_array { - fmt.printf("%v allocation %p was freed badly\n", bad_free.location, bad_free.memory) + + main :: proc() { + track: mem.Tracking_Allocator + mem.tracking_allocator_init(&track, context.allocator) + defer mem.tracking_allocator_destroy(&track) + context.allocator = mem.tracking_allocator(&track) + + _main() + + for _, leak in track.allocation_map { + fmt.printf("%v leaked %m\n", leak.location, leak.size) + } + for bad_free in track.bad_free_array { + fmt.printf("%v allocation %p was freed badly\n", bad_free.location, bad_free.memory) + } } -} -``` */ package mem