Skip to content

Commit

Permalink
vi: fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rasky committed Dec 7, 2024
1 parent 75249ce commit c7dc3d1
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
14 changes: 7 additions & 7 deletions include/vi.h
Original file line number Diff line number Diff line change
Expand Up @@ -631,14 +631,14 @@ void vi_set_yscale(float fb_height);
* @brief Set the horizontal scaling factor.
*
* Set the scale factor applied to the framebuffer width to display it on the screen.
* The \p factor term describes how many framebuffer pixels advance for each
* The \p xfactor term describes how many framebuffer pixels advance for each
* output dot. For instance, a factor of 0.5 means that each framebuffer pixel
* will be repeated twice horizontally on the screen, onto two output dots.
*
* You can use #vi_set_xscale to automatically calculate the factor needed
* to display the framebuffer width on the screen.
*
* @param factor Horizontal scale factor to set
* @param xfactor Horizontal scale factor to set
*
* @see #vi_set_xscale
*/
Expand All @@ -648,11 +648,11 @@ void vi_set_xscale_factor(float xfactor);
* @brief Set the vertical scaling factor.
*
* Set the scale factor applied to the framebuffer height to display it on the screen.
* The \p factor term describes how many framebuffer pixels advance for each
* The \p yfactor term describes how many framebuffer pixels advance for each
* output scanline. For instance, a factor of 0.5 means that each framebuffer pixel
* will be repeated twice vertically on the screen, onto two scanlines.
*
* @param factor Horizontal scale factor to set
* @param yfactor Horizontal scale factor to set
*/
void vi_set_yscale_factor(float yfactor);

Expand Down Expand Up @@ -761,9 +761,9 @@ void vi_set_output(int x0, int y0, int x1, int y1);
* @param x Horizontal scroll offset
* @param y Vertical scroll offset
*
* @see #vi_get_scroll_bounds
* @see #vi_get_scroll
* @see #vi_scroll
* @see #vi_get_output_bounds
* @see #vi_get_output
* @see #vi_scroll_output
*/
void vi_move_output(int x, int y);

Expand Down
7 changes: 4 additions & 3 deletions src/vi.c
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,13 @@ static const vi_preset_t vi_presets[3] = {
},
};

/** @brief Line interrupt callbacks */
typedef struct {
int line;
void (*handler)(void);
int line; ///< Line number
void (*handler)(void); ///< Callback function
} line_irqs_t;

line_irqs_t line_irqs[16] = {0};
line_irqs_t line_irqs[16] = {0}; ///< Line interrupt callbacks

static vi_config_t cfg; ///< Current VI configuration
static const vi_preset_t *preset; ///< Active TV preset
Expand Down

0 comments on commit c7dc3d1

Please sign in to comment.