pdb: update several channel creation function's descriptions.

More informative, detailed description or better wording.
Also adds some newlines for better rendering.
This commit is contained in:
Jehan
2013-09-14 02:10:08 +12:00
parent ee8827d645
commit a7f11290a4
3 changed files with 29 additions and 18 deletions

View File

@ -370,7 +370,7 @@ register_channel_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure, gimp_procedure_set_static_strings (procedure,
"gimp-channel-new", "gimp-channel-new",
"Create a new channel.", "Create a new channel.",
"This procedure creates a new channel with the specified width and height. Name, opacity, and color are also supplied parameters. The new channel still needs to be added to the image, as this is not automatic. Add the new channel with the 'gimp-image-insert-channel' command. Other attributes such as channel show masked, should be set with explicit procedure calls. The channel's contents are undefined initially.", "This procedure creates a new channel with the specified width, height, name, opacity and color. \n\nThe new channel still needs to be added to the image, as this is not automatic. Add the new channel with 'gimp-image-insert-channel'. Other attributes, such as channel visibility, should be set with explicit procedure calls. \nThe channel's contents are undefined initially.",
"Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis",
"1995-1996", "1995-1996",
@ -431,7 +431,7 @@ register_channel_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure, gimp_procedure_set_static_strings (procedure,
"gimp-channel-new-from-component", "gimp-channel-new-from-component",
"Create a new channel from a color component", "Create a new channel from a color component",
"This procedure creates a new channel from a color component.", "This procedure creates a new channel from a color component. \n\nThe new channel still needs to be added to the image, as this is not automatic. Add the new channel with 'gimp-image-insert-channel'. Other attributes, such as channel visibility, should be set with explicit procedure calls.",
"Shlomi Fish <shlomif@iglu.org.il>", "Shlomi Fish <shlomif@iglu.org.il>",
"Shlomi Fish", "Shlomi Fish",
"2005", "2005",
@ -474,7 +474,7 @@ register_channel_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure, gimp_procedure_set_static_strings (procedure,
"gimp-channel-copy", "gimp-channel-copy",
"Copy a channel.", "Copy a channel.",
"This procedure copies the specified channel and returns the copy.", "This procedure copies the specified channel and returns the copy. \n\nThe new channel still needs to be added to the image, as this is not automatic. Add the new channel with 'gimp-image-insert-channel'.",
"Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis",
"1995-1996", "1995-1996",

View File

@ -45,13 +45,12 @@
* *
* Create a new channel. * Create a new channel.
* *
* This procedure creates a new channel with the specified width and * This procedure creates a new channel with the specified width,
* height. Name, opacity, and color are also supplied parameters. The * height, name, opacity and color. \n\nThe new channel still needs to
* new channel still needs to be added to the image, as this is not * be added to the image, as this is not automatic. Add the new channel
* automatic. Add the new channel with the gimp_image_insert_channel() * with gimp_image_insert_channel(). Other attributes, such as channel
* command. Other attributes such as channel show masked, should be set * visibility, should be set with explicit procedure calls. \nThe
* with explicit procedure calls. The channel's contents are undefined * channel's contents are undefined initially.
* initially.
* *
* Returns: The newly created channel. * Returns: The newly created channel.
**/ **/
@ -93,7 +92,11 @@ _gimp_channel_new (gint32 image_ID,
* *
* Create a new channel from a color component * Create a new channel from a color component
* *
* This procedure creates a new channel from a color component. * This procedure creates a new channel from a color component. \n\nThe
* new channel still needs to be added to the image, as this is not
* automatic. Add the new channel with gimp_image_insert_channel().
* Other attributes, such as channel visibility, should be set with
* explicit procedure calls.
* *
* Returns: The newly created channel. * Returns: The newly created channel.
* *
@ -130,6 +133,8 @@ gimp_channel_new_from_component (gint32 image_ID,
* Copy a channel. * Copy a channel.
* *
* This procedure copies the specified channel and returns the copy. * This procedure copies the specified channel and returns the copy.
* \n\nThe new channel still needs to be added to the image, as this is
* not automatic. Add the new channel with gimp_image_insert_channel().
* *
* Returns: The newly copied channel. * Returns: The newly copied channel.
**/ **/

View File

@ -20,13 +20,13 @@ sub channel_new {
$blurb = 'Create a new channel.'; $blurb = 'Create a new channel.';
$help = <<'HELP'; $help = <<'HELP';
This procedure creates a new channel with the specified width and This procedure creates a new channel with the specified width, height,
height. Name, opacity, and color are also supplied parameters. The new name, opacity and color.
channel still needs to be added to the image, as this is not \n\nThe new channel still needs to be added to the image, as this is not
automatic. Add the new channel with the gimp_image_insert_channel() automatic. Add the new channel with gimp_image_insert_channel(). Other
command. Other attributes such as channel show masked, should be set attributes, such as channel visibility, should be set with explicit
with explicit procedure calls. The channel's contents are undefined procedure calls.
initially. \nThe channel's contents are undefined initially.
HELP HELP
&std_pdb_misc; &std_pdb_misc;
@ -72,6 +72,8 @@ sub channel_copy {
$help = <<'HELP'; $help = <<'HELP';
This procedure copies the specified channel and returns the copy. This procedure copies the specified channel and returns the copy.
\n\nThe new channel still needs to be added to the image, as this is not
automatic. Add the new channel with gimp_image_insert_channel().
HELP HELP
&std_pdb_misc; &std_pdb_misc;
@ -140,6 +142,10 @@ sub channel_new_from_component {
$help = <<'HELP'; $help = <<'HELP';
This procedure creates a new channel from a color component. This procedure creates a new channel from a color component.
\n\nThe new channel still needs to be added to the image, as this is not
automatic. Add the new channel with gimp_image_insert_channel(). Other
attributes, such as channel visibility, should be set with explicit
procedure calls.
HELP HELP
&shlomi_pdb_misc('2005', '2.4'); &shlomi_pdb_misc('2005', '2.4');