app/app-docs.sgml some updates.

2006-12-04 Sven Neumann <sven@gimp.org> * app/app-docs.sgml * app/app-sections.txt: some updates.
2006-12-04 11:08:46 +00:00
parent 952b35d7bf
commit adf564e819
3 changed files with 292 additions and 176 deletions
--- a/devel-docs/app/app-docs.sgml
+++ b/devel-docs/app/app-docs.sgml
@ -19,7 +19,7 @@
  <part id="app-glue-part">
    <title>Application Glue</title>

-    <partintro>
+    <partintro id="app-glue-part-intro">
      <para>
        The stuff in the toplevel source directory. Initializes and shuts
        down the application, parses the command line. It's the "glue"
@ -294,7 +294,7 @@
  <part id="app-file-part">
    <title>File</title>

-    <partintro>
+    <partintro id="app-file-part-intro">
      <para>
        Functions to open and save images in any registered file format
        as well as various image file related utility functions.
@ -325,7 +325,7 @@
  <part id="app-xcf-part">
    <title>XCF</title>

-    <partintro>
+    <partintro id="app-xcf-part-intro">
      <para>
        Functions to open and save images in GIMP's native "XCF" format.
      </para>
@ -349,9 +349,9 @@

  <part id="app-pdb-part">
    <title>Procedural Database</title>
-    <xi:include href="xml/gimp-pdb.xml" />
+    <xi:include href="xml/gimppdb.xml" />
+    <xi:include href="xml/gimppdb-query.xml" />
    <xi:include href="xml/gimp-pdb-compat.xml" />
-    <xi:include href="xml/gimp-pdb-query.xml" />
    <xi:include href="xml/gimpprocedure.xml" />
    <xi:include href="xml/gimppluginprocedure.xml" />
    <xi:include href="xml/gimptemporaryprocedure.xml" />
@ -361,29 +361,32 @@
  <part id="app-plug-in-part">
    <title>Plug-Ins</title>
    <xi:include href="xml/plug-in-types.xml" />
+    <xi:include href="xml/plug-in-params.xml" />

    <chapter id="app-plug-in-management">
      <title>Initialization &amp; Plug-In Management</title>
-      <xi:include href="xml/plug-ins.xml" />
-      <xi:include href="xml/plug-ins-query.xml" />
      <xi:include href="xml/plug-in-def.xml" />
-      <xi:include href="xml/plug-in-proc-frame.xml" />
      <xi:include href="xml/plug-in-rc.xml" />
-      <xi:include href="xml/plug-in-data.xml" />
-      <xi:include href="xml/plug-in-menu-branch.xml" />
-      <xi:include href="xml/plug-in-help-domain.xml" />
-      <xi:include href="xml/plug-in-locale-domain.xml" />
+      <xi:include href="xml/gimppluginmanager.xml" />
+      <xi:include href="xml/gimppluginmanager-call.xml" />
+      <xi:include href="xml/gimppluginmanager-history.xml" />
+      <xi:include href="xml/gimppluginmanager-data.xml" />
+      <xi:include href="xml/gimppluginmanager-file.xml" />
+      <xi:include href="xml/gimppluginmanager-help-domain.xml" />
+      <xi:include href="xml/gimppluginmanager-locale-domain.xml" />
+      <xi:include href="xml/gimppluginmanager-menu-branch.xml" />
+      <xi:include href="xml/gimppluginmanager-query.xml" />
    </chapter>

    <chapter id="app-plug-in-execution">
      <title>Plug-In Execution</title>
-      <xi:include href="xml/plug-in.xml" />   
-      <xi:include href="xml/plug-in-context.xml" />
-      <xi:include href="xml/plug-in-message.xml" />
-      <xi:include href="xml/plug-in-params.xml" />
-      <xi:include href="xml/plug-in-progress.xml" />
-      <xi:include href="xml/plug-in-run.xml" />
-      <xi:include href="xml/plug-in-shm.xml" />
+      <xi:include href="xml/gimpplugin.xml" />
+      <xi:include href="xml/gimpplugin-context.xml" />
+      <xi:include href="xml/gimpplugin-cleanup.xml" />
+      <xi:include href="xml/gimpplugin-message.xml" />
+      <xi:include href="xml/gimpplugin-progress.xml" />
+      <xi:include href="xml/gimppluginprocframe.xml" />
+      <xi:include href="xml/gimppluginshm.xml" />
    </chapter>
  </part>

@ -401,6 +404,7 @@
      <xi:include href="xml/gimppaintoptions.xml" />
      <xi:include href="xml/gimpbrushcore.xml" />
      <xi:include href="xml/gimpbrushcore-kernels.xml" />
