1 files changed, 91 insertions, 0 deletions
diff --git a/src/input/q3dkeyevent.cpp b/src/input/q3dkeyevent.cpp
index c0de3a293..bb1990955 100644
--- a/src/input/q3dkeyevent.cpp
+++ b/src/input/q3dkeyevent.cpp
@@ -42,6 +42,22 @@ namespace Qt3D {
 
 //Qt6: Move this into a QtQmlGui module and merge it with QQuickKeyEvent
 
+/*!
+    \class Qt3D::Q3DKeyEvent
+    \inmodule Qt3DInput
+    \since 5.5
+*/
+
+/*!
+    \qmltype KeyEvent
+    \inqmlmodule Qt3D.Input
+    \instantiates Qt3D::Q3DKeyEvent
+    \since 5.5
+
+    The KeyEvent QML type cannot be directly created. Objects of this type
+    are used as signal parameters in KeyboardInput.
+*/
+
 Q3DKeyEvent::Q3DKeyEvent(QEvent::Type type, int key, Qt::KeyboardModifiers modifiers, const QString &text, bool autorep, ushort count)
     : QObject()
     , m_event(type, key, modifiers, text, autorep, count)
@@ -56,6 +72,81 @@ Q3DKeyEvent::Q3DKeyEvent(const QKeyEvent &ke)
     m_event.setAccepted(false);
 }
 
+/*!
+    \qmlproperty int Qt3D.Input::KeyEvent::key
+    \readonly
+
+    This property holds the code of the key that was pressed or released.
+
+    See \l [CPP] {Qt::Key}{Qt.Key} for the list of keyboard codes.
+
+    \sa {QtQuick::KeyEvent::key}{KeyEvent.key}
+*/
+
+/*!
+    \qmlproperty string Qt3D.Input::KeyEvent::text
+    \readonly
+
+    This property holds the Unicode text that the key generated. The text
+    returned can be an empty string in cases where modifier keys, such as
+    Shift, Control, Alt, and Meta, are being pressed or released. In such
+    cases \l key will contain a valid value.
+*/
+
+/*!
+    \qmlproperty int Qt3D.Input::KeyEvent::modifiers
+    \readonly
+
+    This property holds the keyboard modifier flags that existed immediately
+    before the event occurred.
+
+    \sa {QtQuick::KeyEvent::modifiers}{KeyEvent.modifiers}
+*/
+
+/*!
+    \qmlproperty bool Qt3D.Input::KeyEvent::isAutoRepeat
+    \readonly
+
+    Holds whether this event comes from an auto-repeating key.
+*/
+
+/*!
+    \qmlproperty int Qt3D.Input::KeyEvent::count
+    \readonly
+
+    Holds the number of keys involved in this event. If \l text is not empty,
+    this is simply the length of the string.
+*/
+
+/*!
+    \qmlproperty quint32 Qt3D.Input::KeyEvent::nativeScanCodei
+    \readonly
+
+    This property contains the native scan code of the key that was pressed.
+    It is passed through from QKeyEvent unchanged.
+
+    \sa QKeyEvent::nativeScanCode()
+*/
+
+/*!
+    \qmlproperty bool Qt3D.Input::KeyEvent::accepted
+
+    Setting \e accepted to \c true prevents the key event from being propagated
+    to the item's parent.
+
+    Generally, if the item acts on the key event then it should be accepted so
+    that ancestor items do not also respond to the same event.
+*/
+
+/*!
+    \qmlmethod bool Qt3D.Input::KeyEvent::matches(StandardKey key)
+
+    Returns \c true if the key event matches the given standard key; otherwise
+    returns \c false.
+
+    \sa QKeySequence::StandardKey
+*/
+
 } // Qt3D
 
 QT_END_NAMESPACE