language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-10-01 14:21:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

docs: add missing \a commands for arguments

Browse source
This commit is contained in:
Simon Hausmann 2021-06-24 16:43:36 +02:00
parent 376ed43544
commit d9857a3308
2 changed files with 7 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

6
api/sixtyfps-cpp/include/sixtyfps_color.h
View file

@ -136,15 +136,15 @@ public:
inline Color brighter(float factor) const;
inline Color darker(float factor) const;
/// Returns true if \a lhs has the same values for the individual color channels as \rhs; false
/// otherwise.
/// Returns true if \a lhs has the same values for the individual color channels as \a rhs;
/// false otherwise.
friend bool operator==(const Color &lhs, const Color &rhs)
{
return lhs.inner.red == rhs.inner.red && lhs.inner.green == rhs.inner.green
&& lhs.inner.blue == rhs.inner.blue && lhs.inner.alpha == rhs.inner.alpha;
}
/// Returns true if \a lhs has any different values for the individual color channels as \rhs;
/// Returns true if \a lhs has any different values for the individual color channels as \a rhs;
/// false otherwise.
friend bool operator!=(const Color &lhs, const Color &rhs) { return !(lhs == rhs); }

11
api/sixtyfps-cpp/include/sixtyfps_string.h
View file

@ -54,7 +54,7 @@ struct SharedString
cbindgen_private::sixtyfps_shared_string_clone(this, &other);
return *this;
}
/// Assigns the string view \s to this string and returns a reference to this string.
/// Assigns the string view \a s to this string and returns a reference to this string.
/// The underlying string data is copied. It is assumed that the string is UTF-8 encoded.
SharedString &operator=(std::string_view s)
{
@ -65,10 +65,7 @@ struct SharedString
/// Assigns null-terminated string pointer \a s to this string and returns a reference
/// to this string. The underlying string data is copied. It is assumed that the string
/// is UTF-8 encoded.
SharedString &operator=(const char *s)
{
return *this = std::string_view(s);
}
SharedString &operator=(const char *s) { return *this = std::string_view(s); }
/// Move-assigns \a other to this SharedString instance.
SharedString &operator=(SharedString &&other)
@ -123,12 +120,12 @@ struct SharedString
/// \endcode
static SharedString from_number(double n) { return SharedString(n); }
/// Returns true if \a is equal to \b; otherwise returns false.
/// Returns true if \a a is equal to \a b; otherwise returns false.
friend bool operator==(const SharedString &a, const SharedString &b)
{
return std::string_view(a) == std::string_view(b);
}
/// Returns true if \a is not equal to \b; otherwise returns false.
/// Returns true if \a a is not equal to \a b; otherwise returns false.
friend bool operator!=(const SharedString &a, const SharedString &b)
{
return std::string_view(a) != std::string_view(b);