Re: [PATCH v4 09/10] iio: magnetometer: yas530: Introduce "chip_info" structure

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Andy,

On 29.07.22 18:08, Andy Shevchenko wrote:
> On Fri, Jul 29, 2022 at 1:06 AM Jakob Hauser <jahau@xxxxxxxxxxxxxx> wrote:

...

>> Is it appropriate to include this to kernel doc? Generally I'm unsure on
>> kernel doc but I guess yes...
> 
> I'm unsure if it's appropriate for static (integer) arrays, you may
> run kernel doc script yourself and check man, html and pdf formats to
> see if it's rendered correctly.

Nope, doesn't work...

It was a beginner's mistake on my side. I did check
Documentation/doc-guide/kernel-doc.rst before and followed the "typedef"
part, which is quite short. I thought "typedef" is a more general
designation – but after reading more on "typedef" I now know what it is :/
https://github.com/torvalds/linux/blob/v5.18/Documentation/doc-guide/kernel-doc.rst#typedef-documentation

So, as far as I can see, kernel doc applies to functions, structures,
unions, enumerations and typedefs only.

I would then switch the comments to regular comments:

/*
 * t_ref_counts[] is the number of counts at reference temperature.
 *
 * The temperature value at YAS magnetometers is a number of counts. The
 * values in t_ref_counts[] are the counts at the reference temperature
 * of 20 °C.
 *
 * For YAS532/533, this value is known from the Android driver. For
 * YAS530, it was approximately measured.
 */
static const u16 t_ref_counts[] = { 182, 390, 390, };

/*
 * min_temp_celsius_x10[] is the starting point of temperature counting
 * in 1/10:s degrees Celsius.
 *
 * The array min_temp_celsius_x10[] contains the temperatures where the
 * temperature value count is 0. The values are in 1/10:s degrees
 * Celsius to ease the further temperature calculation.
 *
 * These temperatures are derived from the temperature resolutions given
 * in the data sheets.
 */
static const s16 min_temp_celsius_x10[] = { -620, -500, -500, };

...

Kind regards,
Jakob




[Index of Archives]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Input]     [Linux Kernel]     [Linux SCSI]     [X.org]

  Powered by Linux