summaryrefslogtreecommitdiffstats
path: root/include/kunit/visibility.h
diff options
context:
space:
mode:
authorMichal Wajdeczko <michal.wajdeczko@intel.com>2024-08-29 20:31:50 +0200
committerShuah Khan <skhan@linuxfoundation.org>2024-09-05 17:35:00 +0200
commita4311c274e08001b129bd5ffd2a41dcbd3e0a855 (patch)
tree6885a219cae5f3719113a71fbab5334173557fbe /include/kunit/visibility.h
parentDocumentation: KUnit: Update filename best practices (diff)
downloadlinux-a4311c274e08001b129bd5ffd2a41dcbd3e0a855.tar.xz
linux-a4311c274e08001b129bd5ffd2a41dcbd3e0a855.zip
kunit: Fix kernel-doc for EXPORT_SYMBOL_IF_KUNIT
While kunit/visibility.h is today not included in any generated kernel documentation, also likely due to the fact that none of the existing comments are correctly recognized as kernel-doc, but once we decide to add this header and fix the tool, there will be: ../include/kunit/visibility.h:61: warning: Function parameter or struct member 'symbol' not described in 'EXPORT_SYMBOL_IF_KUNIT' Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com> Reviewed-by: Rae Moar <rmoar@google.com> Acked-by: David Gow <davidgow@google.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Diffstat (limited to 'include/kunit/visibility.h')
-rw-r--r--include/kunit/visibility.h1
1 files changed, 1 insertions, 0 deletions
diff --git a/include/kunit/visibility.h b/include/kunit/visibility.h
index 0dfe35feeec6..efff77b58dd6 100644
--- a/include/kunit/visibility.h
+++ b/include/kunit/visibility.h
@@ -22,6 +22,7 @@
* EXPORTED_FOR_KUNIT_TESTING namespace only if CONFIG_KUNIT is
* enabled. Must use MODULE_IMPORT_NS(EXPORTED_FOR_KUNIT_TESTING)
* in test file in order to use symbols.
+ * @symbol: the symbol identifier to export
*/
#define EXPORT_SYMBOL_IF_KUNIT(symbol) EXPORT_SYMBOL_NS(symbol, \
EXPORTED_FOR_KUNIT_TESTING)