From be468697825dd7cf8b983a4ff4dc8e25b35a2f51 Mon Sep 17 00:00:00 2001 From: Tomeu Vizoso Date: Mon, 18 Feb 2013 14:19:28 +0100 Subject: [PATCH] docs: Fix cross-reference generation https://bugzilla.gnome.org/show_bug.cgi?id=676856 --- .gitignore | 9 +- doc/reference/meta-docs.sgml | 58 +++ doc/reference/meta-sections.txt | 704 ++++++++++++++++++++++++++++++++ src/compositor/compositor.c | 6 + src/core/keybindings.c | 6 + src/core/window.c | 1 + src/meta/meta-shaped-texture.h | 7 + src/meta/prefs.h | 5 +- 8 files changed, 791 insertions(+), 5 deletions(-) create mode 100644 doc/reference/meta-docs.sgml create mode 100644 doc/reference/meta-sections.txt diff --git a/.gitignore b/.gitignore index 2eae3d9bd..ff4d76c78 100644 --- a/.gitignore +++ b/.gitignore @@ -80,10 +80,13 @@ doc/reference/*.bak doc/reference/*.hierarchy doc/reference/*.interfaces doc/reference/*.prerequisites -doc/reference/*.sgml doc/reference/*.signals doc/reference/*.stamp -doc/reference/*.txt -doc/reference/*.types doc/reference/html/ doc/reference/xml/ +doc/reference/meta-decl-list.txt +doc/reference/meta-decl.txt +doc/reference/meta-overrides.txt +doc/reference/meta-undeclared.txt +doc/reference/meta-undocumented.txt +doc/reference/meta-unused.txt diff --git a/doc/reference/meta-docs.sgml b/doc/reference/meta-docs.sgml new file mode 100644 index 000000000..5d8d0335b --- /dev/null +++ b/doc/reference/meta-docs.sgml @@ -0,0 +1,58 @@ + + +]> + + + meta Reference Manual + + for meta [VERSION]. + The latest version of this documentation can be found on-line at + http://[SERVER]/meta/. + + + + + [Insert title here] + + + + + + + + + + + + + + + + + + + + + + + + + + + Object Hierarchy + + + + API Index + + + + Index of deprecated API + + + + + diff --git a/doc/reference/meta-sections.txt b/doc/reference/meta-sections.txt new file mode 100644 index 000000000..176a6a6a8 --- /dev/null +++ b/doc/reference/meta-sections.txt @@ -0,0 +1,704 @@ +
+barrier +MetaBarrier +MetaBarrier +MetaBarrierClass +meta_barrier_is_active +meta_barrier_destroy +meta_barrier_release +MetaBarrierDirection +MetaBarrierEvent + +META_BARRIER +META_BARRIER_CLASS +META_BARRIER_GET_CLASS +META_IS_BARRIER +META_IS_BARRIER_CLASS +META_TYPE_BARRIER +META_TYPE_BARRIER_EVENT +MetaBarrierPrivate +meta_barrier_event_get_type +meta_barrier_get_type +
+ +
+boxes +MetaRectangle +MetaStrut +MetaEdgeType +MetaEdge +meta_rectangle_copy +meta_rectangle_free +meta_rect +meta_rectangle_area +meta_rectangle_intersect +meta_rectangle_equal +meta_rectangle_union +meta_rectangle_overlap +meta_rectangle_vert_overlap +meta_rectangle_horiz_overlap +meta_rectangle_could_fit_rect +meta_rectangle_contains_rect + +META_TYPE_RECTANGLE +meta_rectangle_get_type +
+ +
+common +META_VIRTUAL_CORE_POINTER_ID +META_VIRTUAL_CORE_KEYBOARD_ID +MetaFrameFlags +MetaMenuOp +MetaWindowMenuFunc +MetaGrabOp +MetaCursor +MetaFrameType +MetaVirtualModifier +MetaDirection +MetaMotionDirection +MetaSide +MetaButtonFunction +MAX_BUTTONS_PER_CORNER +MetaButtonLayout +MetaFrameBorders +meta_frame_borders_clear +META_ICON_WIDTH +META_ICON_HEIGHT +META_MINI_ICON_WIDTH +META_MINI_ICON_HEIGHT +META_DEFAULT_ICON_NAME +META_PRIORITY_RESIZE +META_PRIORITY_BEFORE_REDRAW +META_PRIORITY_REDRAW +META_PRIORITY_PREFS_NOTIFY +POINT_IN_RECT +MetaStackLayer +MetaWindowMenu +MetaResizePopup +
+ +
+compositor +MetaCompEffect +MetaCompositor +meta_compositor_new +meta_compositor_destroy +meta_compositor_manage_screen +meta_compositor_unmanage_screen +meta_compositor_window_shape_changed +meta_compositor_process_event +meta_compositor_filter_keybinding +meta_compositor_add_window +meta_compositor_remove_window +meta_compositor_show_window +meta_compositor_hide_window +meta_compositor_switch_workspace +meta_compositor_maximize_window +meta_compositor_unmaximize_window +meta_compositor_window_mapped +meta_compositor_window_unmapped +meta_compositor_sync_window_geometry +meta_compositor_set_updates_frozen +meta_compositor_queue_frame_drawn +meta_compositor_sync_stack +meta_compositor_sync_screen_size +meta_compositor_flash_screen +
+ +
+compositor-mutter +meta_get_stage_for_screen +meta_get_overlay_group_for_screen +meta_get_overlay_window +meta_get_window_actors +meta_get_window_group_for_screen +meta_get_top_window_group_for_screen +meta_disable_unredirect_for_screen +meta_enable_unredirect_for_screen +meta_set_stage_input_region +meta_empty_stage_input_region +
+ +
+display +MetaTabList +MetaTabShowType +meta_XFree +meta_display_get_compositor_version +meta_display_get_xinput_opcode +meta_display_supports_extended_barriers +meta_display_get_xdisplay +meta_display_get_compositor +meta_display_get_screens +meta_display_has_shape +meta_display_screen_for_root +meta_display_get_focus_window +meta_display_xwindow_is_a_no_focus_window +meta_display_get_damage_event_base +meta_display_get_shape_event_base +meta_display_xserver_time_is_before +meta_display_get_last_user_time +meta_display_get_current_time +meta_display_get_current_time_roundtrip +meta_display_get_ignored_modifier_mask +meta_display_get_tab_list +meta_display_get_tab_next +meta_display_get_tab_current +meta_display_begin_grab_op +meta_display_end_grab_op +meta_display_get_grab_op +meta_display_add_keybinding +meta_display_remove_keybinding +meta_display_get_keybinding_action +meta_display_set_input_focus_window +meta_display_focus_the_no_focus_window +meta_display_sort_windows_by_stacking +meta_display_get_leader_window +meta_display_add_ignored_crossing_serial +meta_display_unmanage_screen +meta_display_clear_mouse_mode +MetaDisplay +MetaDisplayClass + +META_DISPLAY +META_DISPLAY_CLASS +META_DISPLAY_GET_CLASS +META_IS_DISPLAY +META_IS_DISPLAY_CLASS +META_TYPE_DISPLAY +meta_display_get_type +
+ +
+errors +meta_error_trap_push +meta_error_trap_pop +meta_error_trap_push_with_return +meta_error_trap_pop_with_return +
+ +
+gradient +MetaGradientType +meta_gradient_create_simple +meta_gradient_create_multi +meta_gradient_create_interwoven +meta_gradient_add_alpha +
+ +
+group +MetaGroup +meta_window_get_group +meta_window_compute_group +meta_window_shutdown_group +meta_window_group_leader_changed +meta_display_lookup_group +meta_group_list_windows +meta_group_update_layers +meta_group_get_startup_id +meta_group_get_size +meta_group_property_notify +
+ +
+keybindings +MetaKeyBinding +META_TYPE_KEY_BINDING +meta_key_binding_get_name +meta_key_binding_get_modifiers +meta_key_binding_get_mask +meta_key_binding_is_builtin +meta_keybindings_set_custom_handler +meta_keybindings_switch_window +meta_screen_ungrab_all_keys +meta_screen_grab_all_keys +
+ +
+main +meta_get_option_context +meta_init +meta_run +meta_get_replace_current_wm +meta_set_wm_name +meta_set_gnome_wm_keybindings +MetaExitCode +meta_exit +meta_quit +
+ +
+meta-background +MetaBackground +MetaBackgroundEffects +MetaBackgroundClass +meta_background_new +meta_background_copy +meta_background_load_gradient +meta_background_load_color +meta_background_load_still_frame +meta_background_load_file_async +meta_background_load_file_finish +meta_background_get_filename +meta_background_get_style +meta_background_get_shading +meta_background_get_color +meta_background_get_second_color + +META_BACKGROUND +META_BACKGROUND_CLASS +META_BACKGROUND_GET_CLASS +META_IS_BACKGROUND +META_IS_BACKGROUND_CLASS +META_TYPE_BACKGROUND +MetaBackgroundPrivate +meta_background_get_type +
+ +
+meta-background-actor +MetaBackgroundActor +MetaBackgroundActor +MetaBackgroundActorClass +meta_background_actor_new_for_screen +MetaSnippetHook +meta_background_actor_add_glsl_snippet +meta_background_actor_set_uniform_float + +META_BACKGROUND_ACTOR +META_BACKGROUND_ACTOR_CLASS +META_BACKGROUND_ACTOR_GET_CLASS +META_IS_BACKGROUND_ACTOR +META_IS_BACKGROUND_ACTOR_CLASS +META_TYPE_BACKGROUND_ACTOR +MetaBackgroundActorPrivate +meta_background_actor_get_type +
+ +
+meta-background-group +MetaBackgroundGroup +MetaBackgroundGroupClass +meta_background_group_new + +META_BACKGROUND_GROUP +META_BACKGROUND_GROUP_CLASS +META_BACKGROUND_GROUP_GET_CLASS +META_IS_BACKGROUND_GROUP +META_IS_BACKGROUND_GROUP_CLASS +META_TYPE_BACKGROUND_GROUP +MetaBackgroundGroupPrivate +meta_background_group_get_type +
+ +
+meta-plugin +MetaPlugin +MetaPlugin +MetaPluginClass +MetaPluginInfo +meta_plugin_running +meta_plugin_debug_mode +meta_plugin_get_info +MetaPluginVersion +META_PLUGIN_DECLARE +meta_plugin_switch_workspace_completed +meta_plugin_minimize_completed +meta_plugin_maximize_completed +meta_plugin_unmaximize_completed +meta_plugin_map_completed +meta_plugin_destroy_completed +MetaModalOptions +meta_plugin_begin_modal +meta_plugin_end_modal +meta_plugin_get_screen +meta_plugin_manager_set_plugin_type + +META_IS_PLUGIN +META_IS_PLUGIN_CLASS +META_PLUGIN +META_PLUGIN_CLASS +META_PLUGIN_GET_CLASS +META_TYPE_PLUGIN +MetaPluginPrivate +meta_plugin_get_type +
+ +
+meta-shadow-factory +MetaShadowParams +meta_shadow_factory_get_default +meta_shadow_factory_set_params +meta_shadow_factory_get_params +MetaShadowFactory +MetaShadowFactoryClass + +META_IS_SHADOW_FACTORY +META_IS_SHADOW_FACTORY_CLASS +META_SHADOW_FACTORY +META_SHADOW_FACTORY_CLASS +META_SHADOW_FACTORY_GET_CLASS +META_TYPE_SHADOW_FACTORY +meta_shadow_factory_get_type +
+ +
+meta-shaped-texture +MetaShapedTexture +MetaShapedTexture +MetaShapedTextureClass +meta_shaped_texture_new +meta_shaped_texture_set_create_mipmaps +meta_shaped_texture_update_area +meta_shaped_texture_set_pixmap +meta_shaped_texture_get_texture +meta_shaped_texture_set_mask_texture +meta_shaped_texture_set_clip_region +meta_shaped_texture_get_image + +META_IS_SHAPED_TEXTURE +META_IS_SHAPED_TEXTURE_CLASS +META_SHAPED_TEXTURE +META_SHAPED_TEXTURE_CLASS +META_SHAPED_TEXTURE_GET_CLASS +META_TYPE_SHAPED_TEXTURE +MetaShapedTexturePrivate +meta_shaped_texture_get_type +
+ +
+meta-window-actor +MetaWindowActor +MetaWindowActor +MetaWindowActorClass +meta_window_actor_get_x_window +meta_window_actor_get_workspace +meta_window_actor_get_meta_window +meta_window_actor_get_texture +meta_window_actor_is_override_redirect +meta_window_actor_get_description +meta_window_actor_showing_on_its_workspace +meta_window_actor_is_destroyed + +META_IS_WINDOW_ACTOR +META_IS_WINDOW_ACTOR_CLASS +META_TYPE_WINDOW_ACTOR +META_WINDOW_ACTOR +META_WINDOW_ACTOR_CLASS +META_WINDOW_ACTOR_GET_CLASS +MetaWindowActorPrivate +meta_window_actor_get_type +
+ +
+prefs +MetaPreference +MetaPrefsChangedFunc +meta_prefs_add_listener +meta_prefs_remove_listener +meta_prefs_init +meta_prefs_override_preference_schema +meta_preference_to_string +meta_prefs_get_mouse_button_mods +meta_prefs_get_mouse_button_resize +meta_prefs_get_mouse_button_menu +meta_prefs_get_focus_mode +meta_prefs_get_focus_new_windows +meta_prefs_get_attach_modal_dialogs +meta_prefs_get_raise_on_click +meta_prefs_get_theme +meta_prefs_get_titlebar_font +meta_prefs_get_num_workspaces +meta_prefs_get_dynamic_workspaces +meta_prefs_get_application_based +meta_prefs_get_disable_workarounds +meta_prefs_get_auto_raise +meta_prefs_get_auto_raise_delay +meta_prefs_get_focus_change_on_pointer_rest +meta_prefs_get_gnome_accessibility +meta_prefs_get_gnome_animations +meta_prefs_get_edge_tiling +meta_prefs_get_auto_maximize +meta_prefs_get_button_layout +meta_prefs_get_action_double_click_titlebar +meta_prefs_get_action_middle_click_titlebar +meta_prefs_get_action_right_click_titlebar +meta_prefs_set_num_workspaces +meta_prefs_get_workspace_name +meta_prefs_change_workspace_name +meta_prefs_get_cursor_theme +meta_prefs_get_cursor_size +meta_prefs_get_compositing_manager +meta_prefs_get_force_fullscreen +meta_prefs_set_force_fullscreen +meta_prefs_get_workspaces_only_on_primary +meta_prefs_get_no_tab_popup +meta_prefs_set_no_tab_popup +meta_prefs_get_draggable_border_width +meta_prefs_get_ignore_request_hide_titlebar +meta_prefs_set_ignore_request_hide_titlebar +MetaKeyBindingAction +MetaKeyBindingFlags +MetaKeyCombo +MetaKeyHandlerFunc +meta_prefs_get_keybindings +meta_prefs_get_keybinding_action +meta_prefs_get_window_binding +meta_prefs_get_overlay_binding +meta_prefs_get_visual_bell +meta_prefs_bell_is_audible +meta_prefs_get_visual_bell_type +MetaKeyHandler + +meta_key_binding_get_type +
+ +
+preview-widget +MetaPreview +MetaPreview +MetaPreviewClass +meta_preview_new +meta_preview_set_theme +meta_preview_set_title +meta_preview_set_frame_type +meta_preview_set_frame_flags +meta_preview_set_button_layout +meta_preview_get_icon +meta_preview_get_mini_icon + +META_IS_PREVIEW +META_IS_PREVIEW_CLASS +META_PREVIEW +META_PREVIEW_CLASS +META_PREVIEW_GET_CLASS +META_TYPE_PREVIEW +meta_preview_get_type +
+ +
+screen +MetaScreen +MetaScreenClass +meta_screen_get_screen_number +meta_screen_get_display +meta_screen_get_xroot +meta_screen_get_size +meta_screen_get_compositor_data +meta_screen_set_compositor_data +meta_screen_for_x_screen +meta_screen_set_cm_selection +meta_screen_unset_cm_selection +meta_screen_get_startup_sequences +meta_screen_get_workspaces +meta_screen_get_n_workspaces +meta_screen_get_workspace_by_index +meta_screen_remove_workspace +meta_screen_append_new_workspace +meta_screen_get_active_workspace_index +meta_screen_get_active_workspace +meta_screen_get_n_monitors +meta_screen_get_primary_monitor +meta_screen_get_current_monitor +meta_screen_get_monitor_geometry +meta_screen_get_monitor_index_for_rect +meta_screen_focus_default_window +MetaScreenCorner +meta_screen_override_workspace_layout + +META_IS_SCREEN +META_IS_SCREEN_CLASS +META_SCREEN +META_SCREEN_CLASS +META_SCREEN_GET_CLASS +META_TYPE_SCREEN +meta_screen_get_type +
+ +
+theme +meta_theme_get_current +meta_theme_set_current +meta_theme_new +meta_theme_free +meta_theme_validate +meta_theme_load +MetaTheme +
+ +
+util +meta_is_verbose +meta_set_verbose +meta_is_debugging +meta_set_debugging +meta_is_syncing +meta_set_syncing +meta_set_replace_current_wm +meta_debug_spew_real +meta_verbose_real +meta_bug +meta_warning +meta_fatal +MetaDebugTopic +meta_topic_real +meta_add_verbose_topic +meta_remove_verbose_topic +meta_push_no_msg_prefix +meta_pop_no_msg_prefix +meta_unsigned_long_equal +meta_unsigned_long_hash +meta_frame_type_to_string +meta_gravity_to_string +_ +N_ +meta_g_utf8_strndup +meta_free_gslist_and_elements +meta_show_dialog +meta_debug_spew +meta_verbose +meta_topic +MetaLaterType +meta_later_add +meta_later_remove +
+ +
+window +MetaWindow +MetaWindowClass +MetaWindowType +MetaMaximizeFlags +meta_window_get_frame +meta_window_has_focus +meta_window_appears_focused +meta_window_is_shaded +meta_window_is_monitor_sized +meta_window_is_override_redirect +meta_window_is_skip_taskbar +meta_window_get_rect +meta_window_get_input_rect +meta_window_get_outer_rect +meta_window_get_screen +meta_window_get_display +meta_window_get_xwindow +meta_window_get_window_type +meta_window_get_window_type_atom +meta_window_get_workspace +meta_window_get_monitor +meta_window_is_on_all_workspaces +meta_window_located_on_workspace +meta_window_is_hidden +meta_window_activate +meta_window_activate_with_workspace +meta_window_get_description +meta_window_get_wm_class +meta_window_get_wm_class_instance +meta_window_showing_on_its_workspace +meta_window_get_gtk_application_id +meta_window_get_gtk_unique_bus_name +meta_window_get_gtk_application_object_path +meta_window_get_gtk_window_object_path +meta_window_get_gtk_app_menu_object_path +meta_window_get_gtk_menubar_object_path +meta_window_move +meta_window_move_frame +meta_window_move_resize_frame +meta_window_move_to_monitor +meta_window_resize +meta_window_set_demands_attention +meta_window_unset_demands_attention +meta_window_get_startup_id +meta_window_change_workspace_by_index +meta_window_change_workspace +meta_window_get_compositor_private +meta_window_set_compositor_private +meta_window_configure_notify +meta_window_get_role +meta_window_get_layer +meta_window_find_root_ancestor +meta_window_is_ancestor_of_transient +MetaWindowForeachFunc +meta_window_foreach_transient +meta_window_foreach_ancestor +meta_window_get_maximized +meta_window_is_fullscreen +meta_window_is_on_primary_monitor +meta_window_requested_bypass_compositor +meta_window_requested_dont_bypass_compositor +meta_window_is_mapped +meta_window_toplevel_is_mapped +meta_window_get_icon_geometry +meta_window_set_icon_geometry +meta_window_maximize +meta_window_unmaximize +meta_window_minimize +meta_window_unminimize +meta_window_raise +meta_window_lower +meta_window_get_title +meta_window_get_transient_for +meta_window_get_transient_for_as_xid +meta_window_delete +meta_window_get_stable_sequence +meta_window_get_user_time +meta_window_get_pid +meta_window_get_client_machine +meta_window_is_remote +meta_window_is_modal +meta_window_is_attached_dialog +meta_window_get_mutter_hints +meta_window_get_frame_type +meta_window_get_frame_bounds +meta_window_get_tile_match +meta_window_make_fullscreen +meta_window_unmake_fullscreen +meta_window_make_above +meta_window_unmake_above +meta_window_shade +meta_window_unshade +meta_window_stick +meta_window_unstick +meta_window_kill +meta_window_focus +meta_window_check_alive +meta_window_get_work_area_current_monitor +meta_window_get_work_area_for_monitor +meta_window_get_work_area_all_monitors +meta_window_begin_grab_op + +META_IS_WINDOW +META_IS_WINDOW_CLASS +META_TYPE_WINDOW +META_WINDOW +META_WINDOW_CLASS +META_WINDOW_GET_CLASS +meta_window_get_type +
+ +
+workspace +MetaWorkspace +MetaWorkspaceClass +meta_workspace_index +meta_workspace_get_screen +meta_workspace_list_windows +meta_workspace_get_work_area_for_monitor +meta_workspace_get_work_area_all_monitors +meta_workspace_activate +meta_workspace_activate_with_focus +meta_workspace_update_window_hints +meta_workspace_set_builtin_struts +meta_workspace_get_neighbor + +META_IS_WORKSPACE +META_IS_WORKSPACE_CLASS +META_TYPE_WORKSPACE +META_WORKSPACE +META_WORKSPACE_CLASS +META_WORKSPACE_GET_CLASS +meta_workspace_get_type +
+ diff --git a/src/compositor/compositor.c b/src/compositor/compositor.c index 413ee4f36..543c463eb 100644 --- a/src/compositor/compositor.c +++ b/src/compositor/compositor.c @@ -1,5 +1,11 @@ /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ +/** + * SECTION:compositor + * @Title: MetaCompositor + * @Short_Description: Compositor API + */ + #include #include diff --git a/src/core/keybindings.c b/src/core/keybindings.c index 6b9db0eb5..fc9a31ad0 100644 --- a/src/core/keybindings.c +++ b/src/core/keybindings.c @@ -23,6 +23,12 @@ * 02111-1307, USA. */ +/** + * SECTION:keybindings + * @Title: MetaKeybinding + * @Short_Description: Key bindings + */ + #define _GNU_SOURCE #define _SVID_SOURCE /* for putenv() */ diff --git a/src/core/window.c b/src/core/window.c index e915aa10e..073bde91f 100644 --- a/src/core/window.c +++ b/src/core/window.c @@ -3715,6 +3715,7 @@ meta_window_is_screen_sized (MetaWindow *window) /** * meta_window_is_monitor_sized: + * @window: a #MetaWindow * * Return value: %TRUE if the window is occupies an entire monitor or * the whole screen. diff --git a/src/meta/meta-shaped-texture.h b/src/meta/meta-shaped-texture.h index 815b3ac98..28fb5f603 100644 --- a/src/meta/meta-shaped-texture.h +++ b/src/meta/meta-shaped-texture.h @@ -48,8 +48,15 @@ struct _MetaShapedTextureClass ClutterActorClass parent_class; }; +/** + * MetaShapedTexture: + * + * The MetaShapedTexture structure contains + * only private data and should be accessed using the provided API + */ struct _MetaShapedTexture { + /*< private >*/ ClutterActor parent; MetaShapedTexturePrivate *priv; diff --git a/src/meta/prefs.h b/src/meta/prefs.h index 1723007e5..effb252da 100644 --- a/src/meta/prefs.h +++ b/src/meta/prefs.h @@ -380,12 +380,13 @@ typedef enum * @keycode: keycode * @modifiers: modifiers */ -typedef struct +typedef struct _MetaKeyCombo MetaKeyCombo; +struct _MetaKeyCombo { unsigned int keysym; unsigned int keycode; MetaVirtualModifier modifiers; -} MetaKeyCombo; +}; /** * MetaKeyHandlerFunc: