fix(docbuild): Fix @file commands and guard macros. (#6689)

lv_version.h

@@ -3,12 +3,12 @@
  * The current version of LVGL
  */
 
-#ifndef __LVGL_VERSION_H__
+#ifndef LVGL_VERSION_H
-#define __LVGL_VERSION_H__
+#define LVGL_VERSION_H
 
 #define LVGL_VERSION_MAJOR 9
 #define LVGL_VERSION_MINOR 1
 #define LVGL_VERSION_PATCH 1
 #define LVGL_VERSION_INFO "dev"
 
-#endif /*__LVGL_VERSION_H__*/
+#endif /* LVGL_VERSION_H */

src/draw/lv_image_dsc.h

@@ -3,8 +3,8 @@
  *
  */
 
-#ifndef LV_IMAGE_BUF_H
+#ifndef LV_IMAGE_DSC_H
-#define LV_IMAGE_BUF_H
+#define LV_IMAGE_DSC_H
 
 #ifdef __cplusplus
 extern "C" {
@@ -138,4 +138,4 @@ typedef struct {
 } /*extern "C"*/
 #endif
 
-#endif /*LV_IMAGE_BUF_H*/
+#endif /*LV_IMAGE_DSC_H*/

src/draw/renesas/dave2d/lv_draw_dave2d.h

@@ -1,3 +1,8 @@
+/**
+ * @file lv_draw_dave2d.h
+ *
+ */
+
 #ifndef LV_DRAW_DAVE2D_H
 #define LV_DRAW_DAVE2D_H
 

src/draw/sw/blend/lv_draw_sw_blend_to_i1.h

@@ -3,8 +3,8 @@
  *
  */
 
-#ifndef LV_DRAW_SW_BLEND_I1_H
+#ifndef LV_DRAW_SW_BLEND_TO_I1_H
-#define LV_DRAW_SW_BLEND_I1_H
+#define LV_DRAW_SW_BLEND_TO_I1_H
 
 #ifdef __cplusplus
 extern "C" {
@@ -42,4 +42,4 @@ void /* LV_ATTRIBUTE_FAST_MEM */ lv_draw_sw_blend_image_to_i1(lv_draw_sw_blend_i
 } /*extern "C"*/
 #endif
 
-#endif /*LV_DRAW_SW_BLEND_I1_H*/
+#endif /*LV_DRAW_SW_BLEND_TO_I1_H*/

src/drivers/display/ili9341/lv_ili9341.h

@@ -1,5 +1,5 @@
-/*
+/**
- * lv_ili9341.h
+ * @file lv_ili9341.h
  *
  * This driver is just a wrapper around the generic MIPI compatible LCD controller driver
  *

src/drivers/display/lcd/lv_lcd_generic_mipi.h

@@ -1,5 +1,5 @@
-/*
+/**
- * lv_lcd_generic_mipi.h
+ * @file lv_lcd_generic_mipi.h
  *
  * Generic driver for controllers adhering to the MIPI DBI/DCS specification
  *

src/drivers/display/st7735/lv_st7735.h

@@ -1,5 +1,5 @@
-/*
+/**
- * lv_st7735.h
+ * @file lv_st7735.h
  *
  * This driver is just a wrapper around the generic MIPI compatible LCD controller driver
  *

src/drivers/display/st7789/lv_st7789.h

@@ -1,5 +1,5 @@
-/*
+/**
- * lv_st7789.h
+ * @file lv_st7789.h
  *
  * This driver is just a wrapper around the generic MIPI compatible LCD controller driver
  *

src/drivers/display/st7796/lv_st7796.h

@@ -1,5 +1,5 @@
-/*
+/**
- * lv_st7796.h
+ * @file lv_st7796.h
  *
  * This driver is just a wrapper around the generic MIPI compatible LCD controller driver
  *

src/drivers/qnx/lv_qnx.h

@@ -3,8 +3,8 @@
  * @brief   LVGL driver for the QNX Screen compositing window manager
  */
 
-#ifndef LV_QNX_DISP_H
+#ifndef LV_QNX_H
-#define LV_QNX_DISP_H
+#define LV_QNX_H
 
 #ifdef __cplusplus
 extern "C" {
@@ -83,4 +83,4 @@ int lv_qnx_event_loop(lv_display_t * disp);
 } /* extern "C" */
 #endif
 
-#endif /* LV_QNX_DISP_H */
+#endif /* LV_QNX_H */

src/drivers/sdl/lv_sdl_window.h

@@ -3,8 +3,8 @@
  *
  */
 
-#ifndef LV_SDL_DISP_H
+#ifndef LV_SDL_WINDOW_H
-#define LV_SDL_DISP_H
+#define LV_SDL_WINDOW_H
 
 #ifdef __cplusplus
 extern "C" {
@@ -59,4 +59,4 @@ void lv_sdl_quit(void);
 } /* extern "C" */
 #endif
 
-#endif /* LV_SDL_DISP_H */
+#endif /* LV_SDL_WINDOW_H */

src/font/lv_binfont_loader.h

@@ -3,8 +3,8 @@
  *
  */
 
-#ifndef LV_FONT_LOADER_H
+#ifndef LV_BINFONT_LOADER_H
-#define LV_FONT_LOADER_H
+#define LV_BINFONT_LOADER_H
 
 #ifdef __cplusplus
 extern "C" {
@@ -58,4 +58,4 @@ void lv_binfont_destroy(lv_font_t * font);
 } /*extern "C"*/
 #endif
 
-#endif /*LV_FONT_LOADER_H*/
+#endif /* LV_BINFONT_LOADER_H */

src/font/lv_symbol_def.h

@@ -1,3 +1,8 @@
+/**
+ * @file lv_symbol_def.h
+ *
+ */
+
 #ifndef LV_SYMBOL_DEF_H
 #define LV_SYMBOL_DEF_H
 

src/lvgl.h

@@ -36,4 +36,4 @@ extern "C" {
 } /*extern "C"*/
 #endif
 
-#endif /*LVGL_SRC_H*/
+#endif /* LVGL_SRC_H */

src/misc/cache/lv_cache.h

@@ -1,10 +1,10 @@
 /**
-* @file lv_cache.h
+ * @file lv_cache.h
-*
+ *
-*/
+ */
 
-#ifndef LV_CACHE1_H
+#ifndef LV_CACHE_H
-#define LV_CACHE1_H
+#define LV_CACHE_H
 
 #ifdef __cplusplus
 extern "C" {
@@ -69,7 +69,7 @@ lv_cache_entry_t * lv_cache_acquire(lv_cache_t * cache, const void * key, void *
 /**
  * Acquire a cache entry with the given key. If the entry is not in the cache, it will create a new entry with the given key.
  * If the entry is found, it's priority will be changed by the cache's policy. And the `lv_cache_entry_t::ref_cnt` will be incremented.
- * If you want to use this API to simplify the code, you should provide a @lv_cache_ops_t::create_cb that creates a new entry with the given key.
+ * If you want to use this API to simplify the code, you should provide a `lv_cache_ops_t::create_cb` that creates a new entry with the given key.
  * This API is a combination of lv_cache_acquire() and lv_cache_add(). The effect is the same as calling lv_cache_acquire() and lv_cache_add() separately.
  * And the internal impact on cache is also consistent with these two APIs.
  * @param cache         The cache object pointer to acquire the entry.
@@ -227,4 +227,4 @@ const char * lv_cache_get_name(lv_cache_t * cache);
 } /*extern "C"*/
 #endif
 
-#endif /*LV_CACHE_H*/
+#endif /* LV_CACHE_H */

src/misc/cache/lv_cache_entry_private.h

@@ -1,10 +1,10 @@
 /**
-* @file lv_cache_entry_private.h
+ * @file lv_cache_entry_private.h
-*
+ *
  */
 
-#ifndef LV_CACHE_ENTRY_PRIVATE
+#ifndef LV_CACHE_ENTRY_PRIVATE_H
-#define LV_CACHE_ENTRY_PRIVATE
+#define LV_CACHE_ENTRY_PRIVATE_H
 
 #ifdef __cplusplus
 extern "C" {
@@ -47,4 +47,4 @@ void   lv_cache_entry_release_data(lv_cache_entry_t * entry, void * user_data);
 } /*extern "C"*/
 #endif
 
-#endif /*LV_CACHE_ENTRY_PRIVATE*/
+#endif /* LV_CACHE_ENTRY_PRIVATE_H */

src/others/gridnav/lv_gridnav.h

@@ -3,8 +3,8 @@
  *
  */
 
-#ifndef LV_GRIDFOCUS_H
+#ifndef LV_GRIDNAV_H
-#define LV_GRIDFOCUS_H
+#define LV_GRIDNAV_H
 
 #ifdef __cplusplus
 extern "C" {
@@ -92,4 +92,4 @@ void lv_gridnav_set_focused(lv_obj_t * cont, lv_obj_t * to_focus, lv_anim_enable
 } /*extern "C"*/
 #endif
 
-#endif /*LV_GRIDFOCUS_H*/
+#endif /* LV_GRIDNAV_H */

src/stdlib/lv_sprintf.h

@@ -1,10 +1,10 @@
 /**
- * lv_snprintf.h
+ * @file lv_sprintf.h
  *
  */
 
-#ifndef LV_SPRINTF_H_
+#ifndef LV_SPRINTF_H
-#define LV_SPRINTF_H_
+#define LV_SPRINTF_H
 
 #if defined(__has_include)
     #if __has_include(LV_INTTYPES_INCLUDE)
@@ -42,4 +42,4 @@ int lv_vsnprintf(char * buffer, size_t count, const char * format, va_list va);
 } /*extern "C"*/
 #endif
 
-#endif  /* LV_SPRINTF_H_*/
+#endif  /* LV_SPRINTF_H */

src/themes/mono/lv_theme_mono.h

@@ -3,8 +3,8 @@
  *
  */
 
-#ifndef LV_USE_THEME_MONO_H
+#ifndef LV_THEME_MONO_H
-#define LV_USE_THEME_MONO_H
+#define LV_THEME_MONO_H
 
 #ifdef __cplusplus
 extern "C" {
@@ -59,4 +59,4 @@ void lv_theme_mono_deinit(void);
 } /*extern "C"*/
 #endif
 
-#endif /*LV_USE_THEME_MONO_H*/
+#endif /* LV_THEME_MONO_H */

src/widgets/list/lv_list.h

@@ -1,5 +1,5 @@
 /**
- * @file lv_win.h
+ * @file lv_list.h
  *
  */
 

src/widgets/tabview/lv_tabview.h

@@ -1,5 +1,5 @@
 /**
- * @file lv_templ.h
+ * @file lv_tabview.h
  *
  */
 

tests/src/lv_test_conf_full.h

@@ -1,3 +1,6 @@
+#ifndef LV_TEST_CONF_FULL_H
+#define LV_TEST_CONF_FULL_H
+
 #define LV_MEM_SIZE                     (32 * 1024 * 1024)
 #define LV_DRAW_SW_SHADOW_CACHE_SIZE    8
 #define LV_DRAW_THREAD_STACK_SIZE    (64 * 1024) /*Increase stack size to 64KB in order to run ThorVG*/
@@ -147,3 +150,5 @@
 #define LV_FREETYPE_CACHE_FT_GLYPH_CNT 10
 
 #define LV_USE_DRAW_SW_COMPLEX_GRADIENTS    1
+
+#endif /* LV_TEST_CONF_FULL_H */

tests/src/lv_test_conf_minimal.h

@@ -1,3 +1,6 @@
+#ifndef LV_TEST_CONF_MINIMAL_H
+#define LV_TEST_CONF_MINIMAL_H
+
 #define  LV_MEM_SIZE        65535
 #define  LV_USE_LOG         1
 #define  LV_USE_ASSERT_NULL             0
@@ -19,3 +22,5 @@
 #define  LV_USE_RLE                     1
 #define  LV_USE_GIF                     1
 #define  LV_USE_QRCODE                  1
+
+#endif /* LV_TEST_CONF_MINIMAL_H */

tests/src/lv_test_conf_vg_lite.h

@@ -1,3 +1,6 @@
+#ifndef LV_TEST_CONF_VG_LITE_H
+#define LV_TEST_CONF_VG_LITE_H
+
 /* Use VG-Lite GPU. */
 #define LV_USE_DRAW_VG_LITE 1
 
@@ -37,3 +40,5 @@
     `LV_USE_MATRIX = 1`.
     The rendering engine needs to support 3x3 matrix transformations.*/
 #define LV_DRAW_TRANSFORM_USE_MATRIX            1
+
+#endif /* LV_TEST_CONF_VG_LITE_H */