Browse Source

Fixing doxygen

remotes/origin_old/ugfx_release_2.6
Joel Bodenmann 7 years ago
parent
commit
37ab4ec1cd
  1. 4
      Doxygenfile
  2. 6
      src/gdisp/gdisp_pixmap.h
  3. 2
      src/ginput/ginput.c
  4. 2
      src/ginput/ginput_keyboard_microcode.c
  5. 2
      src/ginput/ginput_keyboard_microcode.h
  6. 2
      src/gwin/gwin.c

4
Doxygenfile

@ -38,13 +38,13 @@ PROJECT_NAME =
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 2.2
PROJECT_NUMBER = 2.3
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = "version 2.2"
PROJECT_BRIEF = "version 2.3"
# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
# the documentation. The maximum height of the logo should not exceed 55 pixels

6
src/gdisp/gdisp_pixmap.h

@ -33,6 +33,8 @@ extern "C" {
* @param[in] width The width of the pixmap to be created
* @param[in] height The height of the pixmap to be created
*
* @return The created GDisplay representing the pixmap
*
* @note Once created, an off-screen pixmap can be drawn on using the standard gdispGxxxx calls.
* @note It must be destroyed using @p gdispDeleteOffscreenPixmap
* @note Because the RAM for the display area is allocated, on small micros only very small pixmaps should be considered.
@ -70,7 +72,9 @@ extern "C" {
*
* @param[in] g The pixmap virtual display
*
* @note The pointer returned can be passed to @p gdispImageOpenMemory() or to @gfileOpenMemory().
* @return The pointer to the native gdispImage
*
* @note The pointer returned can be passed to @p gdispImageOpenMemory() or to @p gfileOpenMemory().
* @note If you are just wanting to copy to a real display it is more efficient to use @p gdispGetPixmapBits() and @p gdispGBlitArea().
* @note Like @p gdispGetPixmapBits(), the pointer returned is valid for the life of the pixmap.
*/

2
src/ginput/ginput.c

@ -6,7 +6,7 @@
*/
/**
* @file src/ginput/ginput_ginput.c
* @file src/ginput/ginput.c
* @brief GINPUT subsystem common code.
*
* @addtogroup GINPUT

2
src/ginput/ginput_keyboard_microcode.c

@ -6,7 +6,7 @@
*/
/**
* @file src/ginput/keyboard_microcode.c
* @file src/ginput/ginput_keyboard_microcode.c
* @brief GINPUT keyboard standard microcode definitions.
*/

2
src/ginput/ginput_keyboard_microcode.h

@ -6,7 +6,7 @@
*/
/**
* @file src/ginput/keyboard_microcode.h
* @file src/ginput/ginput_keyboard_microcode.h
* @brief GINPUT keyboard layout microcode definition.
*/

2
src/gwin/gwin.c

@ -6,7 +6,7 @@
*/
/**
* @file src/gwin/gwin_gwin.c
* @file src/gwin/gwin.c
* @brief GWIN sub-system code
*/

Loading…
Cancel
Save