Commit Graph

6 Commits

Author SHA1 Message Date
Diego F. Goberna
42b1819f92 fix: add missing WrenVM* parameter to error callback signature in configuring-vm docs
The error callback function signature in the documentation for configuring the Wren VM was missing the required first parameter `WrenVM* vm`, which would cause compilation errors for users following the example. This commit adds the missing parameter to the C code example in the embedding documentation.
2017-11-14 15:56:16 +00:00
Bob Nystrom
4018d42c39 docs: remove placeholder application-lifecycle page and complete first draft of embedding docs
- Delete the empty "Application Lifecycle" page (was just a TODO placeholder)
- Expand "Storing C Data" from stub to full documentation covering foreign classes, initialization, access, and finalization
- Add note that VM is not re-entrant; warn against calling wrenCall/wrenInterpret from foreign methods
- Fix broken cross-reference links (configuring-the-vm.html, wren.hpp include)
- Clarify slot API usage: remove confusing sentence about implicit return of receiver
- Fix grammar: "each VM them differently" → "each VM differently", "is only be called" → "is only called"
- Improve phrasing throughout for clarity and consistency
2017-10-17 15:26:06 +00:00
Nathan Hourt
29b512c812 fix: correct grammar in module loader documentation sentence 2017-04-04 20:23:16 +00:00
Bob Nystrom
4f9034fc8e docs: proofread configuring-the-vm guide for clarity and consistency
Reworded opening paragraph to improve flow and remove redundant phrasing.
Updated description of wrenInitConfiguration to emphasize prevention of uninitialized configuration.
Changed "the VM" to "Wren" in loadModuleFn description for consistent terminology.
2017-02-12 22:58:16 +00:00
Bob Nystrom
ecf3b7081b docs: replace placeholder TODO with full VM configuration documentation and fix typo in wren.h
Replace the stub "TODO: Write these docs." in configuring-the-vm.markdown with comprehensive documentation covering all WrenConfiguration fields including binding callbacks, memory management, and error handling. Also fix the typo "phyisically" to "physically" in the wren.h header comment and remove trailing whitespace on several lines.
2017-02-12 19:04:38 +00:00
Bob Nystrom
2bb999127a docs: restructure embedding API docs into multi-page section with slots, lifecycle, and C interop guides 2016-05-16 15:09:14 +00:00