On 21/02/25 09:02:p, Heinrich Schuchardt wrote: > > -void qfw_read_entry(struct udevice *dev, u16 entry, u32 length, void > > *address); > > +/** > > + * Read a QEMU firmware config entry > > This will not generate documentation for qfw_read_entry() with Sphinx. > > See > https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#function-documentation
Thank you! I am now testing documentation produced using scripts/kernel-doc -man include/qfw.h | man --local-file - If there's a better way, please let me know. > > + * @return 0 on success, -ENOMEM if unable to allocate. > > This is not valid Sphinx syntax. [...] > function name missing. [...] > invalid syntax. [...] > Please, describe each function individually in Sphinx style. I'll correct these in the next version. Thank you! Best, Asherah
