kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers'

Browse source

The 'functions' directive is not only for functions, but also works for
structs/unions. So the name is misleading. This patch renames it to
'identifiers', which specific the functions/types to be included in
documentation. We keep the old name as an alias of the new one before
all documentation are updated.

Signed-off-by: Changbin Du <changbin.du@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

...

This commit is contained in:

Changbin Du 2019-10-31 21:52:45 +08:00 • committed by Jonathan Corbet

parent e80d89380c

commit 36bc683dde

2 changed files with 27 additions and 19 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

29

Documentation/doc-guide/kernel-doc.rst

View file

17

Documentation/sphinx/kerneldoc.py

View file