Update slice2js to generate "The Slice compiler generated ..." #4706
Conversation
bernardnormier
requested review from
InsertCreativityHere,
Copilot,
externl and
pepone
There was a problem hiding this comment.
Pull request overview
This PR updates the slice2js compiler to generate documentation comments with "The Slice compiler generated this..." messages, addressing issue #4546. The changes refactor the documentation generation system to use a more flexible options-based approach and add generated type information to TypeScript output.
Key Changes:
- Introduced
DocSummaryOptionsstruct to provide flexible control over documentation generation (deprecation tags, remarks, and generated type messages) - Renamed
writeDocCommentFortowriteDocSummaryto better reflect its purpose - Updated TypeScript code generation to include "The Slice compiler generated this..." messages for classes, exceptions, structs, enums, and constants
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| cpp/src/slice2js/Gen.h | Adds DocSummaryOptions struct and updates writeDocSummary function signature for configurable documentation generation |
| cpp/src/slice2js/Gen.cpp | Implements documentation generation with generated type messages, refactors writeRemarks to accept StringList, and updates all call sites to use new writeDocSummary API |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| std::string writeConstantValue(const TypePtr&, const SyntaxTreeBasePtr&, const std::string&); | ||
|
|
||
| /// Generates and outputs a doc-comment for Slice definition @p p. |
There was a problem hiding this comment.
The documentation comment says "Generates and outputs a doc-comment" but the function is now named writeDocSummary. The comment should say "doc-summary" to match the function name and be consistent with the parameter name DocSummaryOptions.
| /// Generates and outputs a doc-comment for Slice definition @p p. | |
| /// Generates and outputs a doc-summary for Slice definition @p p. |
|
|
||
| namespace Slice | ||
| { | ||
| struct DocSummaryOptions |
There was a problem hiding this comment.
Use more readable options like in slice2cpp.
|
|
||
| void | ||
| Slice::JsVisitor::writeDocCommentFor(const ContainedPtr& p, bool includeRemarks, bool includeDeprecated) | ||
| Slice::JsVisitor::writeDocSummary(const ContainedPtr& p, const DocSummaryOptions& options) |
pepone
left a comment
pepone
left a comment
There was a problem hiding this comment.
Looks good, much nicer with the new options.
3 participants
The JS fix for #4546.