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

added gtk-doc comment for gimp_enums_get_type_names().

Browse Source 
2004-10-26  Sven Neumann  <sven@gimp.org>

	* tools/pdbgen/enumcode.pl: added gtk-doc comment for
	gimp_enums_get_type_names().


Updated API docs.
This commit is contained in:
Sven Neumann
2004-10-26 18:58:50 +00:00
committed by Sven Neumann
parent 2524ba60da
commit c588e8e58e
7 changed files with 246 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
2004-10-26 Sven Neumann <sven@gimp.org>
* tools/pdbgen/enumcode.pl: added gtk-doc comment for
gimp_enums_get_type_names().
2004-10-26 Sven Neumann <sven@gimp.org> 2004-10-26 Sven Neumann <sven@gimp.org>
* plug-ins/common/retinex.c: applied patch by Geert Jordaens that * plug-ins/common/retinex.c: applied patch by Geert Jordaens that

9
devel-docs/ChangeLog
View File

@ -1,3 +1,12 @@
2004-10-26 Sven Neumann <sven@gimp.org>
* libgimp/tmpl/gimpdrawabletransform.sgml: new file.
* libgimp/libgimp-docs.sgml
* libgimp/libgimp-sections.txt: updated.
* libgimp/tmpl/gimpenums.sgml: regenerated.
2004-10-25 Sven Neumann <sven@gimp.org> 2004-10-25 Sven Neumann <sven@gimp.org>
* libgimp/libgimp-sections.txt: skip types for registered enums. * libgimp/libgimp-sections.txt: skip types for registered enums.

1
devel-docs/libgimp/libgimp-docs.sgml
View File

@ -36,6 +36,7 @@
<xi:include href="xml/gimpconvert.xml" /> <xi:include href="xml/gimpconvert.xml" />
<xi:include href="xml/gimpdisplay.xml" /> <xi:include href="xml/gimpdisplay.xml" />
<xi:include href="xml/gimpdrawable.xml" /> <xi:include href="xml/gimpdrawable.xml" />
<xi:include href="xml/gimpdrawabletransform.xml" />
<xi:include href="xml/gimpedit.xml" /> <xi:include href="xml/gimpedit.xml" />
<xi:include href="xml/gimpfileops.xml" /> <xi:include href="xml/gimpfileops.xml" />
<xi:include href="xml/gimpfloatingsel.xml" /> <xi:include href="xml/gimpfloatingsel.xml" />

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

@ -70,14 +70,15 @@ GimpDodgeBurnType
GimpFillType GimpFillType
GimpGradientSegmentColor GimpGradientSegmentColor
GimpGradientSegmentType GimpGradientSegmentType
GimpHistogramChannel
GimpIconType
GimpOffsetType
GimpGradientType GimpGradientType
GimpHistogramChannel
GimpHueRange GimpHueRange
GimpIconType
GimpInterpolationType
GimpLayerModeEffects GimpLayerModeEffects
GimpMaskApplyMode GimpMaskApplyMode
GimpMergeType GimpMergeType
GimpOffsetType
GimpOrientationType GimpOrientationType
GimpPaintApplicationMode GimpPaintApplicationMode
GimpRepeatMode GimpRepeatMode
@ -85,6 +86,8 @@ GimpRotationType
GimpRunMode GimpRunMode
GimpSizeType GimpSizeType
GimpTransferMode GimpTransferMode
GimpTransformDirection
gimp_enums_get_type_names
<SUBSECTION Standard> <SUBSECTION Standard>
GIMP_TYPE_ADD_MASK_TYPE GIMP_TYPE_ADD_MASK_TYPE
GIMP_TYPE_BLEND_MODE GIMP_TYPE_BLEND_MODE
@ -105,6 +108,7 @@ GIMP_TYPE_GRADIENT_TYPE
GIMP_TYPE_HISTOGRAM_CHANNEL GIMP_TYPE_HISTOGRAM_CHANNEL
GIMP_TYPE_HUE_RANGE GIMP_TYPE_HUE_RANGE
GIMP_TYPE_ICON_TYPE GIMP_TYPE_ICON_TYPE
GIMP_TYPE_INTERPOLATION_TYPE
GIMP_TYPE_LAYER_MODE_EFFECTS GIMP_TYPE_LAYER_MODE_EFFECTS
GIMP_TYPE_MASK_APPLY_MODE GIMP_TYPE_MASK_APPLY_MODE
GIMP_TYPE_MERGE_TYPE GIMP_TYPE_MERGE_TYPE
@ -116,6 +120,7 @@ GIMP_TYPE_ROTATION_TYPE
GIMP_TYPE_RUN_MODE GIMP_TYPE_RUN_MODE
GIMP_TYPE_SIZE_TYPE GIMP_TYPE_SIZE_TYPE
GIMP_TYPE_TRANSFER_MODE GIMP_TYPE_TRANSFER_MODE
GIMP_TYPE_TRANSFORM_DIRECTION
gimp_add_mask_type_get_type gimp_add_mask_type_get_type
gimp_blend_mode_get_type gimp_blend_mode_get_type
gimp_brush_application_mode_get_type gimp_brush_application_mode_get_type
@ -135,6 +140,7 @@ gimp_gradient_type_get_type
gimp_histogram_channel_get_type gimp_histogram_channel_get_type
gimp_hue_range_get_type gimp_hue_range_get_type
gimp_icon_type_get_type gimp_icon_type_get_type
gimp_interpolation_type_get_type
gimp_layer_mode_effects_get_type gimp_layer_mode_effects_get_type
gimp_mask_apply_mode_get_type gimp_mask_apply_mode_get_type
gimp_merge_type_get_type gimp_merge_type_get_type
@ -146,6 +152,7 @@ gimp_rotation_type_get_type
gimp_run_mode_get_type gimp_run_mode_get_type
gimp_size_type_get_type gimp_size_type_get_type
gimp_transfer_mode_get_type gimp_transfer_mode_get_type
gimp_transform_direction_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -318,6 +325,17 @@ gimp_drawable_parasite_detach
gimp_drawable_attach_new_parasite gimp_drawable_attach_new_parasite
</SECTION> </SECTION>
<SECTION>
<FILE>gimpdrawabletransform</FILE>
gimp_drawable_transform_flip
gimp_drawable_transform_flip_free
gimp_drawable_transform_perspective
gimp_drawable_transform_rotate
gimp_drawable_transform_scale
gimp_drawable_transform_shear
gimp_drawable_transform_2d
</SECTION>
<SECTION> <SECTION>
<FILE>gimpedit</FILE> <FILE>gimpedit</FILE>
gimp_edit_cut gimp_edit_cut