+      <xi:include href="xml/gimpsourcecore.xml" />
    </chapter>

    <chapter id="app-paint-implementations">
@ -415,6 +419,7 @@
      <xi:include href="xml/gimpdodgeburnoptions.xml" />
      <xi:include href="xml/gimperaser.xml" />
      <xi:include href="xml/gimperaseroptions.xml" />
+      <xi:include href="xml/gimpheal.xml" />
      <xi:include href="xml/gimpink.xml" />
      <xi:include href="xml/gimpink-blob.xml" />
      <xi:include href="xml/gimpinkoptions.xml" />
@ -562,9 +567,11 @@
      <xi:include href="xml/gimpconvolvetool.xml" />
      <xi:include href="xml/gimpdodgeburntool.xml" />
      <xi:include href="xml/gimperasertool.xml" />
+      <xi:include href="xml/gimphealtool.xml" />
      <xi:include href="xml/gimpinktool.xml" />
      <xi:include href="xml/gimppaintbrushtool.xml" />
      <xi:include href="xml/gimppenciltool.xml" />
+      <xi:include href="xml/gimpperspectiveclonetool.xml" />
      <xi:include href="xml/gimpsmudgetool.xml" />
    </chapter>

--- a/devel-docs/app/app-sections.txt
+++ b/devel-docs/app/app-sections.txt
@ -2401,6 +2401,38 @@ KERNEL_SUBSAMPLE
 KERNEL_SUM
 </SECTION>

+<SECTION>
+<FILE>gimpsourcecore</FILE>
+<TITLE>GimpSourceCore</TITLE>
+GimpSourceCore
+gimp_source_core_motion
+<SUBSECTION Standard>
+GimpSourceCoreClass
+GIMP_SOURCE_CORE
+GIMP_IS_SOURCE_CORE
+GIMP_TYPE_SOURCE_CORE
+gimp_source_core_get_type
+GIMP_SOURCE_CORE_CLASS
+GIMP_IS_SOURCE_CORE_CLASS
+GIMP_SOURCE_CORE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gimpheal</FILE>
+<TITLE>GimpHeal</TITLE>
+GimpHeal
+gimp_heal_register
+<SUBSECTION Standard>
+GimpHealClass
+GIMP_HEAL
+GIMP_IS_HEAL
+GIMP_TYPE_HEAL
+gimp_heal_get_type
+GIMP_HEAL_CLASS
+GIMP_IS_HEAL_CLASS
+GIMP_HEAL_GET_CLASS
+</SECTION>
+
 <SECTION>
 <FILE>gimpink</FILE>
 DIST_SMOOTHER_BUFFER
@ -3187,6 +3219,22 @@ GIMP_IS_FUZZY_SELECT_TOOL_CLASS
 GIMP_FUZZY_SELECT_TOOL_GET_CLASS
 </SECTION>

+<SECTION>
+<FILE>gimphealtool</FILE>
+<TITLE>GimpHealTool</TITLE>
+GimpHealTool
+gimp_heal_tool_register
+<SUBSECTION Standard>
+GimpHealToolClass
+GIMP_HEAL_TOOL
+GIMP_IS_HEAL_TOOL
+GIMP_TYPE_HEAL_TOOL
+gimp_heal_tool_get_type
+GIMP_HEAL_TOOL_CLASS
+GIMP_IS_HEAL_TOOL_CLASS
+GIMP_HEAL_TOOL_GET_CLASS
+</SECTION>
+
 <SECTION>
 <FILE>gimphistogramoptions</FILE>
 <TITLE>GimpHistogramOptions</TITLE>
@ -3472,6 +3520,23 @@ GIMP_IS_PERSPECTIVE_TOOL_CLASS
 GIMP_PERSPECTIVE_TOOL_GET_CLASS
 </SECTION>

+<SECTION>
+<FILE>gimpperspectiveclonetool</FILE>
+<TITLE>GimpPerspectiveCloneTool</TITLE>
+GimpPerspectiveCloneTool
+gimp_perspective_clone_tool_register
+GIMP_PERSPECTIVE_CLONE_TOOL_GET_OPTIONS
+<SUBSECTION Standard>
+GimpPerspectiveCloneToolClass
+GIMP_PERSPECTIVE_CLONE_TOOL
+GIMP_IS_PERSPECTIVE_CLONE_TOOL
+GIMP_TYPE_PERSPECTIVE_CLONE_TOOL
+gimp_perspective_clone_tool_get_type
+GIMP_PERSPECTIVE_CLONE_TOOL_CLASS
+GIMP_IS_PERSPECTIVE_CLONE_TOOL_CLASS
+GIMP_PERSPECTIVE_CLONE_TOOL_GET_CLASS
+</SECTION>
+
 <SECTION>
 <FILE>gimpposterizetool</FILE>
 <TITLE>GimpPosterizeTool</TITLE>
