Commit 99c11cc8cfb285b713284f7af0c7359508e0a660 | zig

author	Loris Cro <kappaloris@gmail.com> 2023-02-20 16:37:41+01:00
committer	GitHub <noreply@github.com> 2023-02-20 16:37:41+01:00
log	99c11cc8cfb285b713284f7af0c7359508e0a660
tree	4d2d2adc6199df97b89b9133ce402dbc9be2e00d
parent	dfd182cc7a831ec75ccc03792afd27b292db194b
parent	14bf20daeb784fb65e7d5789af13694a272a7142
signature	Signed by PGP key 4AEE18F83AFDEB23

Merge pull request #14544 from der-teufel-programming/autodoc-quickfixes

autodoc: main.js cleanup and formatting

2 files changed, 79 insertions(+), 83 deletions(-)

lib
- docs
  - main.js
src
- Autodoc.zig

lib/docs/main.js+78-82

 @@ -106,7 +106,7 @@ const NAV_MODES = {
     // empty array means refers to the package itself
     declNames: [],
     // these will be all types, except the last one may be a type or a decl
     declObjs: [],
     // (a, b, c, d) comptime call; result is the value the docs refer to
     callName: null,
   };
 @@ -200,7 +200,7 @@ const NAV_MODES = {
       case NAV_MODES.GUIDES:
         document.title = "[G] " + curNav.activeGuide + suffix;
         return;
     }
   }
   function isDecl(x) {
 @@ -401,7 +401,7 @@ const NAV_MODES = {
     domGuideSwitch.classList.add("active");
     domApiSwitch.classList.remove("active");
     domDocs.classList.add("hidden");
     domGuides.classList.remove("hidden");
     domApiMenu.classList.add("hidden");
     // sidebar guides list
 @@ -422,7 +422,7 @@ const NAV_MODES = {
     if (list.length > 0) {
       domGuidesMenu.classList.remove("hidden");
     }
     // main content
     const activeGuide = zigAnalysis.guides[curNav.activeGuide];
     if (activeGuide == undefined) {
 @@ -454,7 +454,7 @@ const NAV_MODES = {
           Happy writing!
         `);
     } else {
       domGuides.innerHTML = markdown(activeGuide);
     }
   }
 @@ -467,7 +467,7 @@ const NAV_MODES = {
     domDocs.classList.remove("hidden");
     domApiMenu.classList.remove("hidden");
     domGuidesMenu.classList.add("hidden");
     domStatus.classList.add("hidden");
     domFnProto.classList.add("hidden");
     domSectParams.classList.add("hidden");
 @@ -537,9 +537,9 @@ const NAV_MODES = {
       currentType = childDecl;
       curNav.declObjs.push(currentType);
     }
     window.x = currentType;
     renderNav();
 @@ -586,15 +586,15 @@ const NAV_MODES = {
     switch (curNav.mode) {
       case NAV_MODES.API:
       case NAV_MODES.API_INTERNAL:
-          return renderApi();
+        return renderApi();
       case NAV_MODES.GUIDES:
-          return renderGuides();
+        return renderGuides();
       default:
-          throw "?";
+        throw "?";
     }
   }
   function renderDocTest(decl) {
     if (!decl.decltest) return;
     const astNode = getAstNode(decl.decltest);
 @@ -651,7 +651,7 @@ const NAV_MODES = {
       wantLink: true,
       fnDecl,
     });
     domFnSourceLink.innerHTML = "[<a target=\"_blank\" href=\"" + sourceFileLink(fnDecl) + "\">src</a>]";
     let docsSource = null;
 @@ -895,7 +895,7 @@ const NAV_MODES = {
   function navLink(pkgNames, declNames, callName) {
     let base = curNav.mode;
     if (pkgNames.length === 0 && declNames.length === 0) {
       return base;
     } else if (declNames.length === 0 && callName == null) {
 @@ -919,18 +919,18 @@ const NAV_MODES = {
   function findDeclNavLink(declName) {
     if (curNav.declObjs.length == 0) return null;
-    const curFile = getAstNode(curNav.declObjs[curNav.declObjs.length-1].src).file;
+    const curFile = getAstNode(curNav.declObjs[curNav.declObjs.length - 1].src).file;
-    for (let i = curNav.declObjs.length -1; i >= 0; i--) {
+    for (let i = curNav.declObjs.length - 1; i >= 0; i--) {
       const curDecl = curNav.declObjs[i];
-      const curDeclName = curNav.declNames[i-1];
+      const curDeclName = curNav.declNames[i - 1];
       if (curDeclName == declName) {
-        const declPath = curNav.declNames.slice(0,i);
+        const declPath = curNav.declNames.slice(0, i);
         return navLink(curNav.pkgNames, declPath);
       }
       if (findSubDecl(curDecl, declName) != null) {
-        const declPath = curNav.declNames.slice(0,i).concat([declName]);
+        const declPath = curNav.declNames.slice(0, i).concat([declName]);
         return navLink(curNav.pkgNames, declPath);
       }
     }
 @@ -1366,10 +1366,6 @@ const NAV_MODES = {
             payloadHtml += "truncate";
             break;
           }
-          case "align_cast": {
-            payloadHtml += "alignCast";
-            break;
-          }
           case "has_decl": {
             payloadHtml += "hasDecl";
             break;
 @@ -1700,15 +1696,15 @@ const NAV_MODES = {
       }
       case "declRef": {
         const name = getDecl(expr.declRef).name;
         if (opts.wantHtml) {
           let payloadHtml = "";
           if (opts.wantLink) {
-            payloadHtml += '<a href="'+ findDeclNavLink(name) +'">';
+            payloadHtml += '<a href="' + findDeclNavLink(name) + '">';
           }
           payloadHtml +=
             '<span class="tok-kw" style="color:lightblue;">' +
-              name +
+            name +
             "</span>";
           if (opts.wantLink) payloadHtml += "</a>";
           return payloadHtml;
 @@ -1728,12 +1724,12 @@ const NAV_MODES = {
           if ("string" in expr.refPath[i]) {
             component = expr.refPath[i].string;
           } else {
-            component = exprName(expr.refPath[i], {...opts, wantLink: false});
+            component = exprName(expr.refPath[i], { ...opts, wantLink: false });
             if (opts.wantLink && "declRef" in expr.refPath[i]) {
               url += "." + getDecl(expr.refPath[i].declRef).name;
-              component = '<a href="'+ url +'">' +
+              component = '<a href="' + url + '">' +
                 component +
-              "</a>";
+                "</a>";
             }
           }
           name += "." + component;
 @@ -1792,12 +1788,12 @@ const NAV_MODES = {
                 name = "struct { ";
               }
             }
-            if (structObj.fields.length > 1 && opts.wantHtml) {name += "</br>";}
+            if (structObj.fields.length > 1 && opts.wantHtml) { name += "</br>"; }
             let indent = "";
             if (structObj.fields.length > 1 && opts.wantHtml) {
               indent = "&nbsp;&nbsp;&nbsp;&nbsp;"
             }
-            if (opts.indent) {
+            if (opts.indent && structObj.fields.length > 1) {
               indent = opts.indent + indent;
             }
             let structNode = getAstNode(structObj.src);
 @@ -1808,7 +1804,7 @@ const NAV_MODES = {
               field_end += " ";
             }
-            for(let i = 0; i < structObj.fields.length; i += 1) {
+            for (let i = 0; i < structObj.fields.length; i += 1) {
               let fieldNode = getAstNode(structNode.fields[i]);
               let fieldName = fieldNode.name;
               let html = indent;
 @@ -1817,17 +1813,17 @@ const NAV_MODES = {
               }
               let fieldTypeExpr = structObj.fields[i];
-              if(!structObj.is_tuple) {
+              if (!structObj.is_tuple) {
                 html += ": ";
               }
-              html += exprName(fieldTypeExpr, {...opts, indent: indent});
+              html += exprName(fieldTypeExpr, { ...opts, indent: indent });
               html += field_end;
               name += html;
             }
-            if (opts.indent) {
+            if (opts.indent && structObj.fields.length > 1) {
               name += opts.indent;
             }
             name += "}";
 @@ -1850,7 +1846,7 @@ const NAV_MODES = {
             if (enumObj.nonexhaustive) {
               fields_len += 1;
             }
-            if (fields_len > 1 && opts.wantHtml) {name += "</br>";}
+            if (fields_len > 1 && opts.wantHtml) { name += "</br>"; }
             let indent = "";
             if (fields_len > 1) {
               if (opts.wantHtml) {
 @@ -1868,10 +1864,10 @@ const NAV_MODES = {
             } else {
               field_end += " ";
             }
-            for(let i = 0; i < enumNode.fields.length; i += 1) {
+            for (let i = 0; i < enumNode.fields.length; i += 1) {
               let fieldNode = getAstNode(enumNode.fields[i]);
               let fieldName = fieldNode.name;
-              let html =  indent + escapeHtml(fieldName);
+              let html = indent + escapeHtml(fieldName);
               html += field_end;
 @@ -1895,16 +1891,16 @@ const NAV_MODES = {
               name = "union";
             }
             if (unionObj.auto_tag) {
-                if (opts.wantHtml) {
+              if (opts.wantHtml) {
-                  name += " (<span class='tok-kw'>enum</span>";
+                name += " (<span class='tok-kw'>enum</span>";
-                } else {
+              } else {
-                  name += " (enum";
+                name += " (enum";
-                }
+              }
-                if (unionObj.tag) {
+              if (unionObj.tag) {
-                    name += "(" + exprName(unionObj.tag, opts) + "))";
+                name += "(" + exprName(unionObj.tag, opts) + "))";
-                } else {
+              } else {
-                  name += ")";
+                name += ")";
-                }
+              }
             } else if (unionObj.tag) {
               name += " (" + exprName(unionObj.tag, opts) + ")";
             }
 @@ -1926,7 +1922,7 @@ const NAV_MODES = {
             } else {
               field_end += " ";
             }
-            for(let i = 0; i < unionObj.fields.length; i += 1) {
+            for (let i = 0; i < unionObj.fields.length; i += 1) {
               let fieldNode = getAstNode(unionNode.fields[i]);
               let fieldName = fieldNode.name;
               let html = indent + escapeHtml(fieldName);
 @@ -1934,7 +1930,7 @@ const NAV_MODES = {
               let fieldTypeExpr = unionObj.fields[i];
               html += ": ";
-              html += exprName(fieldTypeExpr, {...opts, indent: indent});
+              html += exprName(fieldTypeExpr, { ...opts, indent: indent });
               html += field_end;
 @@ -2163,7 +2159,7 @@ const NAV_MODES = {
             opts.fnDecl = null;
             opts.linkFnNameDecl = null;
             let payloadHtml = "";
-            if (opts.addParensIfFnSignature && fnObj.src == 0){
+            if (opts.addParensIfFnSignature && fnObj.src == 0) {
               payloadHtml += "(";
             }
             if (opts.wantHtml) {
 @@ -2179,7 +2175,7 @@ const NAV_MODES = {
                 if (linkFnNameDecl) {
                   payloadHtml +=
                     '<a href="' + linkFnNameDecl + '">' +
-                      escapeHtml(fnDecl.name) +
+                    escapeHtml(fnDecl.name) +
                     "</a>";
                 } else {
                   payloadHtml += escapeHtml(fnDecl.name);
 @@ -2198,7 +2194,7 @@ const NAV_MODES = {
                 fields = fnNode.fields;
                 isVarArgs = fnNode.varArgs;
               }
               for (let i = 0; i < fnObj.params.length; i += 1) {
                 if (i != 0) {
                   payloadHtml += ", ";
 @@ -2251,13 +2247,13 @@ const NAV_MODES = {
                 } else if ("typeOf" in value) {
                   payloadHtml += exprName(value, opts);
                 } else if ("typeOf_peer" in value) {
-                    payloadHtml += exprName(value, opts);
+                  payloadHtml += exprName(value, opts);
                 } else if ("declRef" in value) {
-                    payloadHtml += exprName(value, opts);
+                  payloadHtml += exprName(value, opts);
                 } else if ("call" in value) {
-                    payloadHtml += exprName(value, opts);
+                  payloadHtml += exprName(value, opts);
                 } else if ("refPath" in value) {
-                    payloadHtml += exprName(value, opts);
+                  payloadHtml += exprName(value, opts);
                 } else if ("type" in value) {
                   payloadHtml += exprName(value, opts);
                   //payloadHtml += '<span class="tok-kw">' + name + "</span>";
 @@ -2301,7 +2297,7 @@ const NAV_MODES = {
             }
             if (fnObj.ret != null) {
               payloadHtml += exprName(fnObj.ret, {
                 ...opts,
                 addParensIfFnSignature: true,
               });
             } else if (opts.wantHtml) {
 @@ -2310,7 +2306,7 @@ const NAV_MODES = {
               payloadHtml += "anytype";
             }
-            if (opts.addParensIfFnSignature && fnObj.src == 0){
+            if (opts.addParensIfFnSignature && fnObj.src == 0) {
               payloadHtml += ")";
             }
             return payloadHtml;
 @@ -2353,7 +2349,7 @@ const NAV_MODES = {
     ) {
       name = "std";
     } else {
-      name = exprName({ type: typeObj }, {wantHtml: false, wantLink: false});
+      name = exprName({ type: typeObj }, { wantHtml: false, wantLink: false });
     }
     if (name != null && name != "") {
       domHdrName.innerText =
 @@ -2644,10 +2640,10 @@ const NAV_MODES = {
   }
   function sourceFileLink(decl) {
-      const srcNode = getAstNode(decl.src);
+    const srcNode = getAstNode(decl.src);
-      return sourceFileUrlTemplate.
+    return sourceFileUrlTemplate.
-          replace("{{file}}", zigAnalysis.files[srcNode.file]).
+      replace("{{file}}", zigAnalysis.files[srcNode.file]).
-          replace("{{line}}", srcNode.line + 1);
+      replace("{{line}}", srcNode.line + 1);
   }
   function renderContainer(container) {
 @@ -2783,8 +2779,8 @@ const NAV_MODES = {
           if (short != docs) {
             short = markdown(short);
             var long = markdown(docs);
             tdDesc.innerHTML =
-            "<div class=\"expand\" ><span class=\"button\" onclick=\"toggleExpand(event)\"></span><div class=\"sum-less\">" + short + "</div>" + "<div class=\"sum-more\">" + long + "</div></details>";
+              "<div class=\"expand\" ><span class=\"button\" onclick=\"toggleExpand(event)\"></span><div class=\"sum-less\">" + short + "</div>" + "<div class=\"sum-more\">" + long + "</div></details>";
           }
           else {
             tdDesc.innerHTML = markdown(short);
 @@ -2818,10 +2814,10 @@ const NAV_MODES = {
           html += ' = <span class="tok-number">' + fieldName + "</span>";
         } else {
           let fieldTypeExpr = container.fields[i];
-          if(container.kind ==! typeKinds.Struct || !container.is_tuple) {
+          if (container.kind !== typeKinds.Struct || !container.is_tuple) {
             html += ": ";
           }
-          html += exprName(fieldTypeExpr, {wantHtml:true, wantLink:true});
+          html += exprName(fieldTypeExpr, { wantHtml: true, wantLink: true });
           let tsn = typeShorthandName(fieldTypeExpr);
           if (tsn) {
             html += "<span> (" + tsn + ")</span>";
 @@ -3007,8 +3003,8 @@ const NAV_MODES = {
     throw new Error("No type 'type' found");
   }
   function updateCurNav() {
     curNav = {
       mode: NAV_MODES.API,
       pkgNames: [],
 @@ -3021,7 +3017,7 @@ const NAV_MODES = {
     const mode = location.hash.substring(0, 3);
     let query = location.hash.substring(3);
     const DEFAULT_HASH = NAV_MODES.API + zigAnalysis.packages[zigAnalysis.rootPkg].name;
     switch (mode) {
       case NAV_MODES.API:
 @@ -3037,7 +3033,7 @@ const NAV_MODES = {
           nonSearchPart = query.substring(0, qpos);
           curNavSearch = decodeURIComponent(query.substring(qpos + 1));
         }
         let parts = nonSearchPart.split(":");
         if (parts[0] == "") {
           location.hash = DEFAULT_HASH;
 @@ -3059,14 +3055,14 @@ const NAV_MODES = {
         curNav.mode = mode;
         curNav.activeGuide = query;
         return;
       default:
         location.hash = DEFAULT_HASH;
         return;
     }
- }
+  }
   function onHashChange() {
     updateCurNav();
     if (domSearch.value !== curNavSearch) {
 @@ -3103,7 +3099,7 @@ const NAV_MODES = {
               if (!callee.generic_ret) return null;
               resolvedGenericRet = resolveValue({ expr: callee.generic_ret });
             }
             if ("type" in resolvedGenericRet.expr) {
               parentType = getType(resolvedGenericRet.expr.type);
             }
 @@ -3248,7 +3244,7 @@ const NAV_MODES = {
     });
   }
-  function shortDesc(docs){
+  function shortDesc(docs) {
     const trimmed_docs = docs.trim();
     let index = trimmed_docs.indexOf("\n\n");
     let cut = false;

src/Autodoc.zig+1-1

...	@@ -3629,7 +3629,7 @@ fn tryResolveRefPath(	...	@@ -3629,7 +3629,7 @@ fn tryResolveRefPath(
3629	}	3629	}
3630		3630
3631	if (self.pending_ref_paths.get(&path[path.len - 1])) \|waiter_list\| {	3631	if (self.pending_ref_paths.get(&path[path.len - 1])) \|waiter_list\| {
3632	// It's important to de-register oureslves as pending before	3632	// It's important to de-register ourselves as pending before
3633	// attempting to resolve any other decl.	3633	// attempting to resolve any other decl.
3634	_ = self.pending_ref_paths.remove(&path[path.len - 1]);	3634	_ = self.pending_ref_paths.remove(&path[path.len - 1]);
3635		3635