145
devel-docs/libgimp/tmpl/gimpdrawabletransform.sgml Normal file
View File

@ -0,0 +1,145 @@
<!-- ##### SECTION Title ##### -->
gimpdrawabletransform
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_drawable_transform_flip ##### -->
<para>
</para>
@drawable_ID:
@flip_type:
@center:
@axis:
@transform_direction:
@interpolation:
@supersample:
@recursion_level:
@clip_result:
@Returns:
<!-- ##### FUNCTION gimp_drawable_transform_flip_free ##### -->
<para>
</para>
@drawable_ID:
@x1:
@y1:
@x2:
@y2:
@transform_direction:
@interpolation:
@supersample:
@recursion_level:
@clip_result:
@Returns:
<!-- ##### FUNCTION gimp_drawable_transform_perspective ##### -->
<para>
</para>
@drawable_ID:
@x0:
@y0:
@x1:
@y1:
@x2:
@y2:
@x3:
@y3:
@transform_direction:
@interpolation:
@supersample:
@recursion_level:
@clip_result:
@Returns:
<!-- ##### FUNCTION gimp_drawable_transform_rotate ##### -->
<para>
</para>
@drawable_ID:
@angle:
@cx:
@cy:
@transform_direction:
@interpolation:
@supersample:
@recursion_level:
@clip_result:
@Returns:
<!-- ##### FUNCTION gimp_drawable_transform_scale ##### -->
<para>
</para>
@drawable_ID:
@x0:
@y0:
@x1:
@y1:
@transform_direction:
@interpolation:
@supersample:
@recursion_level:
@clip_result:
@Returns:
<!-- ##### FUNCTION gimp_drawable_transform_shear ##### -->
<para>
</para>
@drawable_ID:
@shear_type:
@magnitude:
@transform_direction:
@interpolation:
@supersample:
@recursion_level:
@clip_result:
@Returns:
<!-- ##### FUNCTION gimp_drawable_transform_2d ##### -->
<para>
</para>
@drawable_ID:
@source_x:
@source_y:
@scale_x:
@scale_y:
@angle:
@dest_x:
@dest_y:
@transform_direction:
@interpolation:
@supersample:
@recursion_level:
@clip_result:
@Returns:

82
devel-docs/libgimp/tmpl/gimpenums.sgml
View File

