Re: [PATCH] kernel-doc: rename the kernel-doc directive 'functions' to 'specific'
From: Matthew Wilcox
Date: Tue Oct 15 2019 - 07:54:48 EST
On Tue, Oct 15, 2019 at 11:25:53AM +0200, Thomas Zimmermann wrote:
> > My preference would be to use 'symbols'. I tried to come up with something
> > but 'symbols' is better than anything I came up with.
> Maybe 'interfaces' or 'artifacts'. The term 'symbols' is just as
> imprecise as 'functions'.
I suggested 'identifier' because that's the term used in the C spec (6.2.1):
: An identifier can denote an object; a function; a tag or a member
: of a structure, union, or enumeration; a typedef name; a label name;
: a macro name; or a macro parameter.
We don't allow documenting all those things separately, but it does cover
all the things we do allow to be individually documented.