docs cleanups
This commit is contained in:
parent
301d3a1809
commit
4c0ace34f0
27
TODO
27
TODO
@ -1,30 +1,5 @@
|
||||
|
||||
- could we support streaming read? how would it work?
|
||||
|
||||
chunk_buffer = []
|
||||
|
||||
reader = JPEGReader.new_buffer(chunk_buffer, ..)
|
||||
image = reader.read_buffero
|
||||
|
||||
writer = JPEGWriter.new(image, ...)
|
||||
output = writer.to_memory
|
||||
IO.write('fred.jpg', output)
|
||||
|
||||
bucket.objects['key'].read do |chunk|
|
||||
chunk_buffer << chunk
|
||||
|
||||
# tell the reader more bytes are available?
|
||||
reader.kick
|
||||
end
|
||||
|
||||
looks ugly and stupid :(
|
||||
|
||||
could maybe read from a socket? would we need to be able to pass file ids
|
||||
in? can named sockets work like this?
|
||||
|
||||
|
||||
|
||||
|
||||
- no docs for things like vips_abs() generated?
|
||||
|
||||
|
||||
- look at
|
||||
|
@ -16,7 +16,7 @@
|
||||
\fancyhead[LE,RO]{\leftmark} % left-even, right-odd
|
||||
\fancyhead[RE,LO]{VIPS Manual} % right-even, left-odd
|
||||
\fancyfoot[LE,RO]{\thepage} % left-even, right-odd
|
||||
\fancyfoot[RE,LO]{Feb 2013}
|
||||
\fancyfoot[RE,LO]{June 2013}
|
||||
|
||||
\begin{document}
|
||||
|
||||
@ -27,14 +27,14 @@
|
||||
\begin{center}
|
||||
\huge
|
||||
VIPS Manual\\
|
||||
\large Version 7.32\\
|
||||
\large Version 7.34\\
|
||||
\vspace{0.5in}
|
||||
\large
|
||||
John Cupitt,
|
||||
Kirk Martinez\\
|
||||
\end{center}
|
||||
|
||||
VIPS is currently (v. 7.32, Feb 2013) in an API transition. The API as
|
||||
VIPS is currently (v. 7.34, June 2013) in an API transition. The API as
|
||||
documented in 7.24 is still complete and supported and is the one you should
|
||||
use. The 8.0 API is not yet done and may still change before completion.
|
||||
|
||||
|
@ -49,6 +49,18 @@
|
||||
|
||||
#include "create.h"
|
||||
|
||||
/**
|
||||
* SECTION: create
|
||||
* @short_description: create #VipsImage in various ways
|
||||
* @stability: Stable
|
||||
* @include: vips/vips.h
|
||||
*
|
||||
* These functions generate various test images. You can combine them with
|
||||
* the arithmetic and rotate functions to build more complicated images.
|
||||
*
|
||||
* The im_benchmark() operations are for testing the VIPS SMP system.
|
||||
*/
|
||||
|
||||
G_DEFINE_ABSTRACT_TYPE( VipsCreate, vips_create, VIPS_TYPE_OPERATION );
|
||||
|
||||
static int
|
||||
|
@ -52,6 +52,33 @@
|
||||
|
||||
#include <gobject/gvaluecollector.h>
|
||||
|
||||
/**
|
||||
* SECTION: object
|
||||
* @short_description: the VIPS base object class
|
||||
* @stability: Stable
|
||||
* @see_also: <link linkend="libvips-operation">operation</link>
|
||||
* @include: vips/vips.h
|
||||
*
|
||||
* The #VipsObject class and associated types and macros.
|
||||
*
|
||||
* #VipsObject is the base class for all objects in libvips. It has the
|
||||
* following major features:
|
||||
*
|
||||
* <emphasis>Functional class creation</emphasis> Vips objects have a very
|
||||
* regular
|
||||
* lifecycle: initialise, build, use, destroy. They behave rather like
|
||||
* function calls and are free of side-effects.
|
||||
*
|
||||
* <emphasis>Run-time introspection</emphasis> Vips objects can be fully
|
||||
* introspected at
|
||||
* run-time. There is not need for a separate source-code analysis.
|
||||
*
|
||||
* <emphasis>Command-line interface</emphasis> Vips objects have an
|
||||
* automatic command-line
|
||||
* line interface with a set of virtual methods.
|
||||
*
|
||||
*/
|
||||
|
||||
/* Our signals.
|
||||
*/
|
||||
enum {
|
||||
|
@ -47,6 +47,24 @@
|
||||
|
||||
#include <gobject/gvaluecollector.h>
|
||||
|
||||
/**
|
||||
* SECTION: operation
|
||||
* @short_description: the VIPS operation base object class
|
||||
* @stability: Stable
|
||||
* @see_also: <link linkend="libvips-object">object</link>
|
||||
* @include: vips/vips.h
|
||||
*
|
||||
* The #VipsOperation class and associated types and macros.
|
||||
*
|
||||
* #VipsOperation is the base class for all operations in libvips. It builds
|
||||
* on #VipsObject to provide the introspection and command-line interface to
|
||||
* libvips.
|
||||
*
|
||||
* It also maintains a cache of recent operations. You can tune the cache
|
||||
* behaviour in various ways.
|
||||
*
|
||||
*/
|
||||
|
||||
/* Abstract base class for operations.
|
||||
*/
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user