Documentaton fixes

This commit is contained in:
Wayne Venables
2023-03-06 22:32:08 -08:00
parent bc34cf858d
commit 5ea720d635
9 changed files with 44 additions and 10 deletions

View File

@@ -13,16 +13,16 @@
/**
* @addtogroup CanvasGroup
* @brief Drawing board for shapes and images
* @details Canvas is a drawing board. It is a support library for working with graphical surfaces and images (see the canvas.h
* file in the _picovga\util folder). The sCanvas structure is a set of parameters that describe the graphical surface, for use
* @details Canvas is a drawing board. It is a support library for working with graphical surfaces and images.
* The sCanvas structure is a set of parameters that describe the graphical surface, for use
* in drawing functions. A graphical surface can be either a graphical frame buffer or an image, even in Flash. To draw in a
* graphical surface, first attach a canvas to it as a definition describing the structure of the area. Likewise, if you want
* to draw an image to the surface, first create a canvas for the image with its parameters. The parameters are a pointer to
* the image data, the image dimensions, and the format. The drawing area can be a graphic area with a depth of 1, 2, 4, 8 bits
* or with attributes. In the case of drawing an image to a canvas, the source and target canvas must have the same format.
* In the case of transformation matrices, only an 8-bit graphic format can be drawn.
* @note In PicoVGA, a default canvas 'Canvas' is available. A graphic frame buffer is automatically attached to it when
* initialized with the Video function. Otherwise, it can be used arbitrarily in the program.
* @note In PicoVGA, a default canvas @link Canvas @endlink is available. A graphic frame buffer is automatically attached to it when
* initialized with the Video() function. Otherwise, it can be used arbitrarily in the program.
* @{
*/

View File

@@ -15,7 +15,7 @@
* @details Some display functions may be CPU speed intensive and may require overclocking to a higher speed. It should be
* understood that overclocking places the processor in areas where proper function is not guaranteed. The PicoVGA library
* allows you to control the overclocking of the processor, according to the desired video mode. The minimum and maximum
* processor frequency can be specified in the VgaCfg function. By default, the library allows a range of 120 to 270 MHz.
* processor frequency can be specified in the VgaCfg() function. By default, the library allows a range of 120 to 270 MHz.
* However, it may happen that at higher frequencies the processor will not operate correctly and it may be necessary to
* lower the upper limit.
* The searched processor frequency can be set with the set_sys_clock_pll() function.

View File

@@ -118,6 +118,7 @@ void VgaInit(const sVmode* vmode); //, u8 layer1mode=LAYERMODE_BASE, u8 layer2mo
* @addtogroup VideoInitGroup
* @brief Functions for initialzing the library
* @details The video mode can be initialized either simply by the Video() function or in more detail by the following functions.
* @see VideoModeGroup
* @{
*/
@@ -136,6 +137,7 @@ void StartVgaCore();
* is necessary to first stop the video generation by calling the VgaInitReq function with the NULL parameter, and
* only then call the function with the new video mode setting.
* @param vmode Video format description generated by VgaCfg() or NULL to stop driver.
* @see VideoModeGroup
*/
void VgaInitReq(const sVmode* vmode);

View File

@@ -11,7 +11,7 @@
/**
* @addtogroup ScreenGroup
* @brief Defining the layout of the display
* @details When displaying screen image, the default pointer is pScreen for the library. It points to the sScreen structure that
* @details When displaying screen image, the default pointer is @link pScreen @endlink for the library. It points to the sScreen structure that
* describes the contents of the display. The Raspberry Pico has a limited RAM size and cannot accommodate a high resolution image.
* Therefore, the image must be composed of smaller segments to minimize the memory-intensive parts.
* @note The following descriptions of the image format only apply to the base image layer 0. It is the only one that can contain

View File

@@ -246,6 +246,7 @@ void VgaPrintCfg(const sVmode* vmode);
* @brief Calculate the structure for setting up the video mode.
* @param cfg Source configuration structure
* @param vmode Destination videomode setup for driver
* @see VgaInitReq()
*/
void VgaCfg(const sVgaCfg* cfg, sVmode* vmode);