Docs

.sublime/karl2d.sublime-project

@@ -9,164 +9,161 @@
 				{
 					"name": "minimal",
 					"shell_cmd": "odin run . -vet -strict-style -keep-executable -debug -define:KARL2D_RENDER_BACKEND=d3d11",
-					"working_dir": "$project_path/../examples/minimal"
+					"working_dir": "$project_path/../examples/minimal",
 				},
 				{
 					"name": "minimal (gl)",
 					"shell_cmd": "odin run . -vet -strict-style -keep-executable -debug -define:KARL2D_RENDER_BACKEND=gl",
-					"working_dir": "$project_path/../examples/minimal"
+					"working_dir": "$project_path/../examples/minimal",
 				},
 				{
 					"name": "minimal (web)",
 					"shell_cmd": "odin run build_web_example -vet -strict-style -- minimal_web",
-					"working_dir": "$project_path/../examples"
+					"working_dir": "$project_path/../examples",
 				},
 				{
 					"name": "fonts",
 					"shell_cmd": "odin run . -vet -strict-style -keep-executable -debug",
-					"working_dir": "$project_path/../examples/fonts"
+					"working_dir": "$project_path/../examples/fonts",
 				},
 				{
 					"name": "fonts (web)",
 					"shell_cmd": "odin run build_web_example -- fonts",
-					"working_dir": "$project_path/../examples"
+					"working_dir": "$project_path/../examples",
 				},
 				{
 					"name": "render_texture",
 					"shell_cmd": "odin run . -vet -strict-style -keep-executable -debug",
-					"working_dir": "$project_path/../examples/render_texture"
+					"working_dir": "$project_path/../examples/render_texture",
 				},
 				{
 					"name": "render_texture (gl)",
 					"shell_cmd": "odin run . -vet -strict-style -keep-executable -debug  -define:KARL2D_RENDER_BACKEND=gl",
-					"working_dir": "$project_path/../examples/render_texture"
+					"working_dir": "$project_path/../examples/render_texture",
 				},
 				{
 					"name": "render_texture (web)",
 					"shell_cmd": "odin run build_web_example -- render_texture",
-					"working_dir": "$project_path/../examples"
+					"working_dir": "$project_path/../examples",
 				},
 				{
 					"name": "multitexture",
 					"shell_cmd": "odin run . -vet -strict-style -keep-executable -debug -define:KARL2D_RENDER_BACKEND=d3d11",
-					"working_dir": "$project_path/../examples/multitexture"
+					"working_dir": "$project_path/../examples/multitexture",
 				},
 				{
 					"name": "multitexture (gl)",
 					"shell_cmd": "odin run . -vet -strict-style -keep-executable -debug -define:KARL2D_RENDER_BACKEND=gl",
-					"working_dir": "$project_path/../examples/multitexture"
+					"working_dir": "$project_path/../examples/multitexture",
 				},
 				{
 					"name": "multitexture (webgl)",
 					"shell_cmd": "odin run build_web_example -- multitexture",
-					"working_dir": "$project_path/../examples"
+					"working_dir": "$project_path/../examples",
 				},
 				{
 					"name": "snake",
 					"shell_cmd": "odin run . -vet -strict-style -keep-executable -debug",
-					"working_dir": "$project_path/../examples/snake"
+					"working_dir": "$project_path/../examples/snake",
 				},
 				{
 					"name": "snake (web)",
 					"shell_cmd": "odin run build_web_example -- snake",
-					"working_dir": "$project_path/../examples"
+					"working_dir": "$project_path/../examples",
 				},
 				{
 					"name": "box2d",
 					"shell_cmd": "odin run . -vet -strict-style -keep-executable",
-					"working_dir": "$project_path/../examples/box2d"
+					"working_dir": "$project_path/../examples/box2d",
 				},
 				{
 					"name": "box2d (web)",
 					"shell_cmd": "odin run build_web_example -- box2d",
-					"working_dir": "$project_path/../examples"
+					"working_dir": "$project_path/../examples",
 				},
 				{
 					"name": "premultiplied_alpha",
 					"shell_cmd": "odin run . -vet -strict-style -keep-executable -debug -define:KARL2D_RENDER_BACKEND=d3d11",
-					"working_dir": "$project_path/../examples/premultiplied_alpha"
+					"working_dir": "$project_path/../examples/premultiplied_alpha",
 				},
 				{
 					"name": "premultiplied_alpha (gl)",
 					"shell_cmd": "odin run . -vet -strict-style -keep-executable -debug -define:KARL2D_RENDER_BACKEND=gl",
-					"working_dir": "$project_path/../examples/premultiplied_alpha"
+					"working_dir": "$project_path/../examples/premultiplied_alpha",
 				},
 				{
 					"name": "raylib_ports/2d_camera",
 					"shell_cmd": "odin run . -vet -strict-style -keep-executable -debug",
-					"working_dir": "$project_path/../examples/raylib_ports/2d_camera"
+					"working_dir": "$project_path/../examples/raylib_ports/2d_camera",
 				},
 				{
 					"name": "raylib_ports/shaders_texture_waves",
 					"shell_cmd": "odin run . -keep-executable -debug",
-					"working_dir": "$project_path/../examples/raylib_ports/shaders_texture_waves"
+					"working_dir": "$project_path/../examples/raylib_ports/shaders_texture_waves",
 				},
 				{
 					"name": "bunnymark",
 					"shell_cmd": "odin run . -o:speed -vet -strict-style -no-bounds-check -keep-executable",
-					"working_dir": "$project_path/../examples/raylib_ports/bunnymark"
+					"working_dir": "$project_path/../examples/raylib_ports/bunnymark",
 				},
 				{
 					"name": "bunnymark (web)",
 					"shell_cmd": "odin run build_web_example -- raylib_ports/bunnymark",
-					"working_dir": "$project_path/../examples"
+					"working_dir": "$project_path/../examples",
 				},
 				{
 					"name": "gamepad",
 					"shell_cmd": "odin run . -vet -strict-style -keep-executable",
-					"working_dir": "$project_path/../examples/gamepad"
+					"working_dir": "$project_path/../examples/gamepad",
 				},
 				{
 					"name": "gamepad (web)",
 					"shell_cmd": "odin run build_web_example -- gamepad",
-					"working_dir": "$project_path/../examples"
+					"working_dir": "$project_path/../examples",
 				},
 				{
 					"name": "api_doc_builder",
 					"shell_cmd": "odin run api_doc_builder",
-					"working_dir": "$project_path/.."
+					"working_dir": "$project_path/..",
 				},
