[1/6] ipa: rkisp1: goc: Fix typographical issues in documentation.
diff mbox series

Message ID 20240611212101.14313-2-laurent.pinchart@ideasonboard.com
State Accepted
Commit 6dba3f461259461f62417d567e8766da27767216
Headers show
Series
  • ipa: rksip1: goc: Assorted fixes
Related show

Commit Message

Laurent Pinchart June 11, 2024, 9:20 p.m. UTC
Fix a few assorted typographical issues:

- Sentences should end with a period.
- Paragraphs should be separated by a blank line, and there should be no
  line break within a paragraph.
- Doxygen lists need a list marker ('-' or '*', use '-' here).

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/ipa/rkisp1/algorithms/goc.cpp | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

Comments

Stefan Klug June 12, 2024, 7:17 a.m. UTC | #1
Hi Laurent,

thank you for the fixup.

On Wed, Jun 12, 2024 at 12:20:56AM +0300, Laurent Pinchart wrote:
> Fix a few assorted typographical issues:
> 
> - Sentences should end with a period.
> - Paragraphs should be separated by a blank line, and there should be no
>   line break within a paragraph.
> - Doxygen lists need a list marker ('-' or '*', use '-' here).
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com> 

Stefan

> ---
>  src/ipa/rkisp1/algorithms/goc.cpp | 9 +++++----
>  1 file changed, 5 insertions(+), 4 deletions(-)
> 
> diff --git a/src/ipa/rkisp1/algorithms/goc.cpp b/src/ipa/rkisp1/algorithms/goc.cpp
> index 0201a59deba3..fc5ad9f9177e 100644
> --- a/src/ipa/rkisp1/algorithms/goc.cpp
> +++ b/src/ipa/rkisp1/algorithms/goc.cpp
> @@ -29,15 +29,16 @@ namespace ipa::rkisp1::algorithms {
>   * \class GammaOutCorrection
>   * \brief RkISP1 Gamma out correction
>   *
> - * This algorithm implements the gamma out curve for the RkISP1.
> - * It defaults to a gamma value of 2.2
> + * This algorithm implements the gamma out curve for the RkISP1. It defaults to
> + * a gamma value of 2.2.
> + *
>   * As gamma is internally represented as a piecewise linear function with only
>   * 17 knots, the difference between gamma=2.2 and sRGB gamma is minimal.
>   * Therefore sRGB gamma was not implemented as special case.
>   *
>   * Useful links:
> - * https://www.cambridgeincolour.com/tutorials/gamma-correction.htm
> - * https://en.wikipedia.org/wiki/SRGB
> + * - https://www.cambridgeincolour.com/tutorials/gamma-correction.htm
> + * - https://en.wikipedia.org/wiki/SRGB
>   */
>  
>  LOG_DEFINE_CATEGORY(RkISP1Gamma)
> -- 
> Regards,
> 
> Laurent Pinchart
>

Patch
diff mbox series

diff --git a/src/ipa/rkisp1/algorithms/goc.cpp b/src/ipa/rkisp1/algorithms/goc.cpp
index 0201a59deba3..fc5ad9f9177e 100644
--- a/src/ipa/rkisp1/algorithms/goc.cpp
+++ b/src/ipa/rkisp1/algorithms/goc.cpp
@@ -29,15 +29,16 @@  namespace ipa::rkisp1::algorithms {
  * \class GammaOutCorrection
  * \brief RkISP1 Gamma out correction
  *
- * This algorithm implements the gamma out curve for the RkISP1.
- * It defaults to a gamma value of 2.2
+ * This algorithm implements the gamma out curve for the RkISP1. It defaults to
+ * a gamma value of 2.2.
+ *
  * As gamma is internally represented as a piecewise linear function with only
  * 17 knots, the difference between gamma=2.2 and sRGB gamma is minimal.
  * Therefore sRGB gamma was not implemented as special case.
  *
  * Useful links:
- * https://www.cambridgeincolour.com/tutorials/gamma-correction.htm
- * https://en.wikipedia.org/wiki/SRGB
+ * - https://www.cambridgeincolour.com/tutorials/gamma-correction.htm
+ * - https://en.wikipedia.org/wiki/SRGB
  */
 
 LOG_DEFINE_CATEGORY(RkISP1Gamma)