authorgravatar for timonkruiper@gmail.comTimon Kruiper <timonkruiper@gmail.com> 2019-10-09 10:12:08+02:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2019-10-09 13:27:06-04:00
log8a547d9e811ab3d78b88b2a802338a0550b38902
treeb49d40258be87cd8ab71ef3d3b72d612b300b1e7
parent406b70aa56b9a95e768c321dd3caf164add1b49a

Docs: adds docs comments to struct fields

2 files changed, 22 insertions(+), 8 deletions(-)

lib/std/special/docs/index.html+5-3
...@@ -158,7 +158,7 @@...@@ -158,7 +158,7 @@
158 vertical-align: top;158 vertical-align: top;
159 }159 }
160160
161 #sectGlobalVars td, #sectFns td {161 #sectGlobalVars td, #sectFns td, #sectFields td {
162 vertical-align: top;162 vertical-align: top;
163 margin: 0;163 margin: 0;
164 padding: 0.5em;164 padding: 0.5em;
...@@ -313,8 +313,10 @@...@@ -313,8 +313,10 @@
313 </div>313 </div>
314 <div id="sectFields" class="hidden">314 <div id="sectFields" class="hidden">
315 <h2>Fields</h2>315 <h2>Fields</h2>
316 <ul id="listFields">316 <table>
317 </ul>317 <tbody id="listFields">
318 </tbody>
319 </table>
318 </div>320 </div>
319 <div id="sectTypes" class="hidden">321 <div id="sectTypes" class="hidden">
320 <h2>Types</h2>322 <h2>Types</h2>
lib/std/special/docs/main.js+17-5
...@@ -693,14 +693,26 @@...@@ -693,14 +693,26 @@
693 }693 }
694694
695 if (container.fields.length !== 0) {695 if (container.fields.length !== 0) {
696 resizeDomList(domListFields, container.fields.length, '<li></li>');696 resizeDomList(domListFields, container.fields.length,
697 '<tr><td></td><td></td><td></td></tr>');
697 for (var i = 0; i < container.fields.length; i += 1) {698 for (var i = 0; i < container.fields.length; i += 1) {
698 var liDom = domListFields.children[i];
699 var field = container.fields[i];699 var field = container.fields[i];
700 var trDom = domListFields.children[i];
700701
701 var protoHtml = escapeHtml(field.name) + ": ";702 var tdName = trDom.children[0];
702 protoHtml += typeIndexName(field.type, true, true);703 var tdType = trDom.children[1];
703 liDom.innerHTML = protoHtml;704 var tdDesc = trDom.children[2];
705
706 tdName.textContent = field.name;
707
708 tdType.innerHTML = typeIndexName(field.type, true, true);
709
710 var docs = zigAnalysis.astNodes[field.src].docs;
711 if (docs != null) {
712 tdDesc.innerHTML = shortDescMarkdown(docs);
713 } else {
714 tdDesc.textContent = "";
715 }
704 }716 }
705 domSectFields.classList.remove("hidden");717 domSectFields.classList.remove("hidden");
706 }718 }