Commit Graph

7 Commits

Author SHA1 Message Date
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
Bob Nystrom
8e926f12d8 docs: document libm linking requirement for Wren on BSD/Linux platforms 2017-03-02 15:17:03 +00:00
Bob Nystrom
63f46adf06 docs: revise embedding docs with foreign methods and tighten existing pages 2017-02-12 18:14:37 +00:00
Bob Nystrom
2294046b74 docs: improve clarity and flow in embedding documentation
Refine phrasing in the embedding guide for better readability: change "generate a runtime error" to "generate runtime errors", reword "What that gives you in return" to "What you get in return", and replace "get to the public header" with "find the public header" for more natural expression.
2017-01-12 15:11:01 +00:00
Bob Nystrom
879eac5d82 docs: reword embedding docs for clarity and consistency across slot, handle, and C-calling-Wren pages 2016-08-26 14:11:50 +00:00
Bob Nystrom
caee692c32 docs: rename WrenValue to WrenHandle across embedding docs and C API
Rename the `WrenValue` type to `WrenHandle` in the public C header, update all
function signatures (`wrenMakeCallHandle`, `wrenCall`, `wrenReleaseHandle`),
and rename the documentation page from "Slots and Values" to "Slots and Handles"
with corresponding link updates throughout the embedding guide and module source
files.
2016-05-21 03:55:28 +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