[libcamera-devel] [PATCH v2] doc: ipa: Clarify IPA acronym in its namespace description

Gabby George gabbymg94 at gmail.com
Wed Mar 29 05:13:45 CEST 2023


Clarifies 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 at gmail.com>
---
 src/ipa/libipa/module.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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
-- 
2.34.1



More information about the libcamera-devel mailing list