authorgravatar for kappaloris@gmail.comLoris Cro <kappaloris@gmail.com> 2022-08-02 16:30:12+02:00
committergravatar for noreply@github.comGitHub <noreply@github.com> 2022-08-02 16:30:12+02:00
log9ba2377d6406ef57695f3297b91f35f3ad1705b5
treec8146f5a48b7967a70abbd0c26c89b1b5e85c971
parente7b6a1833106a5d808e4e82a2d61abf417aff407
parent921ba6cad4b9f414ab90ab0968acdcf50068bbc5
signaturebadge-question-mark Signed by PGP key 4AEE18F83AFDEB23

Merge pull request #12305 from squeek502/autodoc-field-doc-borders

autodoc: Add borders to field docs to make it clear which field they are associated with

2 files changed, 22 insertions(+), 8 deletions(-)

lib/docs/index.html+10
...@@ -284,6 +284,16 @@...@@ -284,6 +284,16 @@
284 overflow-x: hidden;284 overflow-x: hidden;
285 }285 }
286286
287 .fieldHasDocs {
288 margin-bottom: 0;
289 }
290
291 .fieldDocs {
292 border: 1px solid #2A2A2A;
293 border-top: 0px;
294 padding: 1px 1em;
295 }
296
287 /* help dialog */297 /* help dialog */
288 .help-modal {298 .help-modal {
289 display: flex;299 display: flex;
lib/docs/main.js+12-8
...@@ -618,15 +618,18 @@ var zigAnalysis;...@@ -618,15 +618,18 @@ var zigAnalysis;
618 for (let i = 0; i < fields.length; i += 1) {618 for (let i = 0; i < fields.length; i += 1) {
619 let field = fields[i];619 let field = fields[i];
620 let fieldNode = zigAnalysis.astNodes[field];620 let fieldNode = zigAnalysis.astNodes[field];
621 let docs = fieldNode.docs;
621 if (fieldNode.docs == null) {622 if (fieldNode.docs == null) {
622 continue;623 continue;
623 }624 }
625 let docsNonEmpty = docs !== "";
624 let divDom = domListParams.children[domIndex];626 let divDom = domListParams.children[domIndex];
625 domIndex += 1;627 domIndex += 1;
626628
627629
628 let value = typeObj.params[i];630 let value = typeObj.params[i];
629 let html = '<pre>' + escapeHtml((fieldNode.name)) + ": ";631 let preClass = docsNonEmpty ? ' class="fieldHasDocs"' : "";
632 let html = '<pre' + preClass + '>' + escapeHtml((fieldNode.name)) + ": ";
630 if (isVarArgs && i === typeObj.params.length - 1) {633 if (isVarArgs && i === typeObj.params.length - 1) {
631 html += '...';634 html += '...';
632 } else {635 } else {
...@@ -636,9 +639,8 @@ var zigAnalysis;...@@ -636,9 +639,8 @@ var zigAnalysis;
636639
637 html += ',</pre>';640 html += ',</pre>';
638641
639 let docs = fieldNode.docs;642 if (docsNonEmpty) {
640 if (docs != null) {643 html += '<div class="fieldDocs">' + markdown(docs) + '</div>';
641 html += markdown(docs);
642 }644 }
643 divDom.innerHTML = html;645 divDom.innerHTML = html;
644 }646 }
...@@ -2270,8 +2272,11 @@ var zigAnalysis;...@@ -2270,8 +2272,11 @@ var zigAnalysis;
2270 let fieldNode = zigAnalysis.astNodes[containerNode.fields[i]];2272 let fieldNode = zigAnalysis.astNodes[containerNode.fields[i]];
2271 let divDom = domListFields.children[i];2273 let divDom = domListFields.children[i];
2272 let fieldName = (fieldNode.name);2274 let fieldName = (fieldNode.name);
2275 let docs = fieldNode.docs;
2276 let docsNonEmpty = docs != null && docs !== "";
2277 let extraPreClass = docsNonEmpty ? " fieldHasDocs" : "";
22732278
2274 let html = '<div class="mobile-scroll-container"><pre class="scroll-item">' + escapeHtml(fieldName);2279 let html = '<div class="mobile-scroll-container"><pre class="scroll-item' + extraPreClass + '">' + escapeHtml(fieldName);
22752280
2276 if (container.kind === typeKinds.Enum) {2281 if (container.kind === typeKinds.Enum) {
2277 html += ' = <span class="tok-number">' + fieldName + '</span>';2282 html += ' = <span class="tok-number">' + fieldName + '</span>';
...@@ -2289,9 +2294,8 @@ var zigAnalysis;...@@ -2289,9 +2294,8 @@ var zigAnalysis;
22892294
2290 html += ',</pre></div>';2295 html += ',</pre></div>';
22912296
2292 let docs = fieldNode.docs;2297 if (docsNonEmpty) {
2293 if (docs != null) {2298 html += '<div class="fieldDocs">' + markdown(docs) + '</div>';
2294 html += markdown(docs);
2295 }2299 }
2296 divDom.innerHTML = html;2300 divDom.innerHTML = html;
2297 }2301 }