wp
/
xed
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Clean up the docs a bit

This commit is contained in:
JosephMcc 2017-01-16 16:43:46 -08:00
parent 490303557a
commit 7a06a119b5
4 changed files with 57 additions and 271 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/reference/Makefile.am
View File

@ -47,7 +47,6 @@ IGNORE_HFILES= \
xed-io-error-message-area.h \
xed-languages-manager.h \
xed-plugins-engine.h \
xed-prefs-manager-private.h \
xed-session.h \
xed-ui.h \
xed-window-private.h \

6
docs/reference/xed-docs.sgml
View File

@ -9,6 +9,7 @@
<chapter>
<title>xed</title>
<xi:include href="xml/xed-app.xml"/>
<xi:include href="xml/xed-app-activatable.xml"/>
<xi:include href="xml/xed-document.xml"/>
<xi:include href="xml/xed-encodings-option-menu.xml"/>
<xi:include href="xml/xed-file-chooser-dialog.xml"/>
@ -18,19 +19,18 @@
<xi:include href="xml/xed-notebook.xml"/>
<xi:include href="xml/xed-panel.xml"/>
<xi:include href="xml/xed-print-job-preview.xml"/>
<xi:include href="xml/xed-print.xml"/>
<xi:include href="xml/xed-print-job.xml"/>
<xi:include href="xml/xed-progress-message-area.xml"/>
<xi:include href="xml/xed-statusbar.xml"/>
<xi:include href="xml/xed-tab.xml"/>
<xi:include href="xml/xed-view.xml"/>
<xi:include href="xml/xed-view-activatable.xml"/>
<xi:include href="xml/xed-window.xml"/>
<xi:include href="xml/xed-convert.xml"/>
<xi:include href="xml/xed-debug.xml"/>
<xi:include href="xml/xed-encodings.xml"/>
<xi:include href="xml/xed-help.xml"/>
<xi:include href="xml/xed-metadata-manager.xml"/>
<xi:include href="xml/xed-prefs-manager-app.xml"/>
<xi:include href="xml/xed-prefs-manager.xml"/>
<xi:include href="xml/xed-utils.xml"/>
</chapter>
</book>

315
docs/reference/xed-sections.txt
View File

