readline: improve doxygen comments

This commit is contained in:
Thomas Bernard
2018-07-12 13:59:43 +02:00
parent b75ca3e58f
commit 11b2b609ed
2 changed files with 63 additions and 24 deletions

View File

@@ -42,7 +42,8 @@ enum INPUT_TYPE
/// @param visible_size Number of characters visible and editable.
/// @param input_type one of enum ::INPUT_TYPE
/// @return 0 if user cancelled (esc), 1 if accepted (return)
byte Readline(word x_pos,word y_pos,char * str,byte visible_size,byte input_type);
byte Readline(word x_pos, word y_pos, char * str, byte visible_size,
enum INPUT_TYPE input_type);
///
/// Lets the user input a line of text, exit by Esc or Return.
@@ -54,9 +55,26 @@ byte Readline(word x_pos,word y_pos,char * str,byte visible_size,byte input_type
/// @param input_type one of enum ::INPUT_TYPE
/// @param decimal_places Number of decimal places (used only with decimal type)
/// @return 0 if user cancelled (esc), 1 if accepted (return)
byte Readline_ex(word x_pos,word y_pos,char * str,byte visible_size,byte max_size, byte input_type, byte decimal_places);
byte Readline_ex(word x_pos, word y_pos, char * str,
byte visible_size, byte max_size,
enum INPUT_TYPE input_type, byte decimal_places);
byte Readline_ex_unicode(word x_pos,word y_pos,char * str, word * unicode_str, byte visible_size,byte max_size, byte input_type, byte decimal_places);
///
/// Lets the user input a line of text, exit by Esc or Return.
/// @param x_pos, y_pos Coordinates of input, in window coordinates before scaling.
/// @param str The original string value. Will be modified,
/// unless user cancels or @p unicode_str is not NULL.
/// @param unicode_str The original unicode string value or NULL for ANSI editing.
/// Will be modified if not NULL, unless user cancels.
/// @param visible_size Number of characters visible.
/// @param max_size Number of characters editable.
/// @param input_type one of enum ::INPUT_TYPE
/// @param decimal_places Number of decimal places (used only with decimal type)
/// @return 0 : user cancelled (esc)
/// @return 1 : user accepted (return)
byte Readline_ex_unicode(word x_pos, word y_pos, char * str, word * unicode_str,
byte visible_size, byte max_size,
enum INPUT_TYPE input_type, byte decimal_places);
///
/// Converts a double to string.