@ -3802,8 +3867,6 @@ GIMP_TRANSFORM_OPTIONS_GET_CLASS
 <SECTION>
 <FILE>gimptransformtool</FILE>
 <TITLE>GimpTransformTool</TITLE>
-MAX_INFO_BUF
-TRAN_INFO_SIZE
 TransInfo
 GimpTransformTool
 gimp_transform_tool_recalc
@ -7813,18 +7876,6 @@ plug_in_def_set_needs_query
 plug_in_def_set_has_init
 </SECTION>

-<SECTION>
-<FILE>gimp-pdb</FILE>
-gimp_pdb_init
-gimp_pdb_exit
-gimp_pdb_init_procs
-gimp_pdb_register
-gimp_pdb_unregister
-gimp_pdb_lookup
-gimp_pdb_execute
-gimp_pdb_run_proc
-</SECTION>
-
 <SECTION>
 <FILE>gimp-pdb-compat</FILE>
 gimp_pdb_compat_param_spec
@ -7912,9 +7963,200 @@ GIMP_PLUG_IN_PROCEDURE_GET_CLASS
 </SECTION>

 <SECTION>
-<FILE>plug-in-message</FILE>
-<TITLE>PlugIn-message</TITLE>
-plug_in_handle_message
+<FILE>gimppdb</FILE>
+<TITLE>GimpPDB</TITLE>
+GimpPDB
+gimp_pdb_new
+gimp_pdb_register_procedure
+gimp_pdb_unregister_procedure
+gimp_pdb_lookup_procedure
+gimp_pdb_register_compat_proc_name
+gimp_pdb_lookup_compat_proc_name
+gimp_pdb_execute_procedure_by_name_args
+gimp_pdb_execute_procedure_by_name
+<SUBSECTION Standard>
+GimpPDBClass
+GIMP_PDB
+GIMP_IS_PDB
+GIMP_TYPE_PDB
+gimp_pdb_get_type
+GIMP_PDB_CLASS
+GIMP_IS_PDB_CLASS
+GIMP_PDB_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gimppdb-query</FILE>
+gimp_pdb_dump
+gimp_pdb_query
+gimp_pdb_proc_info
+</SECTION>
+
+<SECTION>
+<FILE>gimpplugin</FILE>
+<TITLE>GimpPlugIn</TITLE>
+GimpPlugIn
+gimp_plug_in_new
+gimp_plug_in_open
+gimp_plug_in_close
+gimp_plug_in_get_proc_frame
+gimp_plug_in_proc_frame_push
+gimp_plug_in_proc_frame_pop
+gimp_plug_in_main_loop
+gimp_plug_in_main_loop_quit
+gimp_plug_in_get_undo_desc
+gimp_plug_in_menu_register
+gimp_plug_in_add_temp_proc
+gimp_plug_in_remove_temp_proc
+WRITE_BUFFER_SIZE
+<SUBSECTION Standard>
+GimpPlugInClass
+GIMP_PLUG_IN
+GIMP_IS_PLUG_IN
+GIMP_TYPE_PLUG_IN
+gimp_plug_in_get_type
+GIMP_PLUG_IN_CLASS
+GIMP_IS_PLUG_IN_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gimpplugin-message</FILE>
+gimp_plug_in_handle_message
+</SECTION>
+
+<SECTION>
+<FILE>gimpplugin-progress</FILE>
+gimp_plug_in_progress_attach
+gimp_plug_in_progress_detach
+gimp_plug_in_progress_start
+gimp_plug_in_progress_end
+gimp_plug_in_progress_set_text
+gimp_plug_in_progress_set_value
+gimp_plug_in_progress_pulse
+gimp_plug_in_progress_get_window
+gimp_plug_in_progress_install
+gimp_plug_in_progress_uninstall
+gimp_plug_in_progress_cancel
+</SECTION>
+
+<SECTION>
+<FILE>gimppluginprocframe</FILE>
+GimpPlugInProcFrame
+gimp_plug_in_proc_frame_new
+gimp_plug_in_proc_frame_init
+gimp_plug_in_proc_frame_dispose
+gimp_plug_in_proc_frame_ref
+gimp_plug_in_proc_frame_unref
+gimp_plug_in_proc_frame_get_return_vals
+</SECTION>
+
+<SECTION>
+<FILE>gimpplugin-cleanup</FILE>
+gimp_plug_in_cleanup_undo_group_start
+gimp_plug_in_cleanup_undo_group_end
+gimp_plug_in_cleanup
+</SECTION>
+
+<SECTION>
+<FILE>gimpplugin-context</FILE>
+gimp_plug_in_context_push
+gimp_plug_in_context_pop
+</SECTION>
+
+<SECTION>
+<FILE>gimppluginshm</FILE>
+GimpPlugInShm
+gimp_plug_in_shm_new
+gimp_plug_in_shm_free
+gimp_plug_in_shm_get_ID
+gimp_plug_in_shm_get_addr
+</SECTION>
+
+<SECTION>
+<FILE>gimppluginmanager</FILE>
+<TITLE>GimpPlugInManager</TITLE>
+GimpPlugInManager
+gimp_plug_in_manager_new
+gimp_plug_in_manager_initialize
+gimp_plug_in_manager_restore
+gimp_plug_in_manager_exit
+gimp_plug_in_manager_add_procedure
+gimp_plug_in_manager_add_temp_proc
+gimp_plug_in_manager_remove_temp_proc
+gimp_plug_in_manager_add_open_plug_in
+gimp_plug_in_manager_remove_open_plug_in
+gimp_plug_in_manager_plug_in_push
+gimp_plug_in_manager_plug_in_pop
+gimp_plug_in_manager_history_changed
+gimp_plug_in_manager_get_label
+<SUBSECTION Standard>
+GimpPlugInManagerClass
+GIMP_PLUG_IN_MANAGER
+GIMP_IS_PLUG_IN_MANAGER
+GIMP_TYPE_PLUG_IN_MANAGER
+gimp_plug_in_manager_get_type
+GIMP_PLUG_IN_MANAGER_CLASS
+GIMP_IS_PLUG_IN_MANAGER_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gimppluginmanager-call</FILE>
+gimp_plug_in_manager_call_query
+gimp_plug_in_manager_call_init
+gimp_plug_in_manager_call_run
+gimp_plug_in_manager_call_run_temp
+</SECTION>
+
+<SECTION>
+<FILE>gimppluginmanager-history</FILE>
+gimp_plug_in_manager_history_size
+gimp_plug_in_manager_history_length
+gimp_plug_in_manager_history_nth
+gimp_plug_in_manager_history_add
+gimp_plug_in_manager_history_remove
+gimp_plug_in_manager_history_clear
+</SECTION>
+
+<SECTION>
+<FILE>gimppluginmanager-data</FILE>
+gimp_plug_in_manager_data_free
+gimp_plug_in_manager_set_data
+gimp_plug_in_manager_get_data
+</SECTION>
+
+<SECTION>
+<FILE>gimppluginmanager-file</FILE>
+gimp_plug_in_manager_register_load_handler
+gimp_plug_in_manager_register_save_handler
+gimp_plug_in_manager_register_mime_type
+gimp_plug_in_manager_register_thumb_loader
+</SECTION>
+
+<SECTION>
+<FILE>gimppluginmanager-help-domain</FILE>
+gimp_plug_in_manager_help_domain_exit
+gimp_plug_in_manager_add_help_domain
+gimp_plug_in_manager_get_help_domain
+gimp_plug_in_manager_get_help_domains
+</SECTION>
+
+<SECTION>
+<FILE>gimppluginmanager-locale-domain</FILE>
+gimp_plug_in_manager_locale_domain_exit
+gimp_plug_in_manager_add_locale_domain
+gimp_plug_in_manager_get_locale_domain
+gimp_plug_in_manager_get_locale_domains
+</SECTION>
+
+<SECTION>
+<FILE>gimppluginmanager-menu-branch</FILE>
+gimp_plug_in_manager_menu_branch_exit
+gimp_plug_in_manager_add_menu_branch
+</SECTION>
+
+<SECTION>
+<FILE>gimppluginmanager-query</FILE>
+gimp_plug_in_manager_query
 </SECTION>

 <SECTION>
