diff options
| author | Isabella Gottardi <isabella.gottardi@arm.com> | 2021-05-12 08:27:15 +0100 |
|---|---|---|
| committer | Isabella Gottardi <isabella.gottardi@arm.com> | 2021-05-18 09:48:12 +0100 |
| commit | 56ee6207c1524ddc4c444c6e48e05eb34105985a (patch) | |
| tree | d4fc7823961034e95364f44b34fb098b34b99d0d /source/application/hal/platforms | |
| parent | f4e2c4736f19d2e06fede715bb49c475f93d79a9 (diff) | |
| download | ml-embedded-evaluation-kit-56ee6207c1524ddc4c444c6e48e05eb34105985a.tar.gz | |
MLECO-1858: Documentation update
* Removing `_` in front of private functions and member
Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
Change-Id: I5a5d652f9647ebb16d2d2bd16ab980e73f7be3cf
Diffstat (limited to 'source/application/hal/platforms')
| -rw-r--r-- | source/application/hal/platforms/bare-metal/bsp/bsp-packs/simple_platform/include/stubs_fvp.h | 8 | ||||
| -rw-r--r-- | source/application/hal/platforms/native/data_presentation/log/include/log.h | 1 |
2 files changed, 1 insertions, 8 deletions
diff --git a/source/application/hal/platforms/bare-metal/bsp/bsp-packs/simple_platform/include/stubs_fvp.h b/source/application/hal/platforms/bare-metal/bsp/bsp-packs/simple_platform/include/stubs_fvp.h index a21f2d2..aec0be1 100644 --- a/source/application/hal/platforms/bare-metal/bsp/bsp-packs/simple_platform/include/stubs_fvp.h +++ b/source/application/hal/platforms/bare-metal/bsp/bsp-packs/simple_platform/include/stubs_fvp.h @@ -35,7 +35,6 @@ uint32_t GetCoreClock(void); /************************ GLCD related functions ****************************/ /** * @brief Initialize the Himax LCD with HX8347-D LCD Controller - * @return none */ void GLCD_Initialize(void); @@ -48,7 +47,6 @@ void GLCD_Initialize(void); * @param[in] w width of bitmap. * @param[in] h height of bitmap. * @param[in] bitmap address at which the bitmap data resides. - * @return none */ void GLCD_Bitmap(unsigned int x, unsigned int y, unsigned int w, unsigned int h, @@ -65,7 +63,6 @@ void GLCD_Bitmap(unsigned int x, unsigned int y, * @param[in] pos_y start y position for the LCD. * @param[in] downsample_factor factor by which the image * is downsampled by. - * @return none */ void GLCD_Image(void *data, const uint32_t width, const uint32_t height, const uint32_t channels, @@ -75,14 +72,12 @@ void GLCD_Image(void *data, const uint32_t width, /** * @brief Clear display * @param[in] color display clearing color - * @return none */ void GLCD_Clear(unsigned short color); /** * @brief Set foreground color * @param[in] color foreground color - * @return none */ void GLCD_SetTextColor(unsigned short color); @@ -92,7 +87,6 @@ void GLCD_SetTextColor(unsigned short color); * @param[in] col column number * @param[in] fi font index (0 = 9x15) * @param[in] c ASCII character - * @return none */ void GLCD_DisplayChar(unsigned int ln, unsigned int col, unsigned char fi, unsigned char c); @@ -103,7 +97,6 @@ void GLCD_DisplayChar(unsigned int ln, unsigned int col, * @param[in] col column number * @param[in] fi font index (0 = 9x15) * @param[in] s pointer to string - * @return none */ void GLCD_DisplayString(unsigned int ln, unsigned int col, unsigned char fi, char *s); @@ -115,7 +108,6 @@ void GLCD_DisplayString(unsigned int ln, unsigned int col, * @param[in] w: window width in pixels * @param[in] h: window height in pixels * @param[in] color box color - * @return none */ void GLCD_Box(unsigned int x, unsigned int y, unsigned int w, unsigned int h, diff --git a/source/application/hal/platforms/native/data_presentation/log/include/log.h b/source/application/hal/platforms/native/data_presentation/log/include/log.h index 10cf303..9b9928f 100644 --- a/source/application/hal/platforms/native/data_presentation/log/include/log.h +++ b/source/application/hal/platforms/native/data_presentation/log/include/log.h @@ -50,6 +50,7 @@ int log_display_image(uint8_t* data, const uint32_t width, * @param[in] str_sz Length of the string. * @param[in] pos_x Screen position x co-ordinate. * @param[in] pos_y Screen position y co-ordinate. + * @param[in] allow_multiple_lines Specifies if multiple lines are allowed. * @return 0 if successful, non-zero otherwise. **/ int log_display_text(const char* str, const size_t str_sz, |