Update NBGL documentation (Layout layer)

LedgerHQ · May 22, 2024 · f26446d · f26446d
1 parent 25f141f
commit f26446d
Show file tree

Hide file tree

Showing 24 changed files with 123 additions and 128 deletions.
diff --git a/Makefile b/Makefile
@@ -8,11 +8,13 @@ TARGET ?= stax
 NBGL_DEFINES_stax := \
  HAVE_SE_TOUCH \
  NBGL_PAGE \
- NBGL_QRCODE
+ NBGL_QRCODE \
+ SCREEN_SIZE_WALLET
 
 NBGL_DEFINES_nano := \
  NBGL_STEP \
- NBGL_FLOW
+ NBGL_FLOW \
+ SCREEN_SIZE_NANO
 
 NBGL_DEFINES := $(NBGL_DEFINES_$(TARGET))
 

diff --git a/lib_nbgl/doc/nbgl_layout.dox b/lib_nbgl/doc/nbgl_layout.dox
diff --git a/lib_nbgl/doc/resources/keyboard-usages.png b/lib_nbgl/doc/resources/keyboard-usages.png
diff --git a/lib_nbgl/doc/resources/keypad-usages.png b/lib_nbgl/doc/resources/keypad-usages.png
diff --git a/lib_nbgl/doc/resources/layout1.png b/lib_nbgl/doc/resources/layout1.png
diff --git a/lib_nbgl/doc/resources/layout10.png b/lib_nbgl/doc/resources/layout10.png
diff --git a/lib_nbgl/doc/resources/layout11.png b/lib_nbgl/doc/resources/layout11.png
diff --git a/lib_nbgl/doc/resources/layout12.png b/lib_nbgl/doc/resources/layout12.png
diff --git a/lib_nbgl/doc/resources/layout13.png b/lib_nbgl/doc/resources/layout13.png
diff --git a/lib_nbgl/doc/resources/layout15.png b/lib_nbgl/doc/resources/layout15.png
diff --git a/lib_nbgl/doc/resources/layout6.png b/lib_nbgl/doc/resources/layout6.png
diff --git a/lib_nbgl/doc/resources/layout8.png b/lib_nbgl/doc/resources/layout8.png
diff --git a/lib_nbgl/doc/resources/layout9.png b/lib_nbgl/doc/resources/layout9.png
diff --git a/lib_nbgl/doc/resources/layout_choice_buttons1.png b/lib_nbgl/doc/resources/layout_choice_buttons1.png
diff --git a/lib_nbgl/doc/resources/stax_layout1.png b/lib_nbgl/doc/resources/stax_layout1.png
diff --git a/lib_nbgl/doc/resources/stax_layout11.png b/lib_nbgl/doc/resources/stax_layout11.png
diff --git a/lib_nbgl/doc/resources/stax_layout13.png b/lib_nbgl/doc/resources/stax_layout13.png
diff --git a/lib_nbgl/doc/resources/stax_layout15.png b/lib_nbgl/doc/resources/stax_layout15.png
diff --git a/lib_nbgl/doc/resources/stax_layout6.png b/lib_nbgl/doc/resources/stax_layout6.png
diff --git a/lib_nbgl/doc/resources/stax_layout8.png b/lib_nbgl/doc/resources/stax_layout8.png
diff --git a/lib_nbgl/doc/resources/stax_layout9.png b/lib_nbgl/doc/resources/stax_layout9.png
diff --git a/lib_nbgl/src/nbgl_fonts.c b/lib_nbgl/src/nbgl_fonts.c
@@ -348,8 +348,6 @@ uint16_t nbgl_getSingleLineTextWidthInLen(nbgl_font_id_e fontId, const char *tex
  *
  * @param fontId font ID
  * @param text text in UTF8
- * @param nb_lines_ptr pointer to a variable that will contain the number of lines used (or NULL if
- * we don't care)
  * @return the width in pixels of the text
  */
 uint16_t nbgl_getTextWidth(nbgl_font_id_e fontId, const char *text)
@@ -1124,7 +1122,7 @@ void nbgl_textWrapOnNbLines(nbgl_font_id_e fontId, char *text, uint16_t maxWidth
  * @note the number of line must be odd
  *
  * @param fontId font ID
- * @param text (input) ASCII string, must be single line
+ * @param origText (input) ASCII string, must be single line
  * @param maxWidth maximum width in pixels
  * @param nbLines (input) number of lines to reduce the text to. The middle of the text is replaced
  * by ...

diff --git a/lib_nbgl/src/nbgl_layout_keypad.c b/lib_nbgl/src/nbgl_layout_keypad.c
@@ -161,7 +161,7 @@ int nbgl_layoutUpdateKeypad(nbgl_layout_t *layout,
  * @brief Adds a placeholder for hidden digits on top of a keypad, to represent the entered digits,
  * as full circles The placeholder is "underligned" with a thin horizontal line of the expected full
  * length
- * @deprecated Use @ref nbgl_layouAddKeypadContent instead
+ * @deprecated Use @ref nbgl_layoutAddKeypadContent instead
  *
  * @note It must be the last added object, after potential back key, title, and keypad. Vertical
  * positions of title and hidden digits will be computed here

diff --git a/lib_nbgl/src/nbgl_step.c b/lib_nbgl/src/nbgl_step.c
@@ -471,7 +471,7 @@ nbgl_step_t nbgl_stepDrawText(nbgl_stepPosition_t pos,
  * @param pos position of this step in the flow (first, last, single, not_first_nor_last)
  * @param onActionCallback common callback for all actions on this page
  * @param ticker ticker configuration, set to NULL to disable it
- * @param info all information about the cenetered info to be displayed
+ * @param info all information about the centered info to be displayed
  * @param modal if true, means this step shall be displayed on top of existing one
  * @return the step context (or NULL if error)
  */