Doc fixes in both source comments and gtk-doc files

This commit is contained in:
Michael Natterer
2011-11-25 21:39:55 +01:00
parent c08a47c5e5
commit ebbad40885
16 changed files with 90 additions and 22 deletions

View File

@ -28,6 +28,7 @@ CFILE_GLOB = $(DOC_SOURCE_DIR)/*.c
# Header files to ignore when scanning
IGNORE_HFILES = \
gimpcompat.h \
gimpunit_pdb.h \
gimpunitcache.h \
libgimp-intl.h \
stdplugins-intl.h

View File

@ -74,6 +74,7 @@
<title>Data Objects</title>
<xi:include href="xml/gimpbrush.xml" />
<xi:include href="xml/gimpbrushes.xml" />
<xi:include href="xml/gimpdynamics.xml" />
<xi:include href="xml/gimpfonts.xml" />
<xi:include href="xml/gimpgradient.xml" />
<xi:include href="xml/gimpgradients.xml" />

View File

@ -248,6 +248,8 @@ gimp_context_get_paint_mode
gimp_context_set_paint_mode
gimp_context_get_brush
gimp_context_set_brush
gimp_context_get_dynamics
gimp_context_set_dynamics
gimp_context_get_pattern
gimp_context_set_pattern
gimp_context_get_gradient
@ -377,6 +379,12 @@ gimp_drawable_transform_matrix
gimp_drawable_transform_matrix_default
</SECTION>
<SECTION>
<FILE>gimpdynamics</FILE>
gimp_dynamics_get_list
gimp_dynamics_refresh
</SECTION>
<SECTION>
<FILE>gimpedit</FILE>
gimp_edit_cut
@ -540,6 +548,9 @@ gimp_help
gimp_image_list
gimp_image_new
gimp_image_get_uri
gimp_image_get_xcf_uri
gimp_image_get_exported_uri
gimp_image_get_imported_uri
gimp_image_duplicate
gimp_image_delete
gimp_image_is_valid
@ -607,12 +618,15 @@ gimp_image_set_tattoo_state
gimp_image_get_tattoo_state
gimp_image_get_layer_by_tattoo
gimp_image_get_channel_by_tattoo
gimp_image_get_vectors_by_tattoo
gimp_image_get_layer_by_name
gimp_image_get_channel_by_name
gimp_image_get_vectors_by_name
gimp_image_get_cmap
gimp_image_set_cmap
gimp_image_get_colormap
gimp_image_set_colormap
gimp_image_get_vectors
gimp_image_get_vectors_by_tattoo
gimp_image_get_thumbnail_data
gimp_image_attach_parasite
gimp_image_detach_parasite
@ -1011,7 +1025,6 @@ gimp_heal_default
gimp_paintbrush
gimp_paintbrush_default
gimp_pencil
gimp_perspective
gimp_smudge
gimp_smudge_default
</SECTION>

View File

@ -134,6 +134,7 @@ gimp_scanner_parse_string_no_validate
gimp_scanner_parse_data
gimp_scanner_parse_int
gimp_scanner_parse_float
gimp_scanner_parse_boolean
gimp_scanner_parse_color
gimp_scanner_parse_matrix2
</SECTION>

View File

@ -28,6 +28,7 @@ CFILE_GLOB = $(DOC_SOURCE_DIR)/*.c
# Header files to ignore when scanning
IGNORE_HFILES = \
gimpcolorprofilestore-private.h \
gimpeevl.h \
gimpwidgets-private.h
# Images to copy into HTML directory

View File

@ -571,6 +571,7 @@ gimp_ruler_get_position
gimp_ruler_set_range
gimp_ruler_get_range
gimp_ruler_add_track_widget
gimp_ruler_remove_track_widget
<SUBSECTION Standard>
GimpRulerClass
GIMP_RULER
@ -837,6 +838,7 @@ GIMP_STOCK_PRINT_RESOLUTION
GIMP_STOCK_TOOLS
GIMP_STOCK_TOOL_OPTIONS
GIMP_STOCK_DEVICE_STATUS
GIMP_STOCK_INPUT_DEVICE
GIMP_STOCK_DISPLAY_FILTER
GIMP_STOCK_CURVE_FREE
GIMP_STOCK_CURVE_SMOOTH
@ -874,6 +876,7 @@ GIMP_STOCK_TOOL_BLUR
GIMP_STOCK_TOOL_BRIGHTNESS_CONTRAST
GIMP_STOCK_TOOL_BUCKET_FILL
GIMP_STOCK_TOOL_BY_COLOR_SELECT
GIMP_STOCK_TOOL_CAGE
GIMP_STOCK_TOOL_CLONE
GIMP_STOCK_TOOL_COLOR_BALANCE
GIMP_STOCK_TOOL_COLOR_PICKER
@ -923,12 +926,14 @@ GIMP_STOCK_DISPLAY_FILTER_PROOF
GIMP_STOCK_QMASK_ON
GIMP_STOCK_QMASK_OFF
GIMP_STOCK_BRUSH
GIMP_STOCK_DYNAMICS
GIMP_STOCK_BUFFER
GIMP_STOCK_DETACH
GIMP_STOCK_FONT
GIMP_STOCK_GRADIENT
GIMP_STOCK_PALETTE
GIMP_STOCK_PATTERN
GIMP_STOCK_TOOL_PRESET
</SECTION>
<SECTION>
@ -946,6 +951,7 @@ gimp_enum_stock_box_set_child_padding
<SECTION>
<FILE>gimpwidgets</FILE>
<TITLE>GimpWidgets</TITLE>
GimpWidgetsError
gimp_radio_group_new
gimp_radio_group_new2
gimp_radio_group_set_active
@ -1288,3 +1294,17 @@ GIMP_CONTROLLER_CLASS
GIMP_IS_CONTROLLER_CLASS
GIMP_CONTROLLER_GET_CLASS
</SECTION>
<SECTION>
<FILE>gimp3migration</FILE>
GdkModifierIntent
gdk_event_triggers_context_menu
gdk_keymap_get_modifier_mask
gtk_box_new
gtk_button_box_new
gtk_paned_new
gtk_scale_new
gtk_scrollbar_new
gtk_separator_new
gtk_widget_get_modifier_mask
</SECTION>

View File

@ -872,6 +872,14 @@ RTL variant
<!-- ##### MACRO GIMP_STOCK_INPUT_DEVICE ##### -->
<para xml:base="../gimpstock.xml">
<inlinegraphic fileref="stock-input-device-24.png" format="png"></inlinegraphic>
<inlinegraphic fileref="stock-input-device-16.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GIMP_STOCK_DISPLAY_FILTER ##### -->
<para xml:base="../gimpstock.xml">
<inlinegraphic fileref="stock-display-filter-24.png" format="png"></inlinegraphic>
@ -1148,6 +1156,14 @@ RTL variant
<!-- ##### MACRO GIMP_STOCK_TOOL_CAGE ##### -->
<para xml:base="../gimpstock.xml">
<inlinegraphic fileref="stock-tool-cage-22.png" format="png"></inlinegraphic>
<inlinegraphic fileref="stock-tool-cage-16.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_CLONE ##### -->
<para xml:base="../gimpstock.xml">
<inlinegraphic fileref="stock-tool-clone-22.png" format="png"></inlinegraphic>
@ -1460,8 +1476,9 @@ RTL variant
<!-- ##### MACRO GIMP_STOCK_CONTROLLER_MOUSE ##### -->
<para>
<para xml:base="../gimpstock.xml">
<inlinegraphic fileref="stock-controller-mouse-24.png" format="png"></inlinegraphic>
<inlinegraphic fileref="stock-controller-mouse-16.png" format="png"></inlinegraphic>
</para>
@ -1535,6 +1552,13 @@ RTL variant
<!-- ##### MACRO GIMP_STOCK_DYNAMICS ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_BUFFER ##### -->
<para>
@ -1577,3 +1601,10 @@ RTL variant
<!-- ##### MACRO GIMP_STOCK_TOOL_PRESET ##### -->
<para>
</para>