Fix invalid generation of the "Parameters" section #2304
Merged
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.
In the page for
PFN_vkVoidFunction
, the single description sentence is split over the Parameters and Description sections, like this:I found that
scripts/reflib.py
assumes every function pointer and function prototype page has parameter documentation, so I made it check that. I tested my changes by diffing the output of./makeSpec -spec all manhtmlpages
, and found 13 affected files. First, these 3 changes seem correct to me:PFN_vkVoidFunction
vkCmdSetPerformanceMarkerINTEL
vkGetDeviceProcAddr
For 8 pages, the Parameters section was empty, and the heading is now gone. This looks fine to me, but I don't know if the Parameters section is expected to be present even when it's empty. Perhaps these pages should have some information added on each function's parameters?
vkCmdCuLaunchKernelNVX
vkCmdSetPerformanceStreamMarkerINTEL
vkCreateCuFunctionNVX
vkCreateCuModuleNVX
vkDestroyCuFunctionNVX
vkDestroyCuModuleNVX
vkGetDescriptorSetHostMappingVALVE
vkGetDescriptorSetLayoutHostMappingInfoVALVE
For 2 pages, the Parameters section had a deprecation note, with the Description section having the parameters. The note has been moved to the Description section, and the Parameters heading is gone.
vkCreateIOSSurfaceMVK
vkCreateMacOSSurfaceMVK
These MVK pages were already wrong, and are now slightly differently wrong. They need further attention from someone more familiar with this documentation repository and its conventions.