Forráskód Böngészése

Merge pull request #3281 from erjohnson/patch-1

Update mem doc example formatting
Laytan 1 éve
szülő
commit
3847d03248
1 módosított fájl, 19 hozzáadás és 20 törlés
  1. 19 20
      core/mem/doc.odin

+ 19 - 20
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
+Example:
+	package foo
 
-import "core:mem"
-import "core:fmt"
+	import "core:mem"
+	import "core:fmt"
 
-_main :: proc() {
-	do stuff
-}
+	_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 :: 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()
+		_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)
+		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