fix-documentation (#3738)

Fix documentation to match the code
canonical · Feb 5, 2025 · 54f9716 · 54f9716
2 parents 3731379 + 1bdfc27
commit 54f9716
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 13 deletions.
diff --git a/doc/sphinx/how-to/how-to-handle-keyboard-input.md b/doc/sphinx/how-to/how-to-handle-keyboard-input.md
@@ -79,7 +79,7 @@ This big block of code can be broken down into three parts:
 +            case XKB_KEY_t:
 +            case XKB_KEY_T:
 +                external_client_launcher.launch({terminal_cmd});
-+                return false;
++                return true;
 +
 +            // Do nothing
 +            default:

diff --git a/include/common/mir_toolkit/events/input/input_event.h b/include/common/mir_toolkit/events/input/input_event.h
@@ -67,26 +67,26 @@ MirInputEventType mir_input_event_get_type(MirInputEvent const* event);
  * Retrieve the MirKeyboardEvent associated with a given input event.
  *
  * \param[in] event The input event
- * \return          The MirKeyboardEvent or NULL if event type is not 
- *                  mir_input_event_type_key
+ * \return          The MirKeyboardEvent
+ * \pre             The event type is mir_input_event_type_key
  */
 MirKeyboardEvent const* mir_input_event_get_keyboard_event(MirInputEvent const* event);
 
 /**
  * Retrieve the MirTouchEvent associated with a given input event.
  *
  * \param[in] event The input event
- * \return          The MirTouchEvent or NULL if event type is not 
- *                  mir_input_event_type_touch
+ * \return          The MirTouchEvent
+ * \pre             The event type is mir_input_event_type_touch
  */
 MirTouchEvent const* mir_input_event_get_touch_event(MirInputEvent const* event);
 
 /**
  * Retrieve the MirPointerEvent associated with a given input event.
  *
  * \param[in] event The input event
- * \return          The MirPointerEvent or NULL if event type is not 
- *                  mir_input_event_type_pointer
+ * \return          The MirPointerEvent
+ * \pre             The event type is mir_input_event_type_pointer
  */
 MirPointerEvent const* mir_input_event_get_pointer_event(MirInputEvent const* event);
 

diff --git a/include/miral/miral/toolkit_event.h b/include/miral/miral/toolkit_event.h
@@ -86,26 +86,26 @@ MirInputEventType mir_input_event_get_type(MirInputEvent const* event);
  * Retrieve the MirKeyboardEvent associated with a given input event.
  *
  * \param[in] event The input event
- * \return          The MirKeyboardEvent or NULL if event type is not
- *                  mir_input_event_type_key
+ * \return          The MirKeyboardEvent
+ * \pre             The event type is mir_input_event_type_key 
  */
 MirKeyboardEvent const* mir_input_event_get_keyboard_event(MirInputEvent const* event);
 
 /**
  * Retrieve the MirTouchEvent associated with a given input event.
  *
  * \param[in] event The input event
- * \return          The MirTouchEvent or NULL if event type is not
- *                  mir_input_event_type_touch
+ * \return          The MirTouchEvent
+ * \pre             The event type is mir_input_event_type_touch
  */
 MirTouchEvent const* mir_input_event_get_touch_event(MirInputEvent const* event);
 
 /**
  * Retrieve the MirPointerEvent associated with a given input event.
  *
  * \param[in] event The input event
- * \return          The MirPointerEvent or NULL if event type is not
- *                  mir_input_event_type_pointer
+ * \return          The MirPointerEvent
+ * \pre             The event type is mir_input_event_type_pointer
  */
 MirPointerEvent const* mir_input_event_get_pointer_event(MirInputEvent const* event);