API Reference

API documentation is generated from source code and is not checked into the repository. Generate it locally using the commands below.

Reusable code snippets are generated separately from validated example sources: Reusable Snippets (Generated)

Rust

Full Rust API docs generated by cargo doc.

cargo doc --open                    # Build and open in browser
cargo doc --no-deps --open          # Skip dependency docs

Output is written to target/doc/. Open target/doc/goud_engine/index.html in a browser.

C# API docs can be generated with DocFX from XML doc comments:

cd sdks/csharp
dotnet build -p:GenerateDocumentationFile=true
# Then run DocFX or similar tooling against the generated XML

Python API docs can be generated with pdoc from docstrings:

pdoc sdks/python/goudengine --output-dir docs/api/python

TypeScript API docs can be generated with TypeDoc from JSDoc comments:

cd sdks/typescript
npx typedoc --out ../../docs/api/typescript src/index.ts