gitback/zig
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: adds docs comments to struct fields

Browse Source
This commit is contained in:
Timon Kruiper 2019-10-09 10:12:08 +02:00 committed by Andrew Kelley
parent 406b70aa56
commit 8a547d9e81
2 changed files with 22 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
lib/std/special/docs/index.html
View File

@ -158,7 +158,7 @@
vertical-align: top;
}
#sectGlobalVars td, #sectFns td {
#sectGlobalVars td, #sectFns td, #sectFields td {
vertical-align: top;
margin: 0;
padding: 0.5em;
@ -313,8 +313,10 @@
</div>
<div id="sectFields" class="hidden">
<h2>Fields</h2>
<ul id="listFields">
</ul>
<table>
<tbody id="listFields">
</tbody>
</table>
</div>
<div id="sectTypes" class="hidden">
<h2>Types</h2>

22
lib/std/special/docs/main.js
View File

@ -693,14 +693,26 @@
}
if (container.fields.length !== 0) {
resizeDomList(domListFields, container.fields.length, '<li></li>');
resizeDomList(domListFields, container.fields.length,
'<tr><td></td><td></td><td></td></tr>');
for (var i = 0; i < container.fields.length; i += 1) {
var liDom = domListFields.children[i];
var field = container.fields[i];
var trDom = domListFields.children[i];
var protoHtml = escapeHtml(field.name) + ": ";
protoHtml += typeIndexName(field.type, true, true);
liDom.innerHTML = protoHtml;
var tdName = trDom.children[0];
var tdType = trDom.children[1];
var tdDesc = trDom.children[2];
tdName.textContent = field.name;
tdType.innerHTML = typeIndexName(field.type, true, true);
var docs = zigAnalysis.astNodes[field.src].docs;
if (docs != null) {
tdDesc.innerHTML = shortDescMarkdown(docs);
} else {
tdDesc.textContent = "";
}
}
domSectFields.classList.remove("hidden");
}