diff --git a/lib/docs/index.html b/lib/docs/index.html index 03579d975e..dbcb54288a 100644 --- a/lib/docs/index.html +++ b/lib/docs/index.html @@ -284,6 +284,16 @@ overflow-x: hidden; } + .fieldHasDocs { + margin-bottom: 0; + } + + .fieldDocs { + border: 1px solid #2A2A2A; + border-top: 0px; + padding: 1px 1em; + } + /* help dialog */ .help-modal { display: flex; diff --git a/lib/docs/main.js b/lib/docs/main.js index 8be263e57f..3a16ec7ad2 100644 --- a/lib/docs/main.js +++ b/lib/docs/main.js @@ -618,15 +618,18 @@ var zigAnalysis; for (let i = 0; i < fields.length; i += 1) { let field = fields[i]; let fieldNode = zigAnalysis.astNodes[field]; + let docs = fieldNode.docs; if (fieldNode.docs == null) { continue; } + let docsNonEmpty = docs !== ""; let divDom = domListParams.children[domIndex]; domIndex += 1; let value = typeObj.params[i]; - let html = '
' + escapeHtml((fieldNode.name)) + ": "; + let preClass = docsNonEmpty ? ' class="fieldHasDocs"' : ""; + let html = '' + escapeHtml((fieldNode.name)) + ": "; if (isVarArgs && i === typeObj.params.length - 1) { html += '...'; } else { @@ -636,9 +639,8 @@ var zigAnalysis; html += ','; - let docs = fieldNode.docs; - if (docs != null) { - html += markdown(docs); + if (docsNonEmpty) { + html += '' + markdown(docs) + ''; } divDom.innerHTML = html; } @@ -2270,8 +2272,11 @@ var zigAnalysis; let fieldNode = zigAnalysis.astNodes[containerNode.fields[i]]; let divDom = domListFields.children[i]; let fieldName = (fieldNode.name); + let docs = fieldNode.docs; + let docsNonEmpty = docs != null && docs !== ""; + let extraPreClass = docsNonEmpty ? " fieldHasDocs" : ""; - let html = '' + escapeHtml(fieldName); + let html = ''; - let docs = fieldNode.docs; - if (docs != null) { - html += markdown(docs); + if (docsNonEmpty) { + html += '' + escapeHtml(fieldName); if (container.kind === typeKinds.Enum) { html += ' = ' + fieldName + ''; @@ -2289,9 +2294,8 @@ var zigAnalysis; html += ',' + markdown(docs) + ''; } divDom.innerHTML = html; }