Skip to content

Commit

Permalink
libchafa: Sync docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hpjansson committed Sep 13, 2023
1 parent 549a7f8 commit 84f95a3
Show file tree
Hide file tree
Showing 3 changed files with 123 additions and 2 deletions.
2 changes: 1 addition & 1 deletion chafa/chafa-term-info.c
Expand Up @@ -901,7 +901,7 @@ chafa_term_info_emit_seq (ChafaTermInfo *term_info, ChafaTermSeq seq, ...)
}

/**
* chafa_term_info_emit_seq:
* chafa_term_info_parse_seq:
* @term_info: A #ChafaTermInfo
* @seq: A #ChafaTermSeq to attempt to parse
* @input: Pointer to pointer to input data
Expand Down
2 changes: 2 additions & 0 deletions docs/chafa-docs.xml
Expand Up @@ -27,6 +27,8 @@
<title>Chafa C API</title>
<xi:include href="xml/chafa-canvas.xml"/>
<xi:include href="xml/chafa-canvas-config.xml"/>
<xi:include href="xml/chafa-frame.xml"/>
<xi:include href="xml/chafa-image.xml"/>
<xi:include href="xml/chafa-symbol-map.xml"/>
<xi:include href="xml/chafa-term-db.xml"/>
<xi:include href="xml/chafa-term-info.xml"/>
Expand Down
121 changes: 120 additions & 1 deletion docs/chafa-sections.txt
Expand Up @@ -6,8 +6,11 @@ chafa_canvas_new_similar
chafa_canvas_ref
chafa_canvas_unref
chafa_canvas_peek_config
chafa_canvas_set_image
chafa_canvas_draw_all_pixels
chafa_canvas_print
chafa_canvas_print_rows
chafa_canvas_print_rows_strv
chafa_canvas_get_char_at
chafa_canvas_set_char_at
chafa_canvas_get_colors_at
Expand All @@ -26,6 +29,7 @@ ChafaCanvasMode
ChafaDitherMode
ChafaColorExtractor
ChafaOptimizations
ChafaPassthrough
ChafaCanvasConfig
chafa_canvas_config_new
chafa_canvas_config_copy
Expand Down Expand Up @@ -67,6 +71,8 @@ chafa_canvas_config_get_dither_intensity
chafa_canvas_config_set_dither_intensity
chafa_canvas_config_get_optimizations
chafa_canvas_config_set_optimizations
chafa_canvas_config_get_passthrough
chafa_canvas_config_set_passthrough
</SECTION>

<SECTION>
Expand Down Expand Up @@ -112,6 +118,7 @@ CHAFA_VERSION_1_6
CHAFA_VERSION_1_8
CHAFA_VERSION_1_10
CHAFA_VERSION_1_12
CHAFA_VERSION_1_14
ChafaPixelType
chafa_calc_canvas_geometry
</SECTION>
Expand All @@ -130,6 +137,8 @@ chafa_term_info_unref
chafa_term_info_get_seq
chafa_term_info_set_seq
chafa_term_info_have_seq
chafa_term_info_emit_seq
chafa_term_info_parse_seq
chafa_term_info_supplement
chafa_term_info_emit_reset_terminal_soft
chafa_term_info_emit_reset_terminal_hard
Expand All @@ -146,7 +155,6 @@ chafa_term_info_emit_cursor_up_1
chafa_term_info_emit_cursor_down_1
chafa_term_info_emit_cursor_left_1
chafa_term_info_emit_cursor_right_1
chafa_term_info_emit_set_scrolling_rows
chafa_term_info_emit_cursor_up_scroll
chafa_term_info_emit_cursor_down_scroll
chafa_term_info_emit_insert_cells
Expand Down Expand Up @@ -175,17 +183,109 @@ chafa_term_info_emit_set_color_fgbg_256
chafa_term_info_emit_set_color_fg_direct
chafa_term_info_emit_set_color_bg_direct
chafa_term_info_emit_set_color_fgbg_direct
chafa_term_info_emit_reset_color_fg
chafa_term_info_emit_reset_color_bg
chafa_term_info_emit_reset_color_fgbg
chafa_term_info_emit_set_default_fg
chafa_term_info_emit_set_default_bg
chafa_term_info_emit_reset_default_fg
chafa_term_info_emit_reset_default_bg
chafa_term_info_emit_query_default_fg
chafa_term_info_emit_query_default_bg
chafa_term_info_emit_repeat_char
chafa_term_info_emit_set_scrolling_rows
chafa_term_info_emit_reset_scrolling_rows
chafa_term_info_emit_save_cursor_pos
chafa_term_info_emit_restore_cursor_pos
chafa_term_info_emit_begin_sixels
chafa_term_info_emit_end_sixels
chafa_term_info_emit_enable_sixel_scrolling
chafa_term_info_emit_disable_sixel_scrolling
chafa_term_info_emit_set_sixel_advance_down
chafa_term_info_emit_set_sixel_advance_right
chafa_term_info_emit_begin_kitty_immediate_image_v1
chafa_term_info_emit_begin_kitty_immediate_virt_image_v1
chafa_term_info_emit_end_kitty_image
chafa_term_info_emit_begin_kitty_image_chunk
chafa_term_info_emit_end_kitty_image_chunk
chafa_term_info_emit_begin_iterm2_image
chafa_term_info_emit_end_iterm2_image
chafa_term_info_emit_begin_screen_passthrough
chafa_term_info_emit_end_screen_passthrough
chafa_term_info_emit_enable_alt_screen
chafa_term_info_emit_disable_alt_screen
chafa_term_info_emit_begin_tmux_passthrough
chafa_term_info_emit_end_tmux_passthrough
chafa_term_info_emit_return_key
chafa_term_info_emit_backspace_key
chafa_term_info_emit_delete_key
chafa_term_info_emit_delete_ctrl_key
chafa_term_info_emit_delete_shift_key
chafa_term_info_emit_insert_key
chafa_term_info_emit_insert_ctrl_key
chafa_term_info_emit_insert_shift_key
chafa_term_info_emit_home_key
chafa_term_info_emit_home_ctrl_key
chafa_term_info_emit_home_shift_key
chafa_term_info_emit_end_key
chafa_term_info_emit_end_ctrl_key
chafa_term_info_emit_end_shift_key
chafa_term_info_emit_up_key
chafa_term_info_emit_up_ctrl_key
chafa_term_info_emit_up_shift_key
chafa_term_info_emit_down_key
chafa_term_info_emit_down_ctrl_key
chafa_term_info_emit_down_shift_key
chafa_term_info_emit_left_key
chafa_term_info_emit_left_ctrl_key
chafa_term_info_emit_left_shift_key
chafa_term_info_emit_right_key
chafa_term_info_emit_right_ctrl_key
chafa_term_info_emit_right_shift_key
chafa_term_info_emit_page_up_key
chafa_term_info_emit_page_up_ctrl_key
chafa_term_info_emit_page_up_shift_key
chafa_term_info_emit_page_down_key
chafa_term_info_emit_page_down_ctrl_key
chafa_term_info_emit_page_down_shift_key
chafa_term_info_emit_tab_key
chafa_term_info_emit_tab_shift_key
chafa_term_info_emit_f1_key
chafa_term_info_emit_f1_ctrl_key
chafa_term_info_emit_f1_shift_key
chafa_term_info_emit_f2_key
chafa_term_info_emit_f2_ctrl_key
chafa_term_info_emit_f2_shift_key
chafa_term_info_emit_f3_key
chafa_term_info_emit_f3_ctrl_key
chafa_term_info_emit_f3_shift_key
chafa_term_info_emit_f4_key
chafa_term_info_emit_f4_ctrl_key
chafa_term_info_emit_f4_shift_key
chafa_term_info_emit_f5_key
chafa_term_info_emit_f5_ctrl_key
chafa_term_info_emit_f5_shift_key
chafa_term_info_emit_f6_key
chafa_term_info_emit_f6_ctrl_key
chafa_term_info_emit_f6_shift_key
chafa_term_info_emit_f7_key
chafa_term_info_emit_f7_ctrl_key
chafa_term_info_emit_f7_shift_key
chafa_term_info_emit_f8_key
chafa_term_info_emit_f8_ctrl_key
chafa_term_info_emit_f8_shift_key
chafa_term_info_emit_f9_key
chafa_term_info_emit_f9_ctrl_key
chafa_term_info_emit_f9_shift_key
chafa_term_info_emit_f10_key
chafa_term_info_emit_f10_ctrl_key
chafa_term_info_emit_f10_shift_key
chafa_term_info_emit_f11_key
chafa_term_info_emit_f11_ctrl_key
chafa_term_info_emit_f11_shift_key
chafa_term_info_emit_f12_key
chafa_term_info_emit_f12_ctrl_key
chafa_term_info_emit_f12_shift_key
</SECTION>

<SECTION>
Expand All @@ -199,3 +299,22 @@ chafa_term_db_get_default
chafa_term_db_detect
chafa_term_db_get_fallback_info
</SECTION>

<SECTION>
<FILE>chafa-image</FILE>
ChafaImage
chafa_image_new
chafa_image_ref
chafa_image_unref
chafa_image_set_frame
</SECTION>

<SECTION>
<FILE>chafa-frame</FILE>
ChafaFrame
chafa_frame_new
chafa_frame_new_borrow
chafa_frame_new_steal
chafa_frame_ref
chafa_frame_unref
</SECTION>

0 comments on commit 84f95a3

Please sign in to comment.