diff --git a/Doxygenfile b/Doxygenfile index 047de14f..d5efd353 100644 --- a/Doxygenfile +++ b/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 diff --git a/src/gdisp/gdisp_pixmap.h b/src/gdisp/gdisp_pixmap.h index e933a550..b9aa958e 100644 --- a/src/gdisp/gdisp_pixmap.h +++ b/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. */ diff --git a/src/ginput/ginput.c b/src/ginput/ginput.c index becefc19..cf6377cf 100644 --- a/src/ginput/ginput.c +++ b/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 diff --git a/src/ginput/ginput_keyboard_microcode.c b/src/ginput/ginput_keyboard_microcode.c index e3c04d5f..167ed5a4 100644 --- a/src/ginput/ginput_keyboard_microcode.c +++ b/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. */ diff --git a/src/ginput/ginput_keyboard_microcode.h b/src/ginput/ginput_keyboard_microcode.h index c18e94e5..094d2802 100644 --- a/src/ginput/ginput_keyboard_microcode.h +++ b/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. */ diff --git a/src/gwin/gwin.c b/src/gwin/gwin.c index eb51b89a..5879e895 100644 --- a/src/gwin/gwin.c +++ b/src/gwin/gwin.c @@ -6,7 +6,7 @@ */ /** - * @file src/gwin/gwin_gwin.c + * @file src/gwin/gwin.c * @brief GWIN sub-system code */