MagickGetImageProfiles documentation error

Post any defects you find in the released or beta versions of the ImageMagick software here. Include the ImageMagick version, OS, and any command-line required to reproduce the problem. Got a patch for a bug? Post it here.
User avatar
anthony
Posts: 8883
Joined: 2004-05-31T19:27:03-07:00
Authentication code: 8675308
Location: Brisbane, Australia

Re: MagickGetImageProfiles documentation error

Post by anthony »

RetroJ

While what you are doing is good. Doing it one item at a time can be a PAIN.


I suggest you download the sources and modify the function comments then send us a 'diff'.
It is from teh source comments that the web page documentation for functions are derived!

This makes it easy for us to incorporate your corrections into the master source, a whole file at a time.
rather than one correction at a time.
Anthony Thyssen -- Webmaster for ImageMagick Example Pages
https://imagemagick.org/Usage/
RetroJ
Posts: 108
Joined: 2006-10-25T08:12:50-07:00

Re: MagickGetImageProfiles documentation error

Post by RetroJ »

The type signature of DrawGetVectorGraphics has the 'const' keyword for the first argument, but the real type signature does not have it.

http://imagemagick.org/api/drawing-wand ... orGraphics
RetroJ
Posts: 108
Joined: 2006-10-25T08:12:50-07:00

Re: MagickGetImageProfiles documentation error

Post by RetroJ »

anthony wrote:RetroJ

While what you are doing is good. Doing it one item at a time can be a PAIN.


I suggest you download the sources and modify the function comments then send us a 'diff'.
It is from teh source comments that the web page documentation for functions are derived!

This makes it easy for us to incorporate your corrections into the master source, a whole file at a time.
rather than one correction at a time.
Hi Anthony,

Ok, I was unaware of that. However, since I'm in the midst of a large project that necessitates going through these docs, it is still easiest for me to report them one at a time as I go along. Feel free to ignore the reports or act on them as you choose, and I understand time is limited to allocate to such trivial stuff. If the reports have not been responded to when I'm done with my current pass, then I will try to remember to download the source and create a patch. In the meantime, my philosophy is, it's better to put the information out into the world where it can do some good than to risk losing steam and forgetting about it.

Many thanks.
RetroJ
Posts: 108
Joined: 2006-10-25T08:12:50-07:00

Re: MagickGetImageProfiles documentation error

Post by RetroJ »

Type signature of DrawPathCurveToQuadraticBezierAbsolute has typo, 'onst' instead of 'const'.

http://imagemagick.org/api/drawing-wand ... erAbsolute
RetroJ
Posts: 108
Joined: 2006-10-25T08:12:50-07:00

Re: MagickGetImageProfiles documentation error

Post by RetroJ »

Second DrawPathCurveToQuadraticBezierSmoothAbsolute seems to be mistitled. Should be DrawPathCurveToQuadraticBezierSmoothRelative. Text of section also refers to DrawPathCurveToQuadraticBezierSmoothAbsolute, but type signature is for the other.

http://imagemagick.org/api/drawing-wand ... thAbsolute
RetroJ
Posts: 108
Joined: 2006-10-25T08:12:50-07:00

Re: MagickGetImageProfiles documentation error

Post by RetroJ »

DrawPathCurveToSmoothAbsolute type signature missing comma.

http://imagemagick.org/api/drawing-wand ... thAbsolute
RetroJ
Posts: 108
Joined: 2006-10-25T08:12:50-07:00

Re: MagickGetImageProfiles documentation error

Post by RetroJ »

The type signature of DrawPathLineToHorizontalAbsolute has an errant argument, 'mode'.
http://imagemagick.org/api/drawing-wand ... alAbsolute
RetroJ
Posts: 108
Joined: 2006-10-25T08:12:50-07:00

Re: MagickGetImageProfiles documentation error

Post by RetroJ »

In the type signature of DrawSetFontResolution, return type given as DrawBooleanType; should be MagickBooleanType. Also a typo, 'doubtl' instead of 'double' in argument list.

http://imagemagick.org/api/drawing-wand ... Resolution
RetroJ
Posts: 108
Joined: 2006-10-25T08:12:50-07:00

Re: MagickGetImageProfiles documentation error

Post by RetroJ »

DrawSetTextInterwordSpacing appears twice. I think the first one is supposed to be DrawSetTextInterlineSpacing. Same for earlier DrawGetTextInterwordSpacing.

http://imagemagick.org/api/drawing-wand ... ordSpacing
RetroJ
Posts: 108
Joined: 2006-10-25T08:12:50-07:00

Re: MagickGetImageProfiles documentation error

Post by RetroJ »

In the type signature of DrawSetViewbox, the types of several arguments are given as 'size_t'. They should all be 'ssize_t'.

http://imagemagick.org/api/drawing-wand ... SetViewbox
RetroJ
Posts: 108
Joined: 2006-10-25T08:12:50-07:00

Re: MagickGetImageProfiles documentation error

Post by RetroJ »

The type signature of NewDrawingWand gives the return type as 'DrawingWand'; it should be 'DrawingWand *'.

http://imagemagick.org/api/drawing-wand ... rawingWand
RetroJ
Posts: 108
Joined: 2006-10-25T08:12:50-07:00

Re: MagickGetImageProfiles documentation error

Post by RetroJ »

The type signature for GetWandViewException gives the first argument as type 'const Pixelwand *'; it should be 'const WandView *'.

http://imagemagick.org/api/wand-view.ph ... wException
Post Reply