diff --git a/TODO b/TODO index 1a00b153..607daf8e 100644 --- a/TODO +++ b/TODO @@ -1,12 +1,3 @@ -- try: - - $ cd vips-x.x.x/libvips - $ g-ir-doc-tool --language=Python -o /tmp/vips-doc Vips-8.0.gir - $ yelp /tmp/vips-doc - - shows gir contents - -- why don't we get gtk-doc expansions in the leading chapters? we turn them on - test other cpp arg types diff --git a/doc/reference/extending.xml b/doc/reference/extending.xml index 39ebf79a..fd11a1c4 100644 --- a/doc/reference/extending.xml +++ b/doc/reference/extending.xml @@ -53,14 +53,14 @@ typedef struct _NegativeClass { - GObject has a handy macro to write some of the boilerplate for you. + %GObject has a handy macro to write some of the boilerplate for you. G_DEFINE_TYPE( Negative, negative, VIPS_TYPE_OPERATION ); This defines a function called negative_get_type(), - which registers this new class and returns its #GType (a + which registers this new class and returns its %GType (a pointer-sized integer). negative_get_type() in turn needs two functions, negative_init(), to initialise a new instance, and negative_class_init(), to initialise a new class. @@ -149,7 +149,7 @@ negative_class_init( NegativeClass *class ) - The build function is the thing VipsObject calls after supplying + The build function is the thing #VipsObject calls after supplying arguments. It checks that all required arguments have been set and are valid and constructs the object. After build, the object is expected to be ready for use. diff --git a/doc/reference/libvips-docs.sgml.in b/doc/reference/libvips-docs.sgml.in index 6c013693..027021c2 100644 --- a/doc/reference/libvips-docs.sgml.in +++ b/doc/reference/libvips-docs.sgml.in @@ -1,4 +1,5 @@ + VIPS Overview - - VIPS is a free image processing system. It is good with large - images (images larger than the amount of RAM you have available), with - many CPUs (speed scales linearly to at least 32 threads), for working - with colour, for scientific analysis and for general research - and development. As well as JPEG, TIFF and PNG images, it also - supports scientific formats like FITS, Matlab, Analyze, PFM, - Radiance and OpenSlide. It works on many UNIX-like platforms, - as well as Windows and OS X. VIPS is released under the GNU Library - General Public License (GNU LGPL). - + + VIPS is a free image processing system. It is good with large + images (images larger than the amount of RAM you have available), with + many CPUs (speed scales linearly to at least 32 threads), for working + with colour, for scientific analysis and for general research + and development. As well as JPEG, TIFF and PNG images, it also + supports scientific formats like FITS, Matlab, Analyze, PFM, + Radiance and OpenSlide. It works on many UNIX-like platforms, + as well as Windows and OS X. VIPS is released under the GNU Library + General Public License (GNU LGPL). + - - - - - - + + + + + + diff --git a/doc/reference/using-C.xml b/doc/reference/using-C.xml index a9a067e5..5e3f3af4 100644 --- a/doc/reference/using-C.xml +++ b/doc/reference/using-C.xml @@ -1,8 +1,8 @@ + - VIPS from C @@ -28,7 +28,7 @@ When your program starts, use VIPS_INIT() to start up the VIPS library. You should pass it the name of your program, usually argv[0]. Use - vips_shutdown() when you exit. + vips_shutdown() when you exit. @@ -37,12 +37,10 @@ - The basic data object is the VipsImage. - You can create an image from a file on disc or from an - area of memory, either as a C-style array, or as a formatted object, - like JPEG. See vips_image_new_from_file() and - friends. Loading an + The basic data object is the #VipsImage. You can create an + image from a file on disc or from an area of memory, either + as a C-style array, or as a formatted object, like JPEG. See + vips_image_new_from_file() and friends. Loading an image is fast. VIPS read just enough of the image to be able to get the various properties, such as width in pixels. It delays reading any pixels until they are really needed. @@ -51,14 +49,14 @@ Once you have an image, you can get properties from it in the usual way. You can use projection functions, like vips_image_get_width() or - g_object_get(), to get GObject properties. All VIPS objects are + g_object_get(), to get %GObject properties. All VIPS objects are immutable, meaning you can only get properties, you can't set them. See VIPS Header to read about image properties. - VIPS is based on the GObject library and is therefore refcounted. + VIPS is based on the %GObject library and is therefore refcounted. vips_image_new_from_file() returns an object with a count of 1. When you are done with an image, use g_object_unref() to dispose of it. If you pass an image to an operation and that operation needs to keep a diff --git a/doc/reference/using-command-line.xml b/doc/reference/using-command-line.xml index e5311820..a199d5dd 100644 --- a/doc/reference/using-command-line.xml +++ b/doc/reference/using-command-line.xml @@ -1,4 +1,5 @@ + diff --git a/doc/reference/using-cpp.xml b/doc/reference/using-cpp.xml index a25ac104..32452810 100644 --- a/doc/reference/using-cpp.xml +++ b/doc/reference/using-cpp.xml @@ -85,9 +85,9 @@ main( int argc, char **argv ) - Everything before VImage in = VImage::.. is exactly as the C - API. This boilerplate gives the example a set of standard command-line - flags. + Everything before VImage in = VImage::.. is exactly + as the C API. This boilerplate gives the example a set of standard + command-line flags. @@ -104,7 +104,7 @@ main( int argc, char **argv ) - Instead of using varargs and a NULL-terminated option list, this + Instead of using varargs and a %NULL-terminated option list, this function takes an optional VOption pointer. This gives a list of name / value pairs for optional arguments to the function. @@ -117,8 +117,8 @@ main( int argc, char **argv ) - The function will delete the #VOption pointer for us when it's - finished with it. + The function will delete the VOption pointer for + us when it's finished with it. @@ -156,13 +156,13 @@ main( int argc, char **argv ) Like VImage::new_from_file(), function raises the - vips::VError exception on error. + VError exception on error. Like VImage::new_from_file(), extra arguments are passed - via an optional #VOption parameter. There are none in this case, - so the function brackets can be left empty. + via an optional VOption parameter. There are none + in this case, so the function brackets can be left empty.