Skip to content

Commit 8fdda5d

Browse files
committed
doc: Add kernel-doc to header files
Add missing documentation bits to all header files. This a very rudimentary and surely needs a to be refined later. But let's first try to get kernel-doc to report 0 warning/errors so we can actually detect offenders added by new code. Signed-off-by: Daniel Wagner <[email protected]>
1 parent e1e659f commit 8fdda5d

5 files changed

Lines changed: 476 additions & 412 deletions

File tree

src/nvme/api-types.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ struct nvme_get_log_args {
102102
* @nsid: Namespace ID, if applicable
103103
* @cdw11: Value to set the feature to
104104
* @cdw12: Feature specific command dword12 field
105+
* @cdw13: Feature specific command dword13 field
105106
* @cdw15: Feature specific command dword15 field
106107
* @data_len: Length of feature data, if applicable, in bytes
107108
* @save: Save value across power states
@@ -167,6 +168,7 @@ struct nvme_get_features_args {
167168
* @pil: Protection information location (beginning or end), true if end
168169
* @ses: Secure erase settings
169170
* @lbaf: Logical block address format least significant 4 bits
171+
* @rsvd1: Reserved
170172
* @lbafu: Logical block address format most significant 2 bits
171173
*/
172174
struct nvme_format_nvm_args {
@@ -586,6 +588,7 @@ struct nvme_virtual_mgmt_args {
586588
* to use end-to-end protection information.
587589
* @dspec: Directive specific value
588590
* @dsm: Data set management attributes, see &enum nvme_io_dsm_flags
591+
* @rsvd1: Reserved
589592
* @reftag_u64: This field specifies the variable sized Expected Initial
590593
* Logical Block Reference Tag (EILBRT) or Initial Logical Block
591594
* Reference Tag (ILBRT). It is the 8 byte version required for
@@ -862,6 +865,7 @@ struct nvme_zns_mgmt_recv_args {
862865
* @control:
863866
* @lbat: Logical block application tag
864867
* @lbatm: Logical block application tag mask
868+
* @rsvd1: Reserved
865869
* @ilbrt_u64: Initial logical block reference tag - 8 byte
866870
* version required for enhanced protection info
867871
*

0 commit comments

Comments
 (0)