Browse Source

Update mem doc example formatting

Eric Johnson 1 year ago
parent
commit
4b7f32c287
1 changed files with 23 additions and 24 deletions
  1. 23 24
      core/mem/doc.odin

+ 23 - 24
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