callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libgimpbase/Makefile.am libgimpbase/libgimpbase-docs.sgml do not generate

Browse Source 
2005-12-14  Sven Neumann  <sven@gimp.org>

	* libgimpbase/Makefile.am
	* libgimpbase/libgimpbase-docs.sgml
	* libgimpbase/libgimpbase-sections.txt: do not generate API docs
	for the private wire protocol API.

	* libgimp/libgimp-sections.txt: added new path API.

	* libgimpbase/tmpl/gimpprotocol.sgml
	* libgimpbase/tmpl/gimpwire.sgml: removed from CVS.

	* libgimp/tmpl/gimppaths.sgml
	* libgimpbase/tmpl/gimpenv.sgml: regenerated.
This commit is contained in:
Sven Neumann
2005-12-14 13:36:12 +00:00
committed by Sven Neumann
parent 4ec5642b50
commit 493cd140f8
12 changed files with 429 additions and 1046 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
devel-docs/libgimpbase/Makefile.am
View File

@ -29,7 +29,9 @@ CFILE_GLOB = $(DOC_SOURCE_DIR)/*.c
IGNORE_HFILES = \
gimpbase.h \
gimpbase-private.h \
gimpprotocol.h \
gimpreloc.h \
gimpwire.h \
gimpwin32-io.h
# Images to copy into HTML directory

2
devel-docs/libgimpbase/libgimpbase-docs.sgml
View File

@ -26,8 +26,6 @@
<xi:include href="xml/gimpsignal.xml" />
<xi:include href="xml/gimpunit.xml" />
<xi:include href="xml/gimputils.xml" />
<xi:include href="xml/gimpprotocol.xml" />
<xi:include href="xml/gimpwire.xml" />
</part>
<index>

62
devel-docs/libgimpbase/libgimpbase-sections.txt
View File

@ -110,6 +110,7 @@ gimp_checks_get_shades
<SECTION>
<FILE>gimpenv</FILE>
gimp_env_init
gimp_directory
gimp_personal_rc_file
gimp_data_directory
@ -180,35 +181,6 @@ gimp_pixpipe_params_parse
gimp_pixpipe_params_build
</SECTION>
<SECTION>
<FILE>gimpprotocol</FILE>
GIMP_PROTOCOL_VERSION
GPConfig
GPTileReq
GPTileAck
GPTileData
GPParam
GPParamDef
GPProcRun
GPProcReturn
GPProcInstall
GPProcUninstall
gp_init
gp_has_init_write
gp_quit_write
gp_config_write
gp_tile_req_write
gp_tile_ack_write
gp_tile_data_write
gp_proc_run_write
gp_proc_return_write
gp_temp_proc_run_write
gp_temp_proc_return_write
gp_proc_install_write
gp_proc_uninstall_write
gp_extension_ack_write
</SECTION>
<SECTION>
<FILE>gimpsignal</FILE>
GimpSignalHandlerFunc
@ -258,38 +230,6 @@ gimp_flags_value_get_desc
gimp_flags_value_get_help
</SECTION>
<SECTION>
<FILE>gimpwire</FILE>
WireMessage
WireReadFunc
WireWriteFunc
WireDestroyFunc
WireIOFunc
WireFlushFunc
wire_register
wire_set_reader
wire_set_writer
wire_set_flusher
wire_read
wire_write
wire_flush
wire_error
wire_clear_error
wire_read_msg
wire_write_msg
wire_destroy
wire_read_int32
wire_read_int16
wire_read_int8
wire_read_double
wire_read_string
wire_write_int32
wire_write_int16
wire_write_int8
wire_write_double
wire_write_string
</SECTION>
<SECTION>
<FILE>gimpversion</FILE>
GIMP_MAJOR_VERSION

10
devel-docs/libgimpbase/tmpl/gimpenv.sgml
View File

@ -18,6 +18,16 @@ configuration files.
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION gimp_env_init ##### -->
<para>
</para>
@plug_in:
<!-- # Unused Parameters # -->
@library:
<!-- ##### FUNCTION gimp_directory ##### -->
<para>

297
devel-docs/libgimpbase/tmpl/gimpprotocol.sgml
View File

@ -1,297 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpprotocol
<!-- ##### SECTION Short_Description ##### -->
The communication protocol between GIMP and it's plug-ins.
<!-- ##### SECTION Long_Description ##### -->
<para>
The communication protocol between GIMP and it's plug-ins.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#libgimp-gimpwire
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO GIMP_PROTOCOL_VERSION ##### -->
<para>
</para>
<!-- ##### STRUCT GPConfig ##### -->
<para>
</para>
@version:
@tile_width:
@tile_height:
@shm_ID:
@check_size:
@check_type:
@show_help_button:
@gimp_reserved_4:
@gimp_reserved_5:
@gimp_reserved_6:
@gimp_reserved_7:
@gimp_reserved_8:
@install_cmap:
@show_tool_tips:
@min_colors:
@gdisp_ID:
@app_name:
@wm_class:
@display_name:
@monitor_number:
<!-- ##### STRUCT GPTileReq ##### -->
<para>
</para>
@drawable_ID:
@tile_num:
@shadow:
<!-- ##### STRUCT GPTileAck ##### -->
<para>
</para>
<!-- ##### STRUCT GPTileData ##### -->
<para>
</para>
@drawable_ID:
@tile_num:
@shadow:
@bpp:
@width:
@height:
@use_shm:
@data:
<!-- ##### STRUCT GPParam ##### -->
<para>
</para>
@type:
@d_display:
@d_image:
@d_layer:
@d_channel:
@d_drawable:
@d_selection:
@d_boundary:
@d_path:
@d_status:
<!-- ##### STRUCT GPParamDef ##### -->
<para>
</para>
@type:
@name:
@description:
<!-- ##### STRUCT GPProcRun ##### -->
<para>
</para>
@name:
@nparams:
@params:
<!-- ##### STRUCT GPProcReturn ##### -->
<para>
</para>
@name:
@nparams:
@params:
<!-- ##### STRUCT GPProcInstall ##### -->
<para>
</para>
@name:
@blurb:
@help:
@author:
@copyright:
@date:
@menu_path:
@image_types:
@type:
@nparams:
@nreturn_vals:
@params:
@return_vals:
<!-- ##### STRUCT GPProcUninstall ##### -->
<para>
</para>
@name:
<!-- ##### FUNCTION gp_init ##### -->
<para>
</para>
<!-- ##### FUNCTION gp_has_init_write ##### -->
<para>
</para>
@channel:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_quit_write ##### -->
<para>
</para>
@channel:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_config_write ##### -->
<para>
</para>
@channel:
@config:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_tile_req_write ##### -->
<para>
</para>
@channel:
@tile_req:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_tile_ack_write ##### -->
<para>
</para>
@channel:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_tile_data_write ##### -->
<para>
</para>
@channel:
@tile_data:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_proc_run_write ##### -->
<para>
</para>
@channel:
@proc_run:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_proc_return_write ##### -->
<para>
</para>
@channel:
@proc_return:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_temp_proc_run_write ##### -->
<para>
</para>
@channel:
@proc_run:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_temp_proc_return_write ##### -->
<para>
</para>
@channel:
@proc_return:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_proc_install_write ##### -->
<para>
</para>
@channel:
@proc_install:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_proc_uninstall_write ##### -->
<para>
</para>
@channel:
@proc_uninstall:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_extension_ack_write ##### -->
<para>
</para>
@channel:
@user_data:
@Returns:

314
devel-docs/libgimpbase/tmpl/gimpwire.sgml
View File

@ -1,314 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpwire
<!-- ##### SECTION Short_Description ##### -->
The lowlevel I/O protocol used for communication between GIMP and
it's plug-ins.
<!-- ##### SECTION Long_Description ##### -->
<para>
The lowlevel I/O protocol used for communication between GIMP and
it's plug-ins.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#libgimp-gimpprotocol
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT WireMessage ##### -->
<para>
</para>
@type:
@data:
<!-- ##### USER_FUNCTION WireReadFunc ##### -->
<para>
</para>
@channel:
@msg:
@user_data:
<!-- ##### USER_FUNCTION WireWriteFunc ##### -->
<para>
</para>
@channel:
@msg:
@user_data:
<!-- ##### USER_FUNCTION WireDestroyFunc ##### -->
<para>
</para>
@msg:
<!-- ##### USER_FUNCTION WireIOFunc ##### -->
<para>
</para>
@channel:
@buf:
@count:
@user_data:
@Returns:
<!-- ##### USER_FUNCTION WireFlushFunc ##### -->
<para>
</para>
@channel:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_register ##### -->
<para>
</para>
@type:
@read_func:
@write_func:
@destroy_func:
<!-- ##### FUNCTION wire_set_reader ##### -->
<para>
</para>
@read_func:
<!-- ##### FUNCTION wire_set_writer ##### -->
<para>
</para>
@write_func:
<!-- ##### FUNCTION wire_set_flusher ##### -->
<para>
</para>
@flush_func:
<!-- ##### FUNCTION wire_read ##### -->
<para>
</para>
@channel:
@buf:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_write ##### -->
<para>
</para>
@channel:
@buf:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_flush ##### -->
<para>
</para>
@channel:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_error ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION wire_clear_error ##### -->
<para>
</para>
<!-- ##### FUNCTION wire_read_msg ##### -->
<para>
</para>
@channel:
@msg:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_write_msg ##### -->
<para>
</para>
@channel:
@msg:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_destroy ##### -->
<para>
</para>
@msg:
<!-- ##### FUNCTION wire_read_int32 ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_read_int16 ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_read_int8 ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_read_double ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_read_string ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_write_int32 ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_write_int16 ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_write_int8 ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_write_double ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_write_string ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns: