KhronosGroup / KhronosGroup/Vulkan-Docs
REQUEST: Add TOC-like api listing for the functions, structs, and enums of the given chapter
- Dominant language
- JavaScript
- Stars
- 3.3k
- Forks
- 549
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 2
Description
Most chapters of the Vulkan Spec contain functions, structs, and enums related to the subject of that chapter. Sometimes, it can be tricky finding a particular item in a chapter, specially if one doesn't remember the exact name.
Please consider adding a TOC-like list of the functions, structs, and enums listed in that chapter. They should be links that takes you to the relevant entry. Perhaps, that listing should come right after the chapter's introduction.
Example for the `Command Buffers` chapter:
-----
# Command Buffers - API Listing
## Command Pools
### Functions
- vkCreateCommandPool
- vkTrimCommandPool
- vkTrimCommandPoolKHR
- vkResetCommandPool
- vkDestroyCommandPool
### Structs
- VkCommandPoolCreateInfo
### Enums
- VkCommandPoolCreateFlagBits
- VkCommandPoolResetFlagBits
## Command Buffer Allocation and Management
### Functions
- vkAllocateCommandBuffers
- vkResetCommandBuffer
- vkFreeCommandBuffers
### Structs
- VkCommandBufferAllocateInfo
### Enums
- VkCommandBufferLevel
- VkCommandBufferResetFlagBits
## Command Buffer Recording
...
Contributor guide
Research direction
Start with the Vulkan Spec's Command Buffers chapter and compare its introduction with the proposed API listing. Determine how functions, structs, and enums are represented in each chapter and how their links should be generated. Done means chapters expose consistent TOC-like listings whose entries link to the relevant API definitions.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100