Browse Source

Doxygen improvements

remotes/origin/master
Joel Bodenmann 6 months ago
parent
commit
df7027881a
  1. 10
      Doxygenfile
  2. 1
      src/ginput/ginput_mouse.c
  3. 2
      src/gos/gos_win32.c
  4. 1
      src/gos/gos_zephyr.h
  5. 2
      src/gwin/gwin.c
  6. 1
      src/gwin/gwin_class.h
  7. 7
      src/gwin/gwin_container.c
  8. 1
      src/gwin/gwin_keyboard_layout.h
  9. 2
      src/gwin/gwin_widget.c
  10. 1
      src/gwin/gwin_wm.c

10
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 <b>I-Class</b> 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 <b>S-Class</b> 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 <b>I-Class</b> 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 <b>S-Class</b> 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

1
src/ginput/ginput_mouse.c

@ -833,4 +833,3 @@ void _gmouseWakeupI(GMouse *m) {
}
#endif /* GFX_USE_GINPUT && GINPUT_NEED_MOUSE */
/** @} */

2
src/gos/gos_win32.c

@ -127,5 +127,3 @@ gThreadreturn gfxThreadWait(gThread thread) {
}
#endif /* GFX_USE_OS_WIN32 */
/** @} */

1
src/gos/gos_zephyr.h

@ -90,4 +90,3 @@ gTicks gfxSystemTicks();
#endif /* GFX_USE_OS_ZEPHYR */
#endif /* _GOS_H */
/** @} */

2
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 */
/** @} */

1
src/gwin/gwin_class.h

@ -445,4 +445,3 @@ gBool _gwinWMAdd(GHandle gh, const GWindowInit *pInit);
#endif /* GFX_USE_GWIN */
#endif /* _CLASS_GWIN_H */
/** @} */

7
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 */
/** @} */

1
src/gwin/gwin_keyboard_layout.h

@ -66,4 +66,3 @@ typedef struct GVKeyTable {
} GVKeyTable;
#endif /* _GWIN_KEYBOARD_LAYOUT_H */
/** @} */

2
src/gwin/gwin_widget.c

@ -747,5 +747,5 @@ gBool gwinAttachListener(GListener *pl) {
#undef gw
#undef wvmt
#endif /* GFX_USE_GWIN && GWIN_NEED_WIDGET */
/** @} */

1
src/gwin/gwin_wm.c

@ -1029,4 +1029,3 @@ static void WM_Raise(GHandle gh) {
}
#endif /* GFX_USE_GWIN && GWIN_NEED_WINDOWMANAGER */
/** @} */
Loading…
Cancel
Save