From e0ab685467567f6da02be865654a2c4dc5f8c3a9 Mon Sep 17 00:00:00 2001
From: Andrew Kelley <andrew@ziglang.org>
Date: Wed, 9 Oct 2019 16:21:34 -0400
Subject: [PATCH] generated docs: more verbose fields

also prevent docs making hyperlinks for integer types
---
 lib/std/special/docs/index.html |  6 ++---
 lib/std/special/docs/main.js    | 44 ++++++++++++++++++++++-----------
 src/dump_analysis.cpp           |  2 +-
 3 files changed, 32 insertions(+), 20 deletions(-)

diff --git a/lib/std/special/docs/index.html b/lib/std/special/docs/index.html
index 068ad069d8..e7a57137e5 100644
--- a/lib/std/special/docs/index.html
+++ b/lib/std/special/docs/index.html
@@ -311,10 +311,8 @@
     </div>
     <div id="sectFields" class="hidden">
       <h2>Fields</h2>
-      <table>
-        <tbody id="listFields">
-        </tbody>
-      </table>
+      <div id="listFields">
+      </div>
     </div>
     <div id="sectTypes" class="hidden">
       <h2>Types</h2>
diff --git a/lib/std/special/docs/main.js b/lib/std/special/docs/main.js
index f45aad3e3d..84d44f7b5b 100644
--- a/lib/std/special/docs/main.js
+++ b/lib/std/special/docs/main.js
@@ -50,6 +50,8 @@
     var typeKindErrSetId;
     var typeKindErrUnionId;
     var typeKindStructId;
+    var typeKindUnionId;
+    var typeKindEnumId;
     findTypeKinds();
 
     // for each package, is an array with packages to get to this one
@@ -748,27 +750,20 @@
             domSectFns.classList.remove("hidden");
         }
 
-        if (container.fields.length !== 0) {
-            resizeDomList(domListFields, container.fields.length,
-                '<tr><td></td><td></td><td></td></tr>');
+        if (container.fields != null && container.fields.length !== 0) {
+            resizeDomList(domListFields, container.fields.length, '<div></div>');
             for (var i = 0; i < container.fields.length; i += 1) {
                 var field = container.fields[i];
-                var trDom = domListFields.children[i];
+                var divDom = domListFields.children[i];
 
-                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 html = '<pre>' + escapeHtml(field.name) + ": " +
+                    typeIndexName(field.type, true, true) + ',</pre>';
 
                 var docs = zigAnalysis.astNodes[field.src].docs;
                 if (docs != null) {
-                    tdDesc.innerHTML = shortDescMarkdown(docs);
-                } else {
-                    tdDesc.textContent = "";
+                    html += markdown(docs);
                 }
+                divDom.innerHTML = html;
             }
             domSectFields.classList.remove("hidden");
         }
@@ -846,6 +841,10 @@
                 typeKindErrUnionId = i;
             } else if (zigAnalysis.typeKinds[i] === "Struct") {
                 typeKindStructId = i;
+            } else if (zigAnalysis.typeKinds[i] === "Union") {
+                typeKindUnionId = i;
+            } else if (zigAnalysis.typeKinds[i] === "Enum") {
+                typeKindEnumId = i;
             }
         }
         if (typeKindTypeId == null) {
@@ -881,6 +880,12 @@
         if (typeKindStructId == null) {
             throw new Error("No type kind 'Struct' found");
         }
+        if (typeKindUnionId == null) {
+            throw new Error("No type kind 'Union' found");
+        }
+        if (typeKindEnumId == null) {
+            throw new Error("No type kind 'Enum' found");
+        }
     }
 
     function findTypeTypeId() {
@@ -970,6 +975,13 @@
         return list;
     }
 
+    function declCanRepresentTypeKind(typeKind) {
+        return typeKind === typeKindErrSetId ||
+            typeKind === typeKindStructId ||
+            typeKind === typeKindUnionId ||
+            typeKind === typeKindEnumId;
+    }
+
     function computeCanonDeclPaths() {
         var list = new Array(zigAnalysis.decls.length);
         canonTypeDecls = new Array(zigAnalysis.types.length);
@@ -991,7 +1003,9 @@
                         if (list[mainDeclIndex] != null) continue;
 
                         var decl = zigAnalysis.decls[mainDeclIndex];
-                        if (decl.type === typeTypeId) {
+                        if (decl.type === typeTypeId &&
+                            declCanRepresentTypeKind(zigAnalysis.types[decl.value].kind))
+                        {
                             canonTypeDecls[decl.value] = mainDeclIndex;
                         }
                         var declNames = item.declNames.concat([decl.name]);
diff --git a/src/dump_analysis.cpp b/src/dump_analysis.cpp
index 168d86a21f..c124e6d86b 100644
--- a/src/dump_analysis.cpp
+++ b/src/dump_analysis.cpp
@@ -811,7 +811,7 @@ static void anal_dump_type(AnalDumpCtx *ctx, ZigType *ty) {
                 jw_end_array(jw);
             }
 
-            {
+            if (ty->data.structure.src_field_count != 0) {
                 jw_object_field(jw, "fields");
                 jw_begin_array(jw);