generated docs: show doc comments on functions

2 files changed, 21 insertions, 4 deletions

diff --git a/lib/std/special/docs/index.html b/lib/std/special/docs/index.html
index db80ec9550..d159637249 100644
--- a/lib/std/special/docs/index.html
+++ b/lib/std/special/docs/index.html
@@ -7,6 +7,7 @@
     <style type="text/css">
         body {
             font-family: system-ui, -apple-system, Roboto, "Segoe UI", sans-serif;
+            max-width: 60em;
         }
         .hidden {
             display: none;
@@ -64,6 +65,7 @@
     <div id="fnProto" class="hidden">
       <pre id="fnProtoCode"></pre>
     </div>
+    <div id="fnDocs" class="hidden"></div>
     <div id="sectPkgs" class="hidden">
         <h2>Packages</h2>
         <ul id="listPkgs">
diff --git a/lib/std/special/docs/main.js b/lib/std/special/docs/main.js
index 50002f6841..4dca1e8452 100644
--- a/lib/std/special/docs/main.js
+++ b/lib/std/special/docs/main.js
@@ -10,6 +10,7 @@
     var domListFns = document.getElementById("listFns");
     var domFnProto = document.getElementById("fnProto");
     var domFnProtoCode = document.getElementById("fnProtoCode");
+    var domFnDocs = document.getElementById("fnDocs");
 
     var typeKindTypeId;
     var typeKindFnId;
@@ -53,6 +54,11 @@
     function render() {
         domStatus.classList.add("hidden");
         domFnProto.classList.add("hidden");
+        domFnDocs.classList.add("hidden");
+        domSectPkgs.classList.add("hidden");
+        domSectTypes.classList.add("hidden");
+        domSectFns.classList.add("hidden");
+
 
         renderTitle();
 
@@ -107,13 +113,15 @@
     }
 
     function renderFn(fnDecl) {
-        domSectPkgs.classList.add("hidden");
-        domSectTypes.classList.add("hidden");
-        domSectFns.classList.add("hidden");
-
         var typeObj = zigAnalysis.types[fnDecl.type];
         domFnProtoCode.textContent = "fn " + fnDecl.name + typeObj.name.substring(2);
 
+        var srcNode = zigAnalysis.astNodes[fnDecl.src];
+        if (srcNode.docs != null) {
+            domFnDocs.innerHTML = markdown(srcNode.docs);
+            domFnDocs.classList.remove("hidden");
+        }
+
         domFnProto.classList.remove("hidden");
     }
 
@@ -379,4 +387,11 @@
         }
         return list;
     }
+
+    var escapeHtmlReplacements = { "&": "&amp;", '"': "&quot;", "<": "&lt;", ">": "&gt;" };
+    function markdown(mdText) {
+        return mdText.replace(/[&"<>]/g, function (m) {
+            return escapeHtmlReplacements[m];
+        });
+    }
 })();