-			]
+			],
 		}
 	],
 	"folders":
 	[
 		{
-			"path": "C:\\Projects\\karl2d"
+			"path": "C:\\Projects\\karl2d",
 		},
 		{
-			"path": "C:\\SDK\\Odin\\base"
+			"path": "C:\\SDK\\Odin\\base",
 		},
 		{
-			"path": "C:\\SDK\\Odin\\core"
+			"path": "C:\\SDK\\Odin\\core",
 		},
 		{
-			"path": "C:\\SDK\\Odin\\vendor\\fontstash"
+			"path": "C:\\SDK\\Odin\\vendor\\fontstash",
 		},
 		{
-			"path": "C:\\SDK\\Odin\\vendor\\OpenGL"
+			"path": "C:\\SDK\\Odin\\vendor\\OpenGL",
 		},
 		{
-			"path": "C:\\Projects\\Scraps\\raylib\\src"
+			"path": "C:\\Projects\\Scraps\\raylib\\src",
 		},
 		{
-			"path": "C:\\SDK\\Odin\\vendor\\directx\\d3d11"
+			"path": "C:\\SDK\\Odin\\vendor\\directx\\d3d11",
 		},
 		{
-			"path": "C:\\SDK\\Odin\\vendor\\directx\\dxgi"
+			"path": "C:\\SDK\\Odin\\vendor\\directx\\dxgi",
 		},
 		{
-			"path": "C:\\SDK\\Odin\\vendor\\directx\\d3d_compiler"
+			"path": "C:\\SDK\\Odin\\vendor\\directx\\d3d_compiler",
 		},
 		{
-			"path": "C:\\SDK\\Odin\\vendor\\directx\\dxc"
+			"path": "C:\\SDK\\Odin\\vendor\\directx\\dxc",
 		},
 		{
 			"path": "C:\\SDK\\Odin\\vendor\\wasm\\WebGL"
 		},
-		{
-			"path": "C:\\SDK\\Odin\\vendor\\box2d"
-		}
 	],
 	"settings":
 	{
@@ -174,9 +171,9 @@
 		{
 			"odin":
 			{
-				"enabled": true
-			}
+				"enabled": true,
+			},
 		},
-		"auto_complete": false
-	}
+		"auto_complete": false,
+	},
 }

api_doc_builder/api_doc_builder.odin

@@ -1,3 +1,6 @@
+// This program creates the `karl2d.doc.odin` file by parsing `karl2d.odin`. It skips procedure
+// bodies and stops when it reaches `API_END :: true`. The resulting file is a nice overview of the
+// library's API surface.
 package karl2d_api_doc_builder
 
 import os "core:os"