@ -19,6 +19,21 @@ XED_IS_APP_CLASS
XED_APP_GET_CLASS
</SECTION>
<SECTION>
<FILE>xed-app-activatable</FILE>
<TITLE>XedAppActivatable</TITLE>
XedAppActivatable
xed_app_activatable_activate
xed_app_activatable_deactivate
<SUBSECTION Standard>
XED_TYPE_APP_ACTIVATABLE
XED_APP_ACTIVATABLE
XED_APP_ACTIVATABLE_IFACE
XED_IS_APP_ACTIVATABLE
XED_APP_ACTIVATABLE_GET_IFACE
xed_app_activatable_get_type
</SECTION>
<SECTION>
<FILE>xed-document</FILE>
XedSearchFlags
@ -29,7 +44,7 @@ XedDocumentSaveFlags
XED_DOCUMENT_ERROR
xed_document_error_quark
xed_document_new
xed_document_get_uri
xed_document_get_location
xed_document_get_uri_for_display
xed_document_get_short_name_for_display
xed_document_get_mime_type
@ -253,7 +268,7 @@ XED_PRINT_JOB_PREVIEW_GET_CLASS
</SECTION>
<SECTION>
<FILE>xed-print</FILE>
<FILE>xed-print-job</FILE>
<TITLE>XedPrintJob</TITLE>
XedPrintJob
xed_print_job_new
@ -360,6 +375,22 @@ XED_IS_VIEW_CLASS
XED_VIEW_GET_CLASS
</SECTION>
<SECTION>
<FILE>xed-view-activatable</FILE>
<TITLE>XedViewActivatable</TITLE>
XedViewActivatable
xed_view_activatable_activate
xed_view_activatable_deactivate
xed_view_activatable_update_state
<SUBSECTION Standard>
XED_TYPE_VIEW_ACTIVATABLE
XED_VIEW_ACTIVATABLE
XED_VIEW_ACTIVATABLE_IFACE
XED_IS_VIEW_ACTIVATABLE
XED_VIEW_ACTIVATABLE_GET_IFACE
xed_view_activatable_get_type
</SECTION>
<SECTION>
<FILE>xed-window</FILE>
XedWindowState
@ -367,7 +398,7 @@ XedWindowPrivate
<TITLE>XedWindow</TITLE>
XedWindow
xed_window_create_tab
xed_window_create_tab_from_uri
xed_window_create_tab_from_location
xed_window_close_tab
xed_window_close_all_tabs
xed_window_close_tabs
@ -396,6 +427,20 @@ XED_IS_WINDOW_CLASS
XED_WINDOW_GET_CLASS
</SECTION>
<FILE>xed-window-activatable</FILE>
<TITLE>XedWindowActivatable</TITLE>
XedWindowActivatable
xed_window_activatable_activate
xed_window_activatable_deactivate
xed_window_activatable_update_state
<SUBSECTION Standard>
XED_TYPE_WINDOW_ACTIVATABLE
XED_WINDOW_ACTIVATABLE
XED_WINDOW_ACTIVATABLE_IFACE
XED_IS_WINDOW_ACTIVATABLE
XED_WINDOW_ACTIVATABLE_GET_IFACE
xed_window_activatable_get_type
<SECTION>
<FILE>xed-convert</FILE>
XedConvertError
@ -456,270 +501,6 @@ xed_metadata_manager_get
xed_metadata_manager_set
</SECTION>
<SECTION>
<FILE>xed-prefs-manager-app</FILE>
xed_prefs_manager_app_init
xed_prefs_manager_app_shutdown
xed_prefs_manager_get_window_state
xed_prefs_manager_set_window_state
xed_prefs_manager_window_state_can_set
xed_prefs_manager_get_window_size
xed_prefs_manager_get_default_window_size
xed_prefs_manager_set_window_size
xed_prefs_manager_window_size_can_set
xed_prefs_manager_get_side_panel_size
xed_prefs_manager_get_default_side_panel_size
xed_prefs_manager_set_side_panel_size
xed_prefs_manager_side_panel_size_can_set
xed_prefs_manager_get_bottom_panel_size
xed_prefs_manager_get_default_bottom_panel_size
xed_prefs_manager_set_bottom_panel_size
xed_prefs_manager_bottom_panel_size_can_set
</SECTION>
<SECTION>
<FILE>xed-prefs-manager</FILE>
XED_BASE_KEY
GPM_PREFS_DIR
GPM_FONT_DIR
GPM_USE_DEFAULT_FONT
GPM_EDITOR_FONT
GPM_COLORS_DIR
GPM_USE_DEFAULT_COLORS
GPM_BACKGROUND_COLOR
GPM_TEXT_COLOR
GPM_SELECTED_TEXT_COLOR
GPM_SELECTION_COLOR
GPM_SAVE_DIR
GPM_CREATE_BACKUP_COPY
GPM_BACKUP_COPY_EXTENSION
GPM_AUTO_SAVE
GPM_AUTO_SAVE_INTERVAL
GPM_UNDO_DIR
GPM_UNDO_ACTIONS_LIMIT
GPM_WRAP_MODE_DIR
GPM_WRAP_MODE
GPM_TABS_DIR
GPM_TABS_SIZE
GPM_INSERT_SPACES
GPM_AUTO_INDENT_DIR
GPM_AUTO_INDENT
GPM_LINE_NUMBERS_DIR
GPM_DISPLAY_LINE_NUMBERS
GPM_CURRENT_LINE_DIR
GPM_HIGHLIGHT_CURRENT_LINE
GPM_BRACKET_MATCHING_DIR
GPM_BRACKET_MATCHING
GPM_RIGHT_MARGIN_DIR
GPM_DISPLAY_RIGHT_MARGIN
GPM_RIGHT_MARGIN_POSITION
GPM_CURSOR_POSITION_DIR
GPM_RESTORE_CURSOR_POSITION
GPM_SEARCH_HIGHLIGHTING_DIR
GPM_SEARCH_HIGHLIGHTING_ENABLE
GPM_TOOLBAR_DIR
GPM_TOOLBAR_VISIBLE
GPM_TOOLBAR_BUTTONS_STYLE
GPM_STATUSBAR_DIR
GPM_STATUSBAR_VISIBLE
GPM_SIDE_PANE_DIR
GPM_SIDE_PANE_VISIBLE
GPM_BOTTOM_PANEL_DIR
GPM_BOTTOM_PANEL_VISIBLE
GPM_RECENTS_DIR
GPM_MAX_RECENTS
GPM_PRINT_PAGE_DIR
GPM_PRINT_SYNTAX
GPM_PRINT_HEADER
GPM_PRINT_WRAP_MODE
GPM_PRINT_LINE_NUMBERS
GPM_PRINT_FONT_DIR
GPM_PRINT_FONT_BODY
GPM_PRINT_FONT_BODY_PANGO
GPM_PRINT_FONT_HEADER
GPM_PRINT_FONT_HEADER_PANGO
GPM_PRINT_FONT_NUMBERS
GPM_PRINT_FONT_NUMBERS_PANGO
GPM_WINDOW_DIR
GPM_WINDOW_STATE
GPM_WINDOW_WIDTH
GPM_WINDOW_HEIGHT
GPM_SIDE_PANEL_SIZE
GPM_BOTTOM_PANEL_SIZE
GPM_ENCODINGS_DIR
GPM_AUTO_DETECTED_ENCODINGS
GPM_SHOWN_IN_MENU_ENCODINGS
GPM_SYNTAX_HL_DIR
GPM_SYNTAX_HL_ENABLE
GPM_WRITABLE_VFS_SCHEMES
GPM_DEFAULT_USE_DEFAULT_FONT
GPM_DEFAULT_EDITOR_FONT
GPM_DEFAULT_USE_DEFAULT_COLORS
GPM_DEFAULT_BACKGROUND_COLOR
GPM_DEFAULT_TEXT_COLOR
GPM_DEFAULT_SELECTED_TEXT_COLOR
GPM_DEFAULT_SELECTION_COLOR
GPM_DEFAULT_CREATE_BACKUP_COPY
GPM_DEFAULT_BACKUP_COPY_EXTENSION
GPM_DEFAULT_AUTO_SAVE
GPM_DEFAULT_AUTO_SAVE_INTERVAL
GPM_DEFAULT_UNDO_ACTIONS_LIMIT
GPM_DEFAULT_WRAP_MODE
GPM_DEFAULT_TABS_SIZE
GPM_DEFAULT_INSERT_SPACES
GPM_DEFAULT_AUTO_INDENT
GPM_DEFAULT_DISPLAY_LINE_NUMBERS
GPM_DEFAULT_AUTO_DETECTED_ENCODINGS
GPM_DEFAULT_TOOLBAR_VISIBLE
GPM_DEFAULT_TOOLBAR_BUTTONS_STYLE
GPM_DEFAULT_TOOLBAR_SHOW_TOOLTIPS
GPM_DEFAULT_STATUSBAR_VISIBLE
GPM_DEFAULT_SIDE_PANE_VISIBLE
GPM_DEFAULT_BOTTOM_PANEL_VISIBLE
GPM_DEFAULT_PRINT_SYNTAX
GPM_DEFAULT_PRINT_HEADER
GPM_DEFAULT_PRINT_WRAP_MODE
GPM_DEFAULT_PRINT_LINE_NUMBERS
GPM_DEFAULT_PRINT_FONT_BODY_PANGO
GPM_DEFAULT_PRINT_FONT_HEADER_PANGO
GPM_DEFAULT_PRINT_FONT_NUMBERS_PANGO
GPM_DEFAULT_MAX_RECENTS
GPM_DEFAULT_WINDOW_STATE
GPM_DEFAULT_WINDOW_WIDTH
GPM_DEFAULT_WINDOW_HEIGHT
GPM_DEFAULT_WINDOW_STATE_STR
GPM_DEFAULT_WINDOW_WIDTH_STR
GPM_DEFAULT_WINDOW_HEIGHT_STR
GPM_DEFAULT_SIDE_PANEL_SIZE
GPM_DEFAULT_BOTTOM_PANEL_SIZE
GPM_DEFAULT_SIDE_PANEL_SIZE_STR
GPM_DEFAULT_BOTTOM_PANEL_SIZE_STR
GPM_DEFAULT_HIGHLIGHT_CURRENT_LINE
GPM_DEFAULT_BRACKET_MATCHING
GPM_DEFAULT_DISPLAY_RIGHT_MARGIN
GPM_DEFAULT_RIGHT_MARGIN_POSITION
GPM_DEFAULT_SYNTAX_HL_ENABLE
GPM_DEFAULT_WRITABLE_VFS_SCHEMES
GPM_DEFAULT_RESTORE_CURSOR_POSITION
GPM_DEFAULT_SEARCH_HIGHLIGHTING_ENABLE
XedToolbarSetting
xed_prefs_manager_init
xed_prefs_manager_shutdown
xed_prefs_manager_get_use_default_font
xed_prefs_manager_set_use_default_font
xed_prefs_manager_use_default_font_can_set
xed_prefs_manager_get_editor_font
xed_prefs_manager_set_editor_font
xed_prefs_manager_editor_font_can_set
xed_prefs_manager_get_use_default_colors
xed_prefs_manager_set_use_default_colors
xed_prefs_manager_use_default_colors_can_set
xed_prefs_manager_get_background_color
xed_prefs_manager_set_background_color
xed_prefs_manager_background_color_can_set
xed_prefs_manager_get_text_color
xed_prefs_manager_set_text_color
xed_prefs_manager_text_color_can_set
xed_prefs_manager_get_selection_color
xed_prefs_manager_set_selection_color
xed_prefs_manager_selection_color_can_set
xed_prefs_manager_get_selected_text_color
xed_prefs_manager_set_selected_text_color
xed_prefs_manager_selected_text_color_can_set
xed_prefs_manager_get_create_backup_copy
xed_prefs_manager_set_create_backup_copy
xed_prefs_manager_create_backup_copy_can_set
xed_prefs_manager_get_backup_extension
xed_prefs_manager_get_auto_save
xed_prefs_manager_set_auto_save
xed_prefs_manager_auto_save_can_set
xed_prefs_manager_get_auto_save_interval
xed_prefs_manager_set_auto_save_interval
xed_prefs_manager_auto_save_interval_can_set
xed_prefs_manager_get_undo_actions_limit
xed_prefs_manager_set_undo_actions_limit
xed_prefs_manager_undo_actions_limit_can_set
xed_prefs_manager_get_wrap_mode
xed_prefs_manager_set_wrap_mode
xed_prefs_manager_wrap_mode_can_set
xed_prefs_manager_get_tabs_size
xed_prefs_manager_set_tabs_size
xed_prefs_manager_tabs_size_can_set
xed_prefs_manager_get_insert_spaces
xed_prefs_manager_set_insert_spaces
xed_prefs_manager_insert_spaces_can_set
xed_prefs_manager_get_auto_indent
xed_prefs_manager_set_auto_indent
xed_prefs_manager_auto_indent_can_set
xed_prefs_manager_get_display_line_numbers
xed_prefs_manager_set_display_line_numbers
xed_prefs_manager_display_line_numbers_can_set
xed_prefs_manager_get_toolbar_visible
xed_prefs_manager_set_toolbar_visible
xed_prefs_manager_toolbar_visible_can_set
xed_prefs_manager_get_toolbar_buttons_style
xed_prefs_manager_set_toolbar_buttons_style
xed_prefs_manager_toolbar_buttons_style_can_set
xed_prefs_manager_get_statusbar_visible
xed_prefs_manager_set_statusbar_visible
xed_prefs_manager_statusbar_visible_can_set
xed_prefs_manager_get_side_pane_visible
xed_prefs_manager_set_side_pane_visible
xed_prefs_manager_side_pane_visible_can_set
xed_prefs_manager_get_bottom_panel_visible
xed_prefs_manager_set_bottom_panel_visible
xed_prefs_manager_bottom_panel_visible_can_set
xed_prefs_manager_get_print_syntax_hl
xed_prefs_manager_set_print_syntax_hl
xed_prefs_manager_print_syntax_hl_can_set
xed_prefs_manager_get_print_header
xed_prefs_manager_set_print_header
xed_prefs_manager_print_header_can_set
xed_prefs_manager_get_print_wrap_mode
xed_prefs_manager_set_print_wrap_mode
xed_prefs_manager_print_wrap_mode_can_set
xed_prefs_manager_get_print_line_numbers
xed_prefs_manager_set_print_line_numbers
xed_prefs_manager_print_line_numbers_can_set
xed_prefs_manager_get_print_font_body
xed_prefs_manager_set_print_font_body
xed_prefs_manager_print_font_body_can_set
xed_prefs_manager_get_default_print_font_body
xed_prefs_manager_get_print_font_header
xed_prefs_manager_set_print_font_header
xed_prefs_manager_print_font_header_can_set
xed_prefs_manager_get_default_print_font_header
xed_prefs_manager_get_print_font_numbers
xed_prefs_manager_set_print_font_numbers
xed_prefs_manager_print_font_numbers_can_set
xed_prefs_manager_get_default_print_font_numbers
xed_prefs_manager_get_max_recents
xed_prefs_manager_get_auto_detected_encodings
xed_prefs_manager_get_shown_in_menu_encodings
xed_prefs_manager_set_shown_in_menu_encodings
xed_prefs_manager_shown_in_menu_encodings_can_set
xed_prefs_manager_get_highlight_current_line
xed_prefs_manager_set_highlight_current_line
xed_prefs_manager_highlight_current_line_can_set
xed_prefs_manager_get_bracket_matching
xed_prefs_manager_set_bracket_matching
xed_prefs_manager_bracket_matching_can_set
xed_prefs_manager_get_display_right_margin
xed_prefs_manager_set_display_right_margin
xed_prefs_manager_display_right_margin_can_set
xed_prefs_manager_get_right_margin_position
xed_prefs_manager_set_right_margin_position
xed_prefs_manager_right_margin_position_can_set
xed_prefs_manager_get_enable_syntax_highlighting
xed_prefs_manager_set_enable_syntax_highlighting
xed_prefs_manager_enable_syntax_highlighting_can_set
xed_prefs_manager_get_writable_vfs_schemes
xed_prefs_manager_get_restore_cursor_position
xed_prefs_manager_get_enable_search_highlighting
xed_prefs_manager_set_enable_search_highlighting
xed_prefs_manager_enable_search_highlighting_can_set
</SECTION>
<SECTION>
<FILE>xed-utils</FILE>
GBOOLEAN_TO_POINTER

6
docs/reference/xed.types
View File

@ -1,4 +1,5 @@
#include "xed-app.h"
#include "xed-app-activatable.h"
#include "xed-document.h"
#include "xed-encodings.h"
#include "xed-encodings-combo-box.h"
@ -12,8 +13,11 @@
#include "xed-statusbar.h"
#include "xed-tab.h"
#include "xed-view.h"
#include "xed-view-activatable.h"
#include "xed-window.h"
#include "xed-window-activatable.h"
xed_app_get_type
xed_app_activatable_get_type
xed_document_get_type
xed_encoding_get_type
xed_encodings_combo_box_get_type
@ -27,4 +31,6 @@ xed_progress_message_area_get_type
xed_statusbar_get_type
xed_tab_get_type
xed_view_get_type
xed_view_activatable_get_type
xed_window_get_type
xed_window_activatable_get_type