language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-08-04 18:58:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

C++ docs: don't use backtick for Class or method name

Browse source 
because otherwise doxygen don't make links

(also implements the `renderer()` funciton in the doc example)
This commit is contained in:
Olivier Goffart 2023-08-22 11:29:57 +02:00
parent 3e46680c16
commit f611091470
1 changed files with 8 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

15
api/cpp/include/slint-platform.h
View file

@ -27,9 +27,9 @@ namespace slint {
/// Use the types in this namespace when implementing a custom Slint platform.
///
/// Slint comes with built-in support for different windowing systems, called backends. A backend
/// is a module that implements the `Platform` interface in this namespace, interacts with a
/// is a module that implements the Platform interface in this namespace, interacts with a
/// windowing system, and uses one of Slint's renderers to display a scene to the windowing system.
/// A typical Slint application uses one of the built-in backends. Implement your own `Platform` if
/// A typical Slint application uses one of the built-in backends. Implement your own Platform if
/// you're using Slint in an environment without a windowing system, such as with microcontrollers,
/// or you're embedding a Slint UI as plugin in other applications.
///
@ -38,8 +38,8 @@ namespace slint {
/// - https://github.com/slint-ui/slint/tree/master/examples/cpp/platform_qt
/// - https://github.com/slint-ui/slint/blob/master/api/cpp/esp-idf/slint/src/slint-esp.cpp
///
/// The entry point to re-implement a platform is the `Platform` class. Derive
/// from `slint::platform::Platform`, and call `slint::platform::set_platform`
/// The entry point to re-implement a platform is the Platform class. Derive
/// from slint::platform::Platform, and call slint::platform::set_platform
/// to set it as the Slint platform.
///
/// Another important class to subclass is the WindowAdapter.
@ -48,7 +48,7 @@ namespace platform {
/// Internal interface for a renderer for use with the WindowAdapter.
///
/// This class is not intended to be re-implemented. In places where this class is required, use
/// of one the existing implementations such as `SoftwareRenderer` or `SkiaRenderer`.
/// of one the existing implementations such as SoftwareRenderer or SkiaRenderer.
class AbstractRenderer
{
private:
@ -69,8 +69,8 @@ private:
///
/// Re-implement this class to establish the link between the two.
///
/// Your WindowAdapter subclass must hold a renderer (either a
/// SoftwareRenderer or a SkiaRenderer). In the renderer() method, you must return a
/// Your WindowAdapter subclass must hold a renderer (either a SoftwareRenderer or a SkiaRenderer).
/// In the renderer() method, you must return a
/// reference to it.
///
/// # Example
@ -83,6 +83,7 @@ private:
/// slint::PhysicalSize physical_size() const override {
/// return slint::PhysicalSize({m_native_window.width, m_native_window.height});
/// }
/// slint::platform::AbstractRenderer &renderer() override { return m_renderer; }
/// void set_visible(bool v) override {
/// if (v) {
/// window().dispatch_resize_event(slint::LogicalSize(