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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -5,6 +5,11 @@
* libgimp/gimp.c (gimp_destroy_params): removed extern declaration.
* libgimpbase/gimpenv.h: changed parameter name to match what's
used in gimpenv.c.
* libgimpbase/gimpreloc.c: changed comments to please gtk-doc.
2005-12-13 Sven Neumann <sven@gimp.org>
* libgimpbase/gimpwire.[ch]: let the private wire methods live in

15
devel-docs/ChangeLog
View File

@ -1,3 +1,18 @@
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.
2005-11-06 Sven Neumann <sven@gimp.org>
* devel-docs/libgimpbase/Makefile.am: ignore gimpreloc.h.

2
devel-docs/libgimp/libgimp-sections.txt
View File

@ -659,6 +659,8 @@ gimp_get_path_by_tattoo
gimp_path_delete
gimp_path_get_locked
gimp_path_set_locked
gimp_path_get_visible
gimp_path_set_visible
gimp_path_set_tattoo
gimp_path_to_selection
gimp_path_import

21
devel-docs/libgimp/tmpl/gimppaths.sgml
View File

@ -144,6 +144,27 @@ Operations related to paths.
@Returns:
<!-- ##### FUNCTION gimp_path_get_visible ##### -->
<para>
</para>
@image_ID:
@name:
@Returns:
<!-- ##### FUNCTION gimp_path_set_visible ##### -->
<para>
</para>
@image_ID:
@name:
@visible:
@Returns:
<!-- ##### FUNCTION gimp_path_set_tattoo ##### -->
<para>

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:

2
libgimpbase/gimpenv.h
View File

@ -48,7 +48,7 @@ gchar * gimp_path_get_user_writable_dir (GList *path);
/* should be considered private, don't use! */
void gimp_env_init (gboolean library);
void gimp_env_init (gboolean plug_in);
G_END_DECLS

33
libgimpbase/gimpreloc.c
View File

@ -28,7 +28,7 @@
#include "gimpreloc.h"
/** @internal
/*
* Find the canonical filename of the executable. Returns the filename
* (which must be freed) or NULL on error. If the parameter 'error' is
* not NULL, the error code will be stored there, if an error occured.
@ -168,7 +168,7 @@ _br_find_exe (GimpBinrelocInitError *error)
}
/** @internal
/*
* Find the canonical filename of the executable which owns symbol.
* Returns a filename which must be freed, or NULL on error.
*/
@ -281,7 +281,7 @@ static gchar *exe = NULL;
static void set_gerror (GError **error, GimpBinrelocInitError errcode);
/** Initialize the BinReloc library (for applications).
/* Initialize the BinReloc library (for applications).
*
* This function must be called before using any other BinReloc functions.
* It attempts to locate the application's canonical filename.
@ -319,7 +319,7 @@ _gimp_reloc_init (GError **error)
}
/** Initialize the BinReloc library (for libraries).
/* Initialize the BinReloc library (for libraries).
*
* This function must be called before using any other BinReloc functions.
* It attempts to locate the calling library's canonical filename.
@ -383,7 +383,7 @@ set_gerror (GError **error, GimpBinrelocInitError errcode)
}
/** Find the canonical filename of the current application.
/* Find the canonical filename of the current application.
*
* @param default_exe A default filename which will be used as fallback.
* @returns A string containing the application's canonical filename,
@ -406,7 +406,7 @@ _gimp_reloc_find_exe (const gchar *default_exe)
}
/** Locate the directory in which the current application is installed.
/* Locate the directory in which the current application is installed.
*
* The prefix is generated by the following pseudo-code evaluation:
* \code
@ -435,7 +435,7 @@ _gimp_reloc_find_exe_dir (const gchar *default_dir)
}
/** Locate the prefix in which the current application is installed.
/* Locate the prefix in which the current application is installed.
*
* The prefix is generated by the following pseudo-code evaluation:
* \code
@ -469,7 +469,7 @@ _gimp_reloc_find_prefix (const gchar *default_prefix)
}
/** Locate the application's binary folder.
/* Locate the application's binary folder.
*
* The path is generated by the following pseudo-code evaluation:
* \code
@ -502,7 +502,7 @@ _gimp_reloc_find_bin_dir (const gchar *default_bin_dir)
}
/** Locate the application's data folder.
/* Locate the application's data folder.
*
* The path is generated by the following pseudo-code evaluation:
* \code
@ -561,7 +561,7 @@ _gimp_reloc_find_plugin_dir (const gchar *default_plugin_dir)
}
/** Locate the application's localization folder.
/* Locate the application's localization folder.
*
* The path is generated by the following pseudo-code evaluation:
* \code
@ -594,7 +594,7 @@ _gimp_reloc_find_locale_dir (const gchar *default_locale_dir)
}
/** Locate the application's library folder.
/* Locate the application's library folder.
*
* The path is generated by the following pseudo-code evaluation:
* \code
@ -627,7 +627,7 @@ _gimp_reloc_find_lib_dir (const gchar *default_lib_dir)
}
/** Locate the application's libexec folder.
/* Locate the application's libexec folder.
*
* The path is generated by the following pseudo-code evaluation:
* \code
@ -660,7 +660,7 @@ _gimp_reloc_find_libexec_dir (const gchar *default_libexec_dir)
}
/** Locate the application's configuration files folder.
/* Locate the application's configuration files folder.
*
* The path is generated by the following pseudo-code evaluation:
* \code
@ -669,9 +669,10 @@ _gimp_reloc_find_libexec_dir (const gchar *default_libexec_dir)
*
* @param default_etc_dir A default path which will used as fallback.
* @return A string containing the etc folder's path, which must be freed when
* no longer necessary. If BinReloc is not initialized, or if the initialization
* function failed, then a copy of default_etc_dir will be returned.
* If default_etc_dir is NULL, then NULL will be returned.
* no longer necessary. If BinReloc is not initialized, or if the
* initialization function failed, then a copy of default_etc_dir
* will be returned. If default_etc_dir is NULL, then NULL will be
* returned.
*/
gchar *
_gimp_reloc_find_etc_dir (const gchar *default_etc_dir)