Re: [PATCH V2 1/2] cpumask: Fix kernel-doc formatting errors in cpumask.h

[Akira Yokosawa]

Hi,

Viresh Kumar wrote:
> On 10-03-25, 11:45, Viresh Kumar wrote:
>> On 07-03-25, 12:05, Yury Norov wrote:
>>>>  /**
>>>> - * cpumask_weight - Count of bits in *srcp
>>>> + * cpumask_weight - Count of bits in *@srcp
>>>>   * @srcp: the cpumask to count bits (< nr_cpu_ids) in.
>>>
>>> Here nr_cpu_ids is also a variable. Why you don't prefix it with @?
> 
> Hmm, I thought @ is applied only to function arguments. Not sure what
> should be done with nr_cpu_ids.
> 
> Akira ?

Section "Highlights and cross-references" in
Documentation/doc-guide/kernel-doc.sty says:

    ``@parameter``
    Name of a function parameter. (No cross-referencing, just formatting.)

It's just formatting.  Putting "@" to a non argument name won't result
in any warning.  (At least current kernel-doc goes.)

kernel-doc is just our own convention, which can change any moment,
hopefully in backward compatible manner.