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 @@
284284 overflow-x: hidden;
285285 }
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
287297 /* help dialog */
288298 .help-modal {
289299 display: flex;
lib/docs/main.js+12-8
......@@ -618,15 +618,18 @@ var zigAnalysis;
618618 for (let i = 0; i < fields.length; i += 1) {
619619 let field = fields[i];
620620 let fieldNode = zigAnalysis.astNodes[field];
621 let docs = fieldNode.docs;
621622 if (fieldNode.docs == null) {
622623 continue;
623624 }
625 let docsNonEmpty = docs !== "";
624626 let divDom = domListParams.children[domIndex];
625627 domIndex += 1;
626628
627629
628630 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)) + ": ";
630633 if (isVarArgs && i === typeObj.params.length - 1) {
631634 html += '...';
632635 } else {
......@@ -636,9 +639,8 @@ var zigAnalysis;
636639
637640 html += ',</pre>';
638641
639 let docs = fieldNode.docs;
640 if (docs != null) {
641 html += markdown(docs);
642 if (docsNonEmpty) {
643 html += '<div class="fieldDocs">' + markdown(docs) + '</div>';
642644 }
643645 divDom.innerHTML = html;
644646 }
......@@ -2270,8 +2272,11 @@ var zigAnalysis;
22702272 let fieldNode = zigAnalysis.astNodes[containerNode.fields[i]];
22712273 let divDom = domListFields.children[i];
22722274 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
22762281 if (container.kind === typeKinds.Enum) {
22772282 html += ' = <span class="tok-number">' + fieldName + '</span>';
......@@ -2289,9 +2294,8 @@ var zigAnalysis;
22892294
22902295 html += ',</pre></div>';
22912296
2292 let docs = fieldNode.docs;
2293 if (docs != null) {
2294 html += markdown(docs);
2297 if (docsNonEmpty) {
2298 html += '<div class="fieldDocs">' + markdown(docs) + '</div>';
22952299 }
22962300 divDom.innerHTML = html;
22972301 }