docs: add macro hints for typegen to paper over weird interfaces

This commit is contained in:
outfoxxed 2024-02-26 00:30:25 -08:00
parent c0faebc700
commit 0034edd0f8
Signed by: outfoxxed
GPG key ID: 4C88A185FB89301E
4 changed files with 24 additions and 9 deletions

11
src/core/doc.hpp Normal file
View file

@ -0,0 +1,11 @@
#pragma once
// hide a property, function, or signal from typegen
#define QSDOC_HIDE
// override the base class as seen by typegen
#define QSDOC_BASECLASS(baseclass)
// make the type visible in the docs even if not a QML_ELEMENT
#define QSDOC_ELEMENT
#define QSDOC_NAMED_ELEMENT(name)

View file

@ -2,6 +2,7 @@
#include <qtmetamacros.h>
#include "doc.hpp"
#include "windowinterface.hpp"
class Anchors {
@ -94,6 +95,7 @@ Q_ENUM_NS(Enum);
/// }
/// ```
class PanelWindowInterface: public WindowInterface {
QSDOC_NAMED_ELEMENT(PanelWindow);
// clang-format off
Q_OBJECT;
/// Anchors attach a shell window to the sides of the screen.