tlang
/
tpkg
mirror of https://github.com/tbklang/tpkg
1
0
Fork 0
Code Issues 2 Packages Projects 1 Releases Wiki Activity

Doc gen 

- Handle cases where no `Comment` is available on the current `Function` (i.e. it is `null` when `getComment()` is called on it)
This commit is contained in:
Tristan B. Velloza Kildaire 2024-04-17 12:25:47 +02:00
parent bdc2a8fe4b
commit 1953fe3d6f
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
source/tpkg/lib/docgen.d
View File

@ -14,9 +14,9 @@ private struct ParamTable
private ParamDoc[string] pDocs;
this(Comment funcComment)
this(ParamDoc[string] pDocs)
{
this.pDocs = funcComment.getAllParamDocs();
this.pDocs = pDocs;
}
private static paramToRow(VariableParameter param, string comment)
@ -273,7 +273,7 @@ public class DocumentGenerator
Comment comment = func.getComment();
string commentStr = comment is null ? "<i>No description</i>" : textBlockGray(comment.getContent());
ParamTable table = ParamTable(comment);
ParamTable table = ParamTable(comment !is null ? comment.getAllParamDocs() : null);
VariableParameter[] params = func.getParams();
string paramText;
@ -297,8 +297,8 @@ public class DocumentGenerator
string returnDocStr;
ReturnsDoc retDoc;
// If there was a @return
if(comment.getReturnDoc(retDoc))
// If there is a comment AND if there was a @return
if(comment !is null && comment.getReturnDoc(retDoc))
{
returnDocStr = retDoc.getDescription();
}