feat: include function, param, and return descriptions in impl.cpp

dylibso · Sep 19, 2024 · 6cb8191 · 6cb8191
1 parent 8abab62
commit 6cb8191
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/template/impl.cpp.ejs b/template/impl.cpp.ejs
@@ -1,6 +1,18 @@
 #include "pdk.gen.hpp"
 
 <% for (const func of schema.exports) { %>
+/**
+ * <%- formatCommentBlock(func.description) %>
+<% if (func.input || func.output) { -%>
+ *
+<% } -%>
+<% if (func.input) { -%>
+ * @param input <%- formatCommentBlock(func.input.description) %>
+<% } -%>
+<% if (func.output) { -%>
+ * @return <%- formatCommentBlock(func.output.description) %>
+<% } -%>
+*/
 <%- getExportReturnType(func) -%> impl::<%- func.name-%>(<%- getExportParamType(func) -%> <%- getParamName(func) -%>) {
     <% if (featureFlags['stub-with-code-samples'] && codeSamples(func, 'c++').length > 0) { -%>
       <%- codeSamples(func, 'c++')[0].source %>