aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/gfile/sys_defs.h2
-rw-r--r--src/gos/sys_options.h13
-rw-r--r--src/gwin/frame.h5
-rw-r--r--src/gwin/gimage.h2
4 files changed, 17 insertions, 5 deletions
diff --git a/src/gfile/sys_defs.h b/src/gfile/sys_defs.h
index 4280f7fe..0c5bac0c 100644
--- a/src/gfile/sys_defs.h
+++ b/src/gfile/sys_defs.h
@@ -73,7 +73,7 @@ extern "C" {
/**
* @brief Get the size of a file
- * @note Please use @p gfileGetSize() if the file is not opened
+ * @note Please use @p gfileGetSize() if the file is opened
*
* @param[in] fname The file name
*
diff --git a/src/gos/sys_options.h b/src/gos/sys_options.h
index cfbed057..c7376878 100644
--- a/src/gos/sys_options.h
+++ b/src/gos/sys_options.h
@@ -75,6 +75,19 @@
#ifndef GFX_FREERTOS_USE_TRACE
#define GFX_FREERTOS_USE_TRACE FALSE
#endif
+ /**
+ * @brief How much RAM should uGFX use for the heap
+ * @details Defaults to 0. Only valid with GFX_USE_OS_RAW32
+ * @note If 0 then the standard C runtime malloc(), free() and realloc()
+ * are used.
+ * @note If it is non-zero then this is the number of bytes of RAM
+ * to use for the heap (gfxAlloc() and gfxFree()). No C
+ * runtime routines will be used and a new routine @p gfxAddHeapBlock()
+ * is added allowing the user to add extra memory blocks to the heap.
+ */
+ #ifndef GOS_RAW_HEAP_SIZE
+ #define GOS_RAW_HEAP_SIZE 0
+ #endif
/** @} */
#endif /* _GOS_OPTIONS_H */
diff --git a/src/gwin/frame.h b/src/gwin/frame.h
index bf7cd2d8..fc5daf8e 100644
--- a/src/gwin/frame.h
+++ b/src/gwin/frame.h
@@ -45,8 +45,7 @@ typedef struct GFrameObject {
/**
* @brief Create a frame widget
*
- * @details This widget provides a window like we know it from desktop systems. You usually use this together with
- * gwinAddChild().
+ * @details This widget provides a window like we know it from desktop systems.
*
* @param[in] g The GDisplay to display this window on
* @param[in] fo The GFrameObject structure to initialize. If this is NULL the structure is dynamically allocated.
@@ -54,7 +53,7 @@ typedef struct GFrameObject {
* @param[in] flags Some flags, see notes.
*
* @note Possible flags are: GWIN_FRAME_BORDER, GWIN_FRAME_CLOSE_BTN, GWIN_FRAME_MINMAX_BTN.
- * Whether the close or the minimize maximize buttons are used, the boarder is automatically invoked.
+ * When the close or the minimize/maximize buttons are used, the boarder is automatically invoked.
* @note These frame buttons are processed internally. The close button will invoke a gwinDestroy() which will
* destroy the window itself and EVERY child it contains (also children of children).
*
diff --git a/src/gwin/gimage.h b/src/gwin/gimage.h
index 670a9ec4..0052f024 100644
--- a/src/gwin/gimage.h
+++ b/src/gwin/gimage.h
@@ -9,7 +9,7 @@
* @file src/gwin/gimage.h
* @brief GWIN image widget header file.
*
- * @defgroup Image Image
+ * @defgroup ImageBox ImageBox
* @ingroup Widgets
*
* @details GWIN allos it to create an image widget. The widget