soc/intel/cmn: Improve comments for fw_splash_vertical_alignment enum

This commit refines the comments for the fw_splash_vertical_alignment
enum members in src/soc/intel/common/block/include/intelblocks/cfg.h.

The redundant enum member names (e.g., FW_SPLASH_VALIGNMENT_CENTER:)
have been removed from the start of each comment block. This makes
the comments cleaner and more direct, focusing on the explanation of
the alignment behavior rather than re-stating the enum member's name.

Change-Id: Ife7a39622df1981adc09db82fecb5adc72d52d8d
Signed-off-by: Subrata Banik <subratabanik@google.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/88157
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Kapil Porwal <kapilporwal@google.com>
This commit is contained in:
Subrata Banik 2025-06-21 11:13:26 +05:30
commit ced9f91ae9

View file

@ -22,7 +22,7 @@ enum {
* within the display's height.
*/
enum fw_splash_vertical_alignment {
/* FW_SPLASH_VALIGNMENT_CENTER:
/*
* The splash image is centered vertically `(Y-axis - logo_height)/2` on the screen.
* The center of the [LOGO] aligns with the vertical center of the screen.
*
@ -36,7 +36,7 @@ enum fw_splash_vertical_alignment {
*/
FW_SPLASH_VALIGNMENT_CENTER = 0,
/* FW_SPLASH_VALIGNMENT_TOP:
/*
* The splash image is aligned to the top edge of the screen.
*
* +---------------+
@ -49,7 +49,7 @@ enum fw_splash_vertical_alignment {
*/
FW_SPLASH_VALIGNMENT_TOP = 1,
/* FW_SPLASH_VALIGNMENT_BOTTOM:
/*
* The splash image is aligned to the bottom edge of the screen.
*
* +---------------+
@ -62,7 +62,7 @@ enum fw_splash_vertical_alignment {
*/
FW_SPLASH_VALIGNMENT_BOTTOM = 2,
/* FW_SPLASH_VALIGNMENT_MIDDLE:
/*
* The splash image is placed in the vertical middle `(Y-axis/2)` of the screen
* (without considering the `logo height`). This means the TOP EDGE of the
* [LOGO] aligns with the screen's vertical midpoint line.