HTML output: Display all levels of parameter properties. #933
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello,
I ran into an issue where certain portions of the JSON output was not being included in the HTML output. Specifically, properties underneath parameter properties (
section.params.properties.properties
). These sub-properties are included in the MD output, so I assumed they should be part of the HTML output. So here's my fix.JSDoc
Expected HTML Output
Actual HTML Output
As above, but both of the
secondLevel...
property rows are omitted.The sub-properties were being omitted because
section._
only iterates overparam.properties
and doesn't check for anything underneath it (here). So I created a new template (paramProperty._
) (to replace that portion ofsection._
) that recursively checks for properties and renders them (here). With this, the actual HTML output matches [my] expected HTML output.I updated the test case input (
html/nested.input.js
) to include a case for this, but haven't updated the snapshots to reflect the new output. Wasn't sure what your process is for this.