From df7027881ae90343adb231361e235c506b53b939 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Tue, 13 Apr 2021 18:32:47 +0200 Subject: [PATCH] Doxygen improvements --- Doxygenfile | 10 +++++----- src/ginput/ginput_mouse.c | 1 - src/gos/gos_win32.c | 2 -- src/gos/gos_zephyr.h | 1 - src/gwin/gwin.c | 2 -- src/gwin/gwin_class.h | 1 - src/gwin/gwin_container.c | 7 ++++--- src/gwin/gwin_keyboard_layout.h | 1 - src/gwin/gwin_widget.c | 2 +- src/gwin/gwin_wm.c | 1 - 10 files changed, 10 insertions(+), 18 deletions(-) diff --git a/Doxygenfile b/Doxygenfile index 6511830d..be10f2d8 100644 --- a/Doxygenfile +++ b/Doxygenfile @@ -269,11 +269,11 @@ TAB_SIZE = 4 # commands \{ and \} for these it is advised to use the version @{ and @} or use # a double escape (\\{ and \\}) -ALIASES = "iclass=@par Function Class:\n This is an I-Class API, this function can be invoked from within a system lock zone by both threads and interrupt handlers." \ - "sclass=@par Function Class:\n This is an S-Class API, this function can be invoked from within a system lock zone by threads only." \ - "api=@par Function Class:\n Normal API, this function can be invoked by regular system threads." \ - "notapi=@par Function Class:\n Not an API, this function is for internal use only." \ - "isr=@par Function Class:\n Interrupt handler, this function should not be directly invoked." +ALIASES = "iclass=@par Function Class: This is an I-Class API, this function can be invoked from within a system lock zone by both threads and interrupt handlers." \ + "sclass=@par Function Class: This is an S-Class API, this function can be invoked from within a system lock zone by threads only." \ + "api=@par Function Class: Normal API, this function can be invoked by regular system threads." \ + "notapi=@par Function Class: Not an API, this function is for internal use only." \ + "isr=@par Function Class: Interrupt handler, this function should not be directly invoked." # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For diff --git a/src/ginput/ginput_mouse.c b/src/ginput/ginput_mouse.c index 72292c89..6d08e1f3 100644 --- a/src/ginput/ginput_mouse.c +++ b/src/ginput/ginput_mouse.c @@ -833,4 +833,3 @@ void _gmouseWakeupI(GMouse *m) { } #endif /* GFX_USE_GINPUT && GINPUT_NEED_MOUSE */ -/** @} */ diff --git a/src/gos/gos_win32.c b/src/gos/gos_win32.c index da27ce10..bd9dd481 100644 --- a/src/gos/gos_win32.c +++ b/src/gos/gos_win32.c @@ -127,5 +127,3 @@ gThreadreturn gfxThreadWait(gThread thread) { } #endif /* GFX_USE_OS_WIN32 */ -/** @} */ - diff --git a/src/gos/gos_zephyr.h b/src/gos/gos_zephyr.h index 55ef1e35..3213d5ca 100644 --- a/src/gos/gos_zephyr.h +++ b/src/gos/gos_zephyr.h @@ -90,4 +90,3 @@ gTicks gfxSystemTicks(); #endif /* GFX_USE_OS_ZEPHYR */ #endif /* _GOS_H */ -/** @} */ diff --git a/src/gwin/gwin.c b/src/gwin/gwin.c index 5c0fd9ae..cf45c3e0 100644 --- a/src/gwin/gwin.c +++ b/src/gwin/gwin.c @@ -414,5 +414,3 @@ void gwinBlitArea(GHandle gh, gCoord x, gCoord y, gCoord cx, gCoord cy, gCoord s #endif #endif /* GFX_USE_GWIN */ -/** @} */ - diff --git a/src/gwin/gwin_class.h b/src/gwin/gwin_class.h index 05a4bbf4..8ad884f7 100644 --- a/src/gwin/gwin_class.h +++ b/src/gwin/gwin_class.h @@ -445,4 +445,3 @@ gBool _gwinWMAdd(GHandle gh, const GWindowInit *pInit); #endif /* GFX_USE_GWIN */ #endif /* _CLASS_GWIN_H */ -/** @} */ diff --git a/src/gwin/gwin_container.c b/src/gwin/gwin_container.c index 6bc2b655..88c6d8b1 100644 --- a/src/gwin/gwin_container.c +++ b/src/gwin/gwin_container.c @@ -72,7 +72,6 @@ gCoord gwinGetInnerHeight(GHandle gh) { } #endif /* GFX_USE_GWIN && GWIN_NEED_CONTAINERS */ -/** @} */ /*----------------------------------------------- * The simplest container type - a container @@ -201,6 +200,8 @@ void gwinContainerDraw_Std(GWidgetObject *gw, void *param) { #undef gi } -#endif +#endif /* GDISP_NEED_IMAGE */ -#endif +#endif /* GFX_USE_GWIN && GWIN_NEED_CONTAINERS */ + +/** @} */ diff --git a/src/gwin/gwin_keyboard_layout.h b/src/gwin/gwin_keyboard_layout.h index b35bd139..1a42458c 100644 --- a/src/gwin/gwin_keyboard_layout.h +++ b/src/gwin/gwin_keyboard_layout.h @@ -66,4 +66,3 @@ typedef struct GVKeyTable { } GVKeyTable; #endif /* _GWIN_KEYBOARD_LAYOUT_H */ -/** @} */ diff --git a/src/gwin/gwin_widget.c b/src/gwin/gwin_widget.c index 94b9dd33..08af9ccf 100644 --- a/src/gwin/gwin_widget.c +++ b/src/gwin/gwin_widget.c @@ -747,5 +747,5 @@ gBool gwinAttachListener(GListener *pl) { #undef gw #undef wvmt + #endif /* GFX_USE_GWIN && GWIN_NEED_WIDGET */ -/** @} */ diff --git a/src/gwin/gwin_wm.c b/src/gwin/gwin_wm.c index ed3839be..a1cd8ea8 100644 --- a/src/gwin/gwin_wm.c +++ b/src/gwin/gwin_wm.c @@ -1029,4 +1029,3 @@ static void WM_Raise(GHandle gh) { } #endif /* GFX_USE_GWIN && GWIN_NEED_WINDOWMANAGER */ -/** @} */