Small doc fixes (\See -> \see)

This commit is contained in:
Greg Ercolano 2024-08-12 18:31:05 -07:00
parent f825fca43c
commit 85d1d904ec
2 changed files with 6 additions and 11 deletions

View File

@ -1173,18 +1173,13 @@ public:
// API: Show unknown/invalid utf8/ANSI sequences with an error character (¿). // API: Show unknown/invalid utf8/ANSI sequences with an error character (¿).
bool show_unknown(void) const; bool show_unknown(void) const;
void show_unknown(bool val); void show_unknown(bool val);
/// Sets the "error character" utf8 string shown for invalid utf8
/** Sets the "error character" utf8 string shown for invalid utf8 /// or bad ANSI sequences if show_unknown() is true. Default: "¿".
or bad ANSI sequences if show_unknown() is true. Default: "¿". /// \see show_unknown(bool)
\See show_unknown(bool)
*/
void error_char(const char* val) { error_char_ = val; } void error_char(const char* val) { error_char_ = val; }
/// Returns the "error character" utf8 string, which is shown for invalid utf8
/** Returns the "error character" utf8 string, which is shown for invalid utf8 /// or bad ANSI sequences if show_unknown() is true. \see show_unknown(bool)
or bad ANSI sequences if show_unknown() is true. \See show_unknown(bool)
*/
const char* error_char(void) const { return error_char_; } const char* error_char(void) const { return error_char_; }
public:
// API: ANSI sequences // API: ANSI sequences
bool ansi(void) const; bool ansi(void) const;
void ansi(bool val); void ansi(bool val);

View File

@ -4047,7 +4047,7 @@ void Fl_Terminal::redraw_rate(float val) {
/** /**
Return the "show unknown" flag. Return the "show unknown" flag.
\See show_unknown(bool), error_char(const char*). \see show_unknown(bool), error_char(const char*).
*/ */
bool Fl_Terminal::show_unknown(void) const { bool Fl_Terminal::show_unknown(void) const {
return show_unknown_; return show_unknown_;