authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2019-10-10 11:03:16-04:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2019-10-10 11:03:16-04:00
log6330dfbea6d5434dc694aebd0203ea13e2511a0e
treea22bc9534dbbcd0b6632003b40d42684422bef6d
parentb9d63551de3518001c992ec799a67c2e726d4f5b
signaturelock-open Commit is signed but in an unrecognized format.

generated docs: better listing of functions

1 files changed, 19 insertions(+), 18 deletions(-)

lib/std/special/docs/main.js+19-18
......@@ -376,24 +376,24 @@
376376 }
377377 }
378378
379 function typeIndexName(typeIndex, wantHtml, wantLink, fnDecl, skipFnName) {
379 function typeIndexName(typeIndex, wantHtml, wantLink, fnDecl, linkFnNameDecl) {
380380 var typeObj = zigAnalysis.types[typeIndex];
381381 if (wantLink) {
382382 var declIndex = getCanonTypeDecl(typeIndex);
383383 var declPath = getCanonDeclPath(declIndex);
384384 var haveLink = declPath != null;
385 var typeNameHtml = typeName(typeObj, true, !haveLink, fnDecl, skipFnName);
385 var typeNameHtml = typeName(typeObj, true, !haveLink, fnDecl, linkFnNameDecl);
386386 if (haveLink) {
387387 return '<a href="' + navLink(declPath.pkgNames, declPath.declNames) + '">' + typeNameHtml + '</a>';
388388 } else {
389389 return typeNameHtml;
390390 }
391391 } else {
392 return typeName(typeObj, wantHtml, false, fnDecl, skipFnName);
392 return typeName(typeObj, wantHtml, false, fnDecl, linkFnNameDecl);
393393 }
394394 }
395395
396 function typeName(typeObj, wantHtml, wantSubLink, fnDecl, skipFnName) {
396 function typeName(typeObj, wantHtml, wantSubLink, fnDecl, linkFnNameDecl) {
397397 switch (typeObj.kind) {
398398 case typeKinds.Array:
399399 var name = "[";
......@@ -542,8 +542,15 @@
542542 var payloadHtml = "";
543543 if (wantHtml) {
544544 payloadHtml += '<span class="tok-kw">fn</span>';
545 if (fnDecl != null && !skipFnName) {
546 payloadHtml += ' <span class="tok-fn">' + escapeHtml(fnDecl.name) + '</span>';
545 if (fnDecl != null) {
546 payloadHtml += ' <span class="tok-fn">';
547 if (linkFnNameDecl != null) {
548 payloadHtml += '<a href="' + linkFnNameDecl + '">' +
549 escapeHtml(fnDecl.name) + '</a>';
550 } else {
551 payloadHtml += escapeHtml(fnDecl.name);
552 }
553 payloadHtml += '</span>';
547554 }
548555 } else {
549556 payloadHtml += 'fn'
......@@ -655,7 +662,7 @@
655662 }
656663
657664 function renderValue(decl) {
658 domFnProtoCode.innerHTML = '<span class="tok-kw">pub</span> <span class="tok-kw">const</span> ' +
665 domFnProtoCode.innerHTML = '<span class="tok-kw">const</span> ' +
659666 escapeHtml(decl.name) + ': ' + typeIndexName(decl.type, true, true);
660667
661668 var docs = zigAnalysis.astNodes[decl.src].docs;
......@@ -668,7 +675,7 @@
668675 }
669676
670677 function renderVar(decl) {
671 domFnProtoCode.innerHTML = '<span class="tok-kw">pub</span> <span class="tok-kw">var</span> ' +
678 domFnProtoCode.innerHTML = '<span class="tok-kw">var</span> ' +
672679 escapeHtml(decl.name) + ': ' + typeIndexName(decl.type, true, true);
673680
674681 var docs = zigAnalysis.astNodes[decl.src].docs;
......@@ -758,21 +765,15 @@
758765 }
759766
760767 if (fnsList.length !== 0) {
761 resizeDomList(domListFns, fnsList.length,
762 '<tr><td><a href="#"></a></td><td></td><td></td></tr>');
768 resizeDomList(domListFns, fnsList.length, '<tr><td></td><td></td></tr>');
763769 for (var i = 0; i < fnsList.length; i += 1) {
764770 var decl = fnsList[i];
765771 var trDom = domListFns.children[i];
766772
767 var tdName = trDom.children[0];
768 var tdNameA = tdName.children[0];
769 var tdType = trDom.children[1];
770 var tdDesc = trDom.children[2];
771
772 tdNameA.setAttribute('href', navLinkDecl(decl.name));
773 tdNameA.textContent = decl.name;
773 var tdFnCode = trDom.children[0];
774 var tdDesc = trDom.children[1];
774775
775 tdType.innerHTML = typeIndexName(decl.type, true, true, decl, true);
776 tdFnCode.innerHTML = typeIndexName(decl.type, true, true, decl, navLinkDecl(decl.name));
776777
777778 var docs = zigAnalysis.astNodes[decl.src].docs;
778779 if (docs != null) {