diff options
| author | Joel Bodenmann <joel@seriouslyembedded.com> | 2015-05-16 20:17:50 +0200 |
|---|---|---|
| committer | Joel Bodenmann <joel@seriouslyembedded.com> | 2015-05-16 20:17:50 +0200 |
| commit | 37ab4ec1cda779491905ce27b40e16bb43defb71 (patch) | |
| tree | df28120b24f987169546f21ffcfd275b74a8626b /src/gdisp | |
| parent | 4e8446951526f635a1a6257d4a8b7fe8c9158f4f (diff) | |
| download | uGFX-37ab4ec1cda779491905ce27b40e16bb43defb71.tar.gz uGFX-37ab4ec1cda779491905ce27b40e16bb43defb71.tar.bz2 uGFX-37ab4ec1cda779491905ce27b40e16bb43defb71.zip | |
Fixing doxygen
Diffstat (limited to 'src/gdisp')
| -rw-r--r-- | src/gdisp/gdisp_pixmap.h | 6 |
1 files changed, 5 insertions, 1 deletions
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. */ |