Doc style for method functions

Simon Glass sjg at
Wed Aug 16 19:05:27 CEST 2023

Hi Jonathan,

I would like to do something like this:

struct part_driver {
    * get_info() - Get information about a partition

              ^ causes error

    * @desc: Block device descriptor
    * @part: Partition number (1 = first)
    * @info: Returns partition information
   int (*get_info)(struct blk_desc *desc, int part, struct
disk_partition *info);

But this gives:

   print STDERR "Incorrect use of kernel-doc format: $_";

Without the brackets on get_info() it works OK. What is the purpose of
that check, please?


More information about the U-Boot mailing list