@ -7924,40 +8166,6 @@ plug_in_params_to_args
 plug_in_args_to_params
 </SECTION>

-<SECTION>
-<FILE>plug-in-proc-frame</FILE>
-<TITLE>PlugIn-proc-frame</TITLE>
-PlugInProcFrame
-plug_in_proc_frame_new
-plug_in_proc_frame_init
-plug_in_proc_frame_ref
-plug_in_proc_frame_unref
-plug_in_proc_frame_dispose
-plug_in_proc_frame_get_return_vals
-</SECTION>
-
-<SECTION>
-<FILE>plug-in-context</FILE>
-<TITLE>PlugIn-context</TITLE>
-plug_in_context_push
-plug_in_context_pop
-</SECTION>
-
-<SECTION>
-<FILE>plug-in-progress</FILE>
-<TITLE>PlugIn-progress</TITLE>
-plug_in_progress_start
-plug_in_progress_end
-plug_in_progress_set_text
-plug_in_progress_set_value
-plug_in_progress_pulse
-plug_in_progress_get_window
-plug_in_progress_install
-plug_in_progress_uninstall
-plug_in_progress_cancel
-plug_in_progress_message
-</SECTION>
-
 <SECTION>
 <FILE>plug-in-rc</FILE>
 <TITLE>PlugIn-rc</TITLE>