@ -161,34 +161,6 @@ Enums and definitions.
@GIMP_GRADIENT_SEGMENT_SPHERE_INCREASING: @GIMP_GRADIENT_SEGMENT_SPHERE_INCREASING:
@GIMP_GRADIENT_SEGMENT_SPHERE_DECREASING: @GIMP_GRADIENT_SEGMENT_SPHERE_DECREASING:
<!-- ##### ENUM GimpHistogramChannel ##### -->
<para>
</para>
@GIMP_HISTOGRAM_VALUE:
@GIMP_HISTOGRAM_RED:
@GIMP_HISTOGRAM_GREEN:
@GIMP_HISTOGRAM_BLUE:
@GIMP_HISTOGRAM_ALPHA:
<!-- ##### ENUM GimpIconType ##### -->
<para>
</para>
@GIMP_ICON_TYPE_STOCK_ID:
@GIMP_ICON_TYPE_INLINE_PIXBUF:
@GIMP_ICON_TYPE_IMAGE_FILE:
<!-- ##### ENUM GimpOffsetType ##### -->
<para>
</para>
@GIMP_OFFSET_BACKGROUND:
@GIMP_OFFSET_TRANSPARENT:
<!-- ##### ENUM GimpGradientType ##### --> <!-- ##### ENUM GimpGradientType ##### -->
<para> <para>
@ -206,6 +178,17 @@ Enums and definitions.
@GIMP_GRADIENT_SPIRAL_CLOCKWISE: @GIMP_GRADIENT_SPIRAL_CLOCKWISE:
@GIMP_GRADIENT_SPIRAL_ANTICLOCKWISE: @GIMP_GRADIENT_SPIRAL_ANTICLOCKWISE:
<!-- ##### ENUM GimpHistogramChannel ##### -->
<para>
</para>
@GIMP_HISTOGRAM_VALUE:
@GIMP_HISTOGRAM_RED:
@GIMP_HISTOGRAM_GREEN:
@GIMP_HISTOGRAM_BLUE:
@GIMP_HISTOGRAM_ALPHA:
<!-- ##### ENUM GimpHueRange ##### --> <!-- ##### ENUM GimpHueRange ##### -->
<para> <para>
@ -219,6 +202,24 @@ Enums and definitions.
@GIMP_BLUE_HUES: @GIMP_BLUE_HUES:
@GIMP_MAGENTA_HUES: @GIMP_MAGENTA_HUES:
<!-- ##### ENUM GimpIconType ##### -->
<para>
</para>
@GIMP_ICON_TYPE_STOCK_ID:
@GIMP_ICON_TYPE_INLINE_PIXBUF:
@GIMP_ICON_TYPE_IMAGE_FILE:
<!-- ##### ENUM GimpInterpolationType ##### -->
<para>
</para>
@GIMP_INTERPOLATION_NONE:
@GIMP_INTERPOLATION_LINEAR:
@GIMP_INTERPOLATION_CUBIC:
<!-- ##### ENUM GimpLayerModeEffects ##### --> <!-- ##### ENUM GimpLayerModeEffects ##### -->
<para> <para>
@ -266,6 +267,14 @@ Enums and definitions.
@GIMP_CLIP_TO_BOTTOM_LAYER: @GIMP_CLIP_TO_BOTTOM_LAYER:
@GIMP_FLATTEN_IMAGE: @GIMP_FLATTEN_IMAGE:
<!-- ##### ENUM GimpOffsetType ##### -->
<para>
</para>
@GIMP_OFFSET_BACKGROUND:
@GIMP_OFFSET_TRANSPARENT:
<!-- ##### ENUM GimpOrientationType ##### --> <!-- ##### ENUM GimpOrientationType ##### -->
<para> <para>
@ -327,3 +336,20 @@ Enums and definitions.
@GIMP_MIDTONES: @GIMP_MIDTONES:
@GIMP_HIGHLIGHTS: @GIMP_HIGHLIGHTS:
<!-- ##### ENUM GimpTransformDirection ##### -->
<para>
</para>
@GIMP_TRANSFORM_FORWARD:
@GIMP_TRANSFORM_BACKWARD:
<!-- ##### FUNCTION gimp_enums_get_type_names ##### -->
<para>
</para>
@n_type_names:
@Returns:

11
tools/pdbgen/enumcode.pl
View File

@ -166,6 +166,17 @@ _gimp_enums_init (void)
} }
} }
/**
* gimp_enums_get_type_names:
* \@n_type_names: return location for the number of names
*
* This function gives access to the list of enums registered by libgimp.
* The returned array is static and must not be modified.
*
* Return value: an array with type names
*
* Since: GIMP 2.2
**/
const gchar ** const gchar **
gimp_enums_get_type_names (gint *n_type_names) gimp_enums_get_type_names (gint *n_type_names)
{ {