Skip to content

Commit f42f0c5

Browse files
committed
Add top level docs for structs, enums and unions
Issue ziglang#3408
1 parent a6c9c5f commit f42f0c5

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

lib/std/special/docs/main.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,11 +144,14 @@
144144

145145
var decl = zigAnalysis.types[pkg.main];
146146
curNav.declObjs = [decl];
147+
curNav.childDeclObjs = [decl];
148+
var lastParentDecl = null;
147149
for (var i = 0; i < curNav.declNames.length; i += 1) {
148150
var childDecl = findSubDecl(decl, curNav.declNames[i]);
149151
if (childDecl == null) {
150152
return render404();
151153
}
154+
lastParentDecl = childDecl;
152155
var container = getDeclContainerType(childDecl);
153156
if (container == null) {
154157
if (i + 1 === curNav.declNames.length) {
@@ -181,6 +184,7 @@
181184
}
182185
} else {
183186
renderType(lastDecl);
187+
renderTopLevelDecl(lastParentDecl);
184188
}
185189
}
186190

@@ -741,6 +745,14 @@
741745
}
742746
}
743747

748+
function renderTopLevelDecl(decl) {
749+
var node = zigAnalysis.astNodes[decl.src];
750+
if (node.docs != null) {
751+
domTldDocs.innerHTML = markdown(node.docs);
752+
domTldDocs.classList.remove("hidden");
753+
}
754+
}
755+
744756
function renderType(typeObj) {
745757
var name;
746758
if (rootIsStd && typeObj === zigAnalysis.types[zigAnalysis.packages[zigAnalysis.rootPkg].main]) {

0 commit comments

Comments
 (0)