@ -7965,105 +8173,10 @@ plug_in_rc_parse
 plug_in_rc_write
 </SECTION>

-<SECTION>
-<FILE>plug-in-run</FILE>
-<TITLE>PlugIn-run</TITLE>
-plug_in_run
-plug_in_run_temp
-</SECTION>
-
-<SECTION>
-<FILE>plug-in-shm</FILE>
-<TITLE>PlugIn-shm</TITLE>
-plug_in_shm_init
-plug_in_shm_exit
-plug_in_shm_get_ID
-plug_in_shm_get_addr
-</SECTION>
-
 <SECTION>
 <FILE>plug-in-types</FILE>
-PlugInImageType
-PlugInShm
-</SECTION>
-
-<SECTION>
-<FILE>plug-in</FILE>
-<TITLE>PlugIn</TITLE>
-WRITE_BUFFER_SIZE
-PlugIn
-plug_in_init
-plug_in_exit
-plug_in_call_query
-plug_in_call_init
-plug_in_new
-plug_in_ref
-plug_in_unref
-plug_in_open
-plug_in_close
-plug_in_push
-plug_in_pop
-plug_in_main_loop
-plug_in_main_loop_quit
-plug_in_get_undo_desc
-plug_in_get_proc_frame
-plug_in_proc_frame_push
-plug_in_proc_frame_pop
-plug_in_add_temp_proc
-plug_in_remove_temp_proc
-plug_in_menu_register
-</SECTION>
-
-<SECTION>
-<FILE>plug-ins</FILE>
-plug_ins_init
-plug_ins_exit
-plug_ins_procedure_add
-plug_ins_temp_procedure_add
-plug_ins_temp_procedure_remove
-</SECTION>
-
-<SECTION>
-<FILE>plug-ins-query</FILE>
-plug_ins_query
-</SECTION>
-
-<SECTION>
-<FILE>plug-in-data</FILE>
-plug_in_data_free
-plug_in_data_set
-plug_in_data_get
-</SECTION>
-
-<SECTION>
-<FILE>plug-in-file</FILE>
-plug_in_file_register_load_handler
-plug_in_file_register_save_handler
-plug_in_file_register_mime_type
-plug_in_file_register_thumb_loader
-</SECTION>
-
-<SECTION>
-<FILE>plug-in-menu-branch</FILE>
-PlugInMenuBranch
-plug_in_menu_branch_exit
-plug_in_menu_branch_add
-</SECTION>
-
-<SECTION>
-<FILE>plug-in-locale-domain</FILE>
-plug_in_locale_domain_exit
-plug_in_locale_domain_add
-plug_in_locale_domain
-plug_in_standard_locale_domain
-</SECTION>
-
-<SECTION>
-<FILE>plug-in-help-domain</FILE>
-plug_in_help_domain_exit
-plug_in_help_domain_add
-plug_in_help_domain
-plug_in_help_domains
+GimpPlugInMenuBranch
+PlugInDef
 </SECTION>

 <SECTION>
@ -8143,8 +8256,6 @@ GimpTransformGridType
 TransformAction
 <SUBSECTION Standard>
 gimp_color_pick_mode_get_type
-gimp_crop_mode_get_type
-gimp_rectangle_mode_get_type
 gimp_rect_select_mode_get_type
 gimp_transform_type_get_type
 gimp_vector_mode_get_type
@ -8680,10 +8791,6 @@ patterns_actions_update
 <FILE>plug-in-actions</FILE>
 plug_in_actions_setup
 plug_in_actions_update
-plug_in_actions_add_proc
-plug_in_actions_remove_proc
-plug_in_actions_add_path
-plug_in_actions_add_branch
 </SECTION>

 <SECTION>
@ -9210,10 +9317,7 @@ image_menu_setup

 <SECTION>
 <FILE>plug-in-menus</FILE>
-plug_in_menus_init
 plug_in_menus_setup
-plug_in_menus_add_proc
-plug_in_menus_remove_proc
 </SECTION>

 <SECTION>