diff options
| author | Andrew Kelley <andrew@ziglang.org> | 2019-10-10 10:34:44 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-10 10:34:44 -0400 |
| commit | b9d63551de3518001c992ec799a67c2e726d4f5b (patch) | |
| tree | a1ffe18e54f132ceb13a8bd07cae79303c5f3c30 /lib/std | |
| parent | 3464351d1e0a1e840d0b1a6267d0a5bf4113cfcc (diff) | |
| parent | e34e3344d4ac5c50a008905fe5cba25629cafa1c (diff) | |
| download | zig-b9d63551de3518001c992ec799a67c2e726d4f5b.tar.gz zig-b9d63551de3518001c992ec799a67c2e726d4f5b.zip | |
Merge pull request #3420 from FireFox317/generated-docs-improvements
Generated docs: add parameter names to functions
Diffstat (limited to 'lib/std')
| -rw-r--r-- | lib/std/special/docs/main.js | 21 |
1 files changed, 17 insertions, 4 deletions
diff --git a/lib/std/special/docs/main.js b/lib/std/special/docs/main.js index 879b75872c..cc21767191 100644 --- a/lib/std/special/docs/main.js +++ b/lib/std/special/docs/main.js @@ -554,6 +554,16 @@ if (i != 0) { payloadHtml += ', '; } + + if (fnDecl != null && zigAnalysis.astNodes[fnDecl.src].fields != null) { + var paramDeclIndex = zigAnalysis.astNodes[fnDecl.src].fields[i]; + var paramName = zigAnalysis.astNodes[paramDeclIndex].name; + + if (paramName != null) { + payloadHtml += paramName + ': '; + } + } + var argTypeIndex = typeObj.args[i]; if (argTypeIndex != null) { payloadHtml += typeIndexName(argTypeIndex, wantHtml, wantSubLink); @@ -776,14 +786,17 @@ if (container.fields != null && container.fields.length !== 0) { resizeDomList(domListFields, container.fields.length, '<div></div>'); + + var containerNode = zigAnalysis.astNodes[container.src]; for (var i = 0; i < container.fields.length; i += 1) { - var field = container.fields[i]; + var fieldTypeIndex = container.fields[i]; + var fieldNode = zigAnalysis.astNodes[containerNode.fields[i]]; var divDom = domListFields.children[i]; - var html = '<pre>' + escapeHtml(field.name) + ": " + - typeIndexName(field.type, true, true) + ',</pre>'; + var html = '<pre>' + escapeHtml(fieldNode.name) + ": " + + typeIndexName(fieldTypeIndex, true, true) + ',</pre>'; - var docs = zigAnalysis.astNodes[field.src].docs; + var docs = fieldNode.docs; if (docs != null) { html += markdown(docs); } |