2.0 KiB
2.0 KiB
| id | ticket | title | status | created | ref_decisions | tags | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PLN-0100 | pbs-symbol-documentation-and-hover-markdown | Author Doc metadata for stdlib SDK and interface declarations | open | 2026-07-15 |
|
|
Briefing
Apply the new documentation model to repository-owned PBS stdlib, SDK, and interface declarations.
Objective
Author English [Doc(markdown = """...""")] documentation for stdlib/API surfaces so editor assistance has useful content.
Dependencies
- Depends on
PLN-0092. - Should run after
PLN-0096so authored docs are validated by compiler tests. - Benefits from
PLN-0099for hover verification but does not require it to author source docs.
Scope
- Add English Markdown documentation to stdlib, SDK, and interface declarations.
- Document parameters inside the owning declaration Markdown.
- Keep documentation concise and API-focused.
Non-Goals
- Add
[Doc]to parameters. - Generate external documentation sites.
- Change stdlib semantics or host binding behavior.
Execution Method
- Inventory stdlib and SDK PBS files under
prometeu-compiler/frontends/prometeu-frontend-pbs/src/main/resources/game/stdlib. - Add
[Doc(markdown = """...""")]to public named API declarations that users see in completion/hover. - Document parameter meaning inside callable Markdown when needed.
- Ensure host/interface declarations use the same
Docshape. - Run stdlib compile and interface conformance tests.
Acceptance Criteria
- Public stdlib/SDK declarations that are user-facing have concise English documentation.
- No parameters receive
[Doc]. - Existing stdlib behavior and host ABI bindings are unchanged.
Tests
PbsGateUStdlibCompileTestPbsGateUSdkInterfaceConformanceTest- Relevant PBS frontend tests.
Affected Artifacts
prometeu-compiler/frontends/prometeu-frontend-pbs/src/main/resources/game/stdlib/1/**- Stdlib/interface compile tests