diff options
author | Gabby George <gabbymg94@gmail.com> | 2023-03-28 20:13:45 -0700 |
---|---|---|
committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2023-04-05 08:24:11 +0300 |
commit | 44eed506c285f090b97377f3cc3023cd09221cac (patch) | |
tree | 1a8c2ec2292ec38ef2cde2b5f87f8eaaa44f37a7 | |
parent | 436b38fd89fe4324d2342084ef477a7a8809a001 (diff) |
doc: ipa: Clarify IPA acronym in its namespace description
Clarify IPA's acronym by specifying what "IPA" stands for as part of the
ipa namespaces' "brief" doxygen-generated description. This allows
visitors to the docs to immediately have an idea of the purpose of the
IPA namespace at a glance. Because of the prevalence and importance of
the IPA namespace and functionality, the fact that it stands for "Image
Processing Algorithm" should be accessible to even casual perusers of
the docs.
Signed-off-by: Gabby George <gabbymg94@gmail.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
-rw-r--r-- | src/ipa/libipa/module.cpp | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/ipa/libipa/module.cpp b/src/ipa/libipa/module.cpp index 77352104..ee01f12a 100644 --- a/src/ipa/libipa/module.cpp +++ b/src/ipa/libipa/module.cpp @@ -17,7 +17,7 @@ namespace libcamera { LOG_DEFINE_CATEGORY(IPAModuleAlgo) /** - * \brief The IPA namespace + * \brief The IPA (Image Processing Algorithm) namespace * * The IPA namespace groups all types specific to IPA modules. It serves as the * top-level namespace for the IPA library libipa, and also contains |