Commit ebbad408 authored by Michael Natterer's avatar Michael Natterer 😴

Doc fixes in both source comments and gtk-doc files

parent c08a47c5
......@@ -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
......
......@@ -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" />
......
......@@ -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>
......
......@@ -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>
......
......@@ -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
......
......@@ -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>
......@@ -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>
......@@ -563,22 +563,22 @@ gimp_quit (void)
* "*" for all image types. If the procedure doesn't need an image to
* run, use the empty string.
*
* @type must be one of #GIMP_PLUGIN or #GIMP_EXTENSION. Note that
* @type must be one of %GIMP_PLUGIN or %GIMP_EXTENSION. Note that
* temporary procedures must be installed using
* gimp_install_temp_proc().
*
* NOTE: Unlike the GIMP 1.2 API, #GIMP_EXTENSION no longer means
* NOTE: Unlike the GIMP 1.2 API, %GIMP_EXTENSION no longer means
* that the procedure's menu prefix is &lt;Toolbox&gt;, but that
* it will install temporary procedures. Therefore, the GIMP core
* will wait until the #GIMP_EXTENSION procedure has called
* will wait until the %GIMP_EXTENSION procedure has called
* gimp_extension_ack(), which means that the procedure has done
* its initialization, installed its temporary procedures and is
* ready to run.
*
* <emphasis>Not calling gimp_extension_ack() from a #GIMP_EXTENSION
* <emphasis>Not calling gimp_extension_ack() from a %GIMP_EXTENSION
* procedure will cause the GIMP core to lock up.</emphasis>
*
* Additionally, a #GIMP_EXTENSION procedure with no parameters
* Additionally, a %GIMP_EXTENSION procedure with no parameters
* (@n_params == 0 and @params == #NULL) is an "automatic" extension
* that will be automatically started on each GIMP startup.
**/
......@@ -650,7 +650,7 @@ gimp_install_procedure (const gchar *name,
*
* See gimp_install_procedure() for most details.
*
* @type <emphasis>must</emphasis> be #GIMP_TEMPORARY or the function
* @type <emphasis>must</emphasis> be %GIMP_TEMPORARY or the function
* will fail.
*
* @run_proc is the function which will be called to execute the
......@@ -733,12 +733,12 @@ gimp_uninstall_temp_proc (const gchar *name)
* gimp_run_procedure:
* @name: the name of the procedure to run
* @n_return_vals: return location for the number of return values
* @Varargs: list of procedure parameters
* @...: list of procedure parameters
*
* This function calls a GIMP procedure and returns its return values.
*
* The procedure's parameters are given by a va_list in the format
* (type, value, type, value) and must be terminated by #GIMP_PDB_END.
* (type, value, type, value) and must be terminated by %GIMP_PDB_END.
*
* This function converts the va_list of parameters into an array and
* passes them to gimp_run_procedure2(). Please look there for further
......
......@@ -597,7 +597,7 @@ gimp_drawable_parasite_detach (gint32 drawable_ID,
* @num_parasites: The number of attached parasites.
* @parasites: The names of currently attached parasites.
*
* Deprecated: Use gimp_item_list_parasites() instead.
* Deprecated: Use gimp_item_get_parasite_list() instead.
*
* Returns: TRUE on success.
**/
......
......@@ -675,7 +675,7 @@ export_dialog (GSList *actions,
* and drawable_ID is not altered, GIMP_EXPORT_IGNORE is returned and
* the save_plugin should try to save the original image. If the
* user chooses Cancel, GIMP_EXPORT_CANCEL is returned and the
* save_plugin should quit itself with status #GIMP_PDB_CANCEL.
* save_plugin should quit itself with status %GIMP_PDB_CANCEL.
*
* If @format_name is NULL, no dialogs will be shown and this function
* will behave as if the user clicked on the 'Export' button, if a
......
......@@ -712,8 +712,8 @@ gimp_pixel_rgns_register2 (gint nrgns,
/**
* gimp_pixel_rgns_register:
* @nrgns: the number of regions to register.
* @Varargs: @nrgns pointers to #GimpPixelRgn.
* @nrgns: the number of regions to register.
* @...: @nrgns pointers to #GimpPixelRgn.
*
* This is the varargs version of #gimp_pixel_rgns_register2.
*
......
......@@ -242,7 +242,7 @@ gimp_progress_init (const gchar *message)
/**
* gimp_progress_init_printf:
* @format: a standard printf() format string
* @Varargs: arguments for @format
* @...: arguments for @format
*
* Initializes the progress bar for the current plug-in.
*
......@@ -277,7 +277,7 @@ gimp_progress_init_printf (const gchar *format,
/**
* gimp_progress_set_text_printf:
* @format: a standard printf() format string
* @Varargs: arguments for @format
* @...: arguments for @format
*
* Changes the text in the progress bar for the current plug-in.
*
......
......@@ -256,7 +256,7 @@ gimp_vectors_parasite_detach (gint32 vectors_ID,
* @num_parasites: The number of attached parasites.
* @parasites: The names of currently attached parasites.
*
* Deprecated: Use gimp_item_list_parasites() instead.
* Deprecated: Use gimp_item_get_parasite_list() instead.
*
* Returns: TRUE on success.
*
......
......@@ -117,7 +117,7 @@ gimp_utf8_strtrim (const gchar *str,
* @warning_format: The message format for the warning message if conversion
* to UTF-8 fails. See the <function>printf()</function>
* documentation.
* @Varargs: The parameters to insert into the format string.
* @...: The parameters to insert into the format string.
*
* This function takes any string (UTF-8 or not) and always returns a valid
* UTF-8 string.
......
......@@ -330,7 +330,7 @@ gimp_config_writer_print (GimpConfigWriter *writer,
* gimp_config_writer_printf:
* @writer: a #GimpConfigWriter
* @format: a format string as described for g_strdup_printf().
* @Varargs: list of arguments according to @format
* @...: list of arguments according to @format
*
* A printf-like function for #GimpConfigWriter.
*
......
......@@ -511,7 +511,7 @@ gimp_dialog_add_button (GimpDialog *dialog,
/**
* gimp_dialog_add_buttons:
* @dialog: The @dialog to add buttons to.
* @Varargs: button_text-response_id pairs.
* @...: button_text-response_id pairs.
*
* This function is essentially the same as gtk_dialog_add_buttons()
* except it calls gimp_dialog_add_button() instead of gtk_dialog_add_button()
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment