Add class documentation comments to mir::Decorations

Co-authored-by: Alan Griffiths <[email protected]>
canonical · Jul 3, 2024 · 2aeb440 · 2aeb440
1 parent cdfc15c
commit 2aeb440
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/include/miral/miral/decorations.h b/include/miral/miral/decorations.h
@@ -24,6 +24,9 @@ namespace mir { class Server; }
 
 namespace miral
 {
+/// Configures the window decoration strategy.
+/// \note The strategy can only be applied to clients that are able to negotiate the decoration style with the server.
+/// \remark Since MirAL 5.1
 class Decorations
 {
 public: