From 612598acd7b8d6a75dfb60ed3487bf5342b4f586 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 15 Dec 2020 12:30:00 +1100 Subject: Cleanup: doxy comments (use colon after parameter name) Also remove colon after `\note`. --- intern/ghost/GHOST_C-api.h | 2 +- intern/ghost/intern/GHOST_SystemCocoa.mm | 6 +++--- intern/ghost/intern/GHOST_SystemWin32.cpp | 9 ++++----- intern/ghost/intern/GHOST_WindowWayland.cpp | 2 +- 4 files changed, 9 insertions(+), 10 deletions(-) (limited to 'intern') diff --git a/intern/ghost/GHOST_C-api.h b/intern/ghost/GHOST_C-api.h index 64740b68c0c..2bc73f7eb22 100644 --- a/intern/ghost/GHOST_C-api.h +++ b/intern/ghost/GHOST_C-api.h @@ -1052,7 +1052,7 @@ int GHOST_XrSessionIsRunning(const GHOST_XrContextHandle xr_context); /** * Check if \a xr_context has a session that requires an upside-down frame-buffer (compared to * OpenGL). If true, the render result should be flipped vertically for correct output. - * \note: Only to be called after session start, may otherwise result in a false negative. + * \note Only to be called after session start, may otherwise result in a false negative. */ int GHOST_XrSessionNeedsUpsideDownDrawing(const GHOST_XrContextHandle xr_context); diff --git a/intern/ghost/intern/GHOST_SystemCocoa.mm b/intern/ghost/intern/GHOST_SystemCocoa.mm index 6ec6bc78d45..d7dbfbe8813 100644 --- a/intern/ghost/intern/GHOST_SystemCocoa.mm +++ b/intern/ghost/intern/GHOST_SystemCocoa.mm @@ -82,8 +82,8 @@ static GHOST_TButtonMask convertButton(int button) /** * Converts Mac rawkey codes (same for Cocoa & Carbon) * into GHOST key codes - * \param rawCode The raw physical key code - * \param recvChar the character ignoring modifiers (except for shift) + * \param rawCode: The raw physical key code + * \param recvChar: the character ignoring modifiers (except for shift) * \return Ghost key code */ static GHOST_TKey convertKey(int rawCode, unichar recvChar, UInt16 keyAction) @@ -783,7 +783,7 @@ GHOST_IContext *GHOST_SystemCocoa::createOffscreenContext(GHOST_GLSettings glSet /** * Dispose of a context. - * \param context Pointer to the context to be disposed. + * \param context: Pointer to the context to be disposed. * \return Indication of success. */ GHOST_TSuccess GHOST_SystemCocoa::disposeContext(GHOST_IContext *context) diff --git a/intern/ghost/intern/GHOST_SystemWin32.cpp b/intern/ghost/intern/GHOST_SystemWin32.cpp index 8178b9bdf1e..4d4083cf229 100644 --- a/intern/ghost/intern/GHOST_SystemWin32.cpp +++ b/intern/ghost/intern/GHOST_SystemWin32.cpp @@ -422,7 +422,7 @@ finished: /** * Dispose of a context. - * \param context Pointer to the context to be disposed. + * \param context: Pointer to the context to be disposed. * \return Indication of success. */ GHOST_TSuccess GHOST_SystemWin32::disposeContext(GHOST_IContext *context) @@ -2093,10 +2093,9 @@ GHOST_TSuccess GHOST_SystemWin32::showMessageBox(const char *title, config.cbSize = sizeof(config); config.hInstance = 0; config.dwCommonButtons = 0; - config.pszMainIcon = (dialog_options & GHOST_DialogError ? - TD_ERROR_ICON : - dialog_options & GHOST_DialogWarning ? TD_WARNING_ICON : - TD_INFORMATION_ICON); + config.pszMainIcon = (dialog_options & GHOST_DialogError ? TD_ERROR_ICON : + dialog_options & GHOST_DialogWarning ? TD_WARNING_ICON : + TD_INFORMATION_ICON); config.pszWindowTitle = L"Blender"; config.pszMainInstruction = title_16; config.pszContent = message_16; diff --git a/intern/ghost/intern/GHOST_WindowWayland.cpp b/intern/ghost/intern/GHOST_WindowWayland.cpp index fe65162d168..1e1d0814d3a 100644 --- a/intern/ghost/intern/GHOST_WindowWayland.cpp +++ b/intern/ghost/intern/GHOST_WindowWayland.cpp @@ -407,7 +407,7 @@ void GHOST_WindowWayland::setOpaque() const #endif /** - * \param type The type of rendering context create. + * \param type: The type of rendering context create. * \return Indication of success. */ GHOST_Context *GHOST_WindowWayland::newDrawingContext(GHOST_TDrawingContextType type) -- cgit v1.2.3