> >>> +/* > >> > >> If it's deliberately not a kernel doc, why to bother to have it looking as one? > >> It's really a provocative to some people who will come with a patches to "fix" > >> this... > > > > Just make it kernel-doc. > > > > Are you sure...? I don't like the idea of polluting generated docs with > documentation for this type of tiny internal pieces not usable outside > this component anyways... You can use :internal or :external to pick up only the docs you want when including this stuff form a .rst file. https://docs.kernel.org/doc-guide/kernel-doc.html > > >> > >>> + * iio_gts_get_gain - Convert scale to total gain > >>> + * > >>> + * Internal helper for converting scale to total gain. > >>> + * > >>> + * @max: Maximum linearized scale. As an example, when scale is created > >>> + * in magnitude of NANOs and max scale is 64.1 - The linearized > >>> + * scale is 64 100 000 000. > >>> + * @scale: Linearized scale to compte the gain for. > >>> + * > >>> + * Return: (floored) gain corresponding to the scale. -EINVAL if scale > >>> + * is invalid. > >>> + */ > > > >> ... > >>
