docs polishing

see https://github.com/jcupitt/ruby-vips/issues/90
This commit is contained in:
John Cupitt 2016-09-27 07:53:33 +01:00
parent 1cc3b2bd5d
commit 35892fa93c
2 changed files with 15 additions and 15 deletions

View File

@ -366,16 +366,16 @@ vips_copy_init( VipsCopy *copy )
*
* Optional arguments:
*
* * @width: set image width
* * @height: set image height
* * @bands: set image bands
* * @format: set image format
* * @coding: set image coding
* * @interpretation: set image interpretation
* * @xres: set image xres
* * @yres: set image yres
* * @xoffset: set image xoffset
* * @yoffset: set image yoffset
* * @width: %gint, set image width
* * @height: %gint, set image height
* * @bands: %gint, set image bands
* * @format: #VipsBandFormat, set image format
* * @coding: #VipsCoding, set image coding
* * @interpretation: #VipsInterpretation, set image interpretation
* * @xres: %gdouble, set image xres
* * @yres: %gdouble, set image yres
* * @xoffset: %gint, set image xoffset
* * @yoffset: %gint, set image yoffset
*
* Copy an image, optionally modifying the header. VIPS copies images by
* copying pointers, so this operation is instant, even for very large images.

View File

@ -165,17 +165,17 @@ vips_foreign_load_raw_init( VipsForeignLoadRaw *raw )
*
* Optional arguments:
*
* * @offset: offset in bytes from start of file
* * @offset: %guint64, offset in bytes from start of file
*
* This operation mmaps the file, setting @out so that access to that
* This operation mmaps the file, setting up @out so that access to that
* image will read from the file.
*
* @out will be a 8-bit uchar image with @bands image bands, so @bands can
* be thought of as meaning "number of bytes per pixel". Use functions
* like vips_copy() to set the exact band format, number of bands, byte
* ordering and so on.
* like vips_copy() to set the exact band format, number of bands,
* and so on. Use vips_byteswap() to reverse the byte ordering.
*
* See also: vips_image_new_from_file().
* See also: vips_image_new_from_file(), vips_copy(), vips_byteswap().
*
* Returns: 0 on success, -1 on error.
*/