fix up gtk-doc

fix various problems:

- out of date IGNORE in doc/reference/Makefile.am
- name clashes between private .h and public
This commit is contained in:
John Cupitt 2013-06-17 20:16:20 +01:00
parent 4c0ace34f0
commit 2fd2fd58f7
80 changed files with 147 additions and 120 deletions

View File

@ -59,7 +59,62 @@ EXTRA_HFILES=
# Header files to ignore when scanning. Use base file name, no paths
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES=merge.h debug.h internal.h intl.h CImg.h im_video_v4l1.h global_balance.h dbh.h base64.h templates.h mosaic.h deprecated.h thread.h private.h internal.h almostdeprecated.h inlines.h struct.h disp.h vector.h
# we only want to document public API, so have all .h files not in
# libvips/include in here ... and a few from libvips/include as well
IGNORE_VIPS_INCLUDE = \
almostdeprecated.h \
cimg_funcs.h \
deprecated.h \
vips7compat.h \
dispatch.h \
enumtypes.h \
internal.h \
thread.h \
intl.h \
format.h \
mask.h \
private.h \
video.h
# ignore all .h files in libvips/*, theese are internal
IGNORE_VIPS_C = \
binary.h \
parithmetic.h \
statistic.h \
unaryconst.h \
unary.h \
CImg.h \
pcolour.h \
bandary.h \
pconversion.h \
pcreate.h \
point.h \
analyze2vips.h \
csv.h \
dbh.h \
fits.h \
jpeg.h \
magick.h \
matlab.h \
openexr2vips.h \
openslide2vips.h \
ppm.h \
radiance.h \
tiff.h \
vipspng.h \
draw.h \
base64.h \
sink.h \
global_balance.h \
merge.h \
mosaic.h \
presample.h \
templates.h \
im_video_v4l1.h
IGNORE_HFILES = $(IGNORE_VIPS_INCLUDE) $(IGNORE_VIPS_C)
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png

View File

@ -41,12 +41,10 @@
<xi:include href="xml/histograms_lut.xml"/>
<xi:include href="xml/inplace.xml"/>
<xi:include href="xml/interpolate.xml"/>
<xi:include href="xml/mask.xml"/>
<xi:include href="xml/morphology.xml"/>
<xi:include href="xml/mosaicing.xml"/>
<xi:include href="xml/create.xml"/>
<xi:include href="xml/resample.xml"/>
<xi:include href="xml/video.xml"/>
</chapter>
<chapter>

View File

@ -18,7 +18,7 @@ libarithmetic_la_SOURCES = \
subtract.c \
math.c \
arithmetic.c \
arithmetic.h \
parithmetic.h \
binary.c \
binary.h \
unary.c \

View File

@ -52,7 +52,7 @@
#include <vips/vips.h>
#include "arithmetic.h"
#include "parithmetic.h"
/**
* SECTION: arithmetic

View File

@ -33,13 +33,11 @@
#include <vips/vips.h>
#include "arithmetic.h"
#ifdef __cplusplus
extern "C" {
#endif /*__cplusplus*/
#include "arithmetic.h"
#include "parithmetic.h"
#define VIPS_TYPE_BINARY (vips_binary_get_type())
#define VIPS_BINARY( obj ) \

View File

@ -28,12 +28,8 @@
*/
/* We don't want to get confused with the arithmetic.h in include, put an
* extra _ in there.
*/
#ifndef VIPS__ARITHMETIC_H
#define VIPS__ARITHMETIC_H
#ifndef VIPS_PARITHMETIC_H
#define VIPS_PARITHMETIC_H
#ifdef __cplusplus
extern "C" {
@ -118,6 +114,6 @@ VipsVector *vips_arithmetic_get_program( VipsArithmeticClass *klass,
}
#endif /*__cplusplus*/
#endif /*VIPS__ARITHMETIC_H*/
#endif /*VIPS_PARITHMETIC_H*/

View File

@ -35,7 +35,7 @@
extern "C" {
#endif /*__cplusplus*/
#include "arithmetic.h"
#include "parithmetic.h"
#define VIPS_TYPE_UNARY (vips_unary_get_type())
#define VIPS_UNARY( obj ) \

View File

@ -50,7 +50,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourSpace VipsLCh2Lab;
typedef VipsColourSpaceClass VipsLCh2LabClass;

View File

@ -44,7 +44,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourSpace VipsLCh2CMC;
typedef VipsColourSpaceClass VipsLCh2CMCClass;

View File

@ -44,7 +44,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourSpace VipsLab2LCh;
typedef VipsColourSpaceClass VipsLab2LChClass;

View File

@ -69,7 +69,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourCode VipsLab2LabQ;
typedef VipsColourCodeClass VipsLab2LabQClass;

View File

@ -46,7 +46,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourCode VipsLab2LabS;
typedef VipsColourCodeClass VipsLab2LabSClass;

View File

@ -59,7 +59,7 @@
#include <vips/vips.h>
#include <vips/debug.h>
#include "colour.h"
#include "pcolour.h"
typedef struct _VipsLab2XYZ {
VipsColourSpace parent_instance;

View File

@ -56,7 +56,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourCode VipsLabQ2Lab;
typedef VipsColourCodeClass VipsLabQ2LabClass;

View File

@ -48,7 +48,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourCode VipsLabQ2LabS;
typedef VipsColourCodeClass VipsLabQ2LabSClass;

View File

@ -62,7 +62,7 @@
#include <vips/vips.h>
#include <vips/internal.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourCode VipsLabQ2sRGB;
typedef VipsColourCodeClass VipsLabQ2sRGBClass;

View File

@ -42,7 +42,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourCode VipsLabS2Lab;
typedef VipsColourCodeClass VipsLabS2LabClass;

View File

@ -53,7 +53,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourCode VipsLabS2LabQ;
typedef VipsColourCodeClass VipsLabS2LabQClass;

View File

@ -2,7 +2,7 @@ noinst_LTLIBRARIES = libcolour.la
libcolour_la_SOURCES = \
colour.c \
colour.h \
pcolour.h \
colourspace.c \
dE76.c \
dE00.c \

View File

@ -50,7 +50,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
/* Arrays for lookup tables for the inverse function.
*/

View File

@ -58,7 +58,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
#ifndef HAVE_CBRT
#define cbrt( X ) pow( (X), 1.0 / 3.0 )

View File

@ -47,7 +47,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourSpace VipsXYZ2Yxy;
typedef VipsColourSpaceClass VipsXYZ2YxyClass;

View File

@ -41,7 +41,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourSpace VipsXYZ2scRGB;
typedef VipsColourSpaceClass VipsXYZ2scRGBClass;

View File

@ -47,7 +47,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourSpace VipsYxy2XYZ;
typedef VipsColourSpaceClass VipsYxy2XYZClass;

View File

@ -44,7 +44,7 @@
#include <vips/vips.h>
#include <vips/internal.h>
#include "colour.h"
#include "pcolour.h"
/**
* SECTION: colour

View File

@ -47,7 +47,7 @@
#include <vips/vips.h>
#include <vips/internal.h>
#include "colour.h"
#include "pcolour.h"
static int
vips_scRGB2RGB16( VipsImage *in, VipsImage **out, ... )

View File

@ -42,7 +42,7 @@
#include <vips/vips.h>
#include <vips/debug.h>
#include "colour.h"
#include "pcolour.h"
typedef struct _VipsdE00 {
VipsColourDifference parent_instance;

View File

@ -47,7 +47,7 @@
#include <vips/vips.h>
#include <vips/debug.h>
#include "colour.h"
#include "pcolour.h"
typedef struct _VipsdE76 {
VipsColourDifference parent_instance;

View File

@ -40,7 +40,7 @@
#include <vips/vips.h>
#include <vips/debug.h>
#include "colour.h"
#include "pcolour.h"
typedef struct _VipsdECMC {
VipsColourDifference parent_instance;

View File

@ -111,7 +111,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
/* Begin copy-paste from Radiance sources.
*/

View File

@ -80,7 +80,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
/* Call lcms with up to this many pixels at once.
*/

View File

@ -28,12 +28,8 @@
*/
/* We don't want to get confused with the colour.h in include, put an
* extra _ in there.
*/
#ifndef VIPS__COLOUR_H
#define VIPS__COLOUR_H
#ifndef VIPS_PCOLOUR_H
#define VIPS_PCOLOUR_H
#ifdef __cplusplus
extern "C" {
@ -208,5 +204,5 @@ void vips__pythagoras_line( VipsColour *colour,
}
#endif /*__cplusplus*/
#endif /*VIPS__COLOUR_H*/
#endif /*VIPS_PCOLOUR_H*/

View File

@ -111,7 +111,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
/* Begin copy-paste from Radiance sources.
*/

View File

@ -52,7 +52,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourCode VipssRGB2scRGB;
typedef VipsColourCodeClass VipssRGB2scRGBClass;

View File

@ -47,7 +47,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef VipsColourSpace VipsscRGB2XYZ;
typedef VipsColourSpaceClass VipsscRGB2XYZClass;

View File

@ -64,7 +64,7 @@
#include <vips/vips.h>
#include "colour.h"
#include "pcolour.h"
typedef struct _VipsscRGB2sRGB {
VipsColourCode parent_instance;

View File

@ -2,7 +2,7 @@ noinst_LTLIBRARIES = libconversion.la
libconversion_la_SOURCES = \
conversion.c \
conversion.h \
pconversion.h \
tilecache.c \
sequential.c \
flatten.c \

View File

@ -35,7 +35,7 @@
extern "C" {
#endif /*__cplusplus*/
#include "conversion.h"
#include "pconversion.h"
#define VIPS_TYPE_BANDARY (vips_bandary_get_type())
#define VIPS_BANDARY( obj ) \

View File

@ -48,7 +48,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsCache {
VipsConversion parent_instance;

View File

@ -94,7 +94,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsCast {
VipsConversion parent_instance;

View File

@ -47,7 +47,7 @@
#include <vips/vips.h>
#include <vips/internal.h>
#include "conversion.h"
#include "pconversion.h"
/**
* SECTION: conversion

View File

@ -93,7 +93,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsCopy {
VipsConversion parent_instance;

View File

@ -72,7 +72,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsEmbed {
VipsConversion parent_instance;

View File

@ -83,7 +83,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "conversion.h"
#include "pconversion.h"
#include "bandary.h"

View File

@ -49,7 +49,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsFlatten {
VipsConversion parent_instance;

View File

@ -63,7 +63,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsFlip {
VipsConversion parent_instance;

View File

@ -48,7 +48,7 @@
#include <vips/vips.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsGrid {
VipsConversion parent_instance;

View File

@ -71,7 +71,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsIfthenelse {
VipsConversion parent_instance;

View File

@ -74,7 +74,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsInsert {
VipsConversion parent_instance;

View File

@ -67,7 +67,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsJoin {
VipsConversion parent_instance;

View File

@ -52,7 +52,7 @@
#include <vips/vips.h>
#include "conversion.h"
#include "pconversion.h"
#include "bandary.h"

View File

@ -28,12 +28,8 @@
*/
/* We don't want to get confused with the conversion.h in include, put an
* extra _ in there.
*/
#ifndef VIPS__CONVERSION_H
#define VIPS__CONVERSION_H
#ifndef VIPS_PCONVERSION_H
#define VIPS_PCONVERSION_H
#ifdef __cplusplus
extern "C" {
@ -76,6 +72,6 @@ GType vips_conversion_get_type( void );
}
#endif /*__cplusplus*/
#endif /*VIPS__CONVERSION_H*/
#endif /*VIPS_PCONVERSION_H*/

View File

@ -52,7 +52,7 @@
#include <vips/vips.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsRecomb {
VipsConversion parent_instance;

View File

@ -54,7 +54,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsReplicate {
VipsConversion parent_instance;

View File

@ -72,7 +72,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsRot {
VipsConversion parent_instance;

View File

@ -57,7 +57,7 @@
#include <vips/vips.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsScale {
VipsConversion parent_instance;

View File

@ -62,7 +62,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "conversion.h"
#include "pconversion.h"
/* Stall threads that run ahead for up to this long, in seconds.
*

View File

@ -50,7 +50,7 @@
#include <vips/vips.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsSubsample {
VipsConversion parent_instance;

View File

@ -75,7 +75,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "conversion.h"
#include "pconversion.h"
/* A tile in cache can be in one of three states:
*

View File

@ -46,7 +46,7 @@
#include <vips/vips.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsWrap {
VipsConversion parent_instance;

View File

@ -80,7 +80,7 @@
#include <vips/vips.h>
#include "conversion.h"
#include "pconversion.h"
typedef struct _VipsZoom {
VipsConversion parent_instance;

View File

@ -2,7 +2,7 @@ noinst_LTLIBRARIES = libcreate.la
libcreate_la_SOURCES = \
create.c \
create.h \
pcreate.h \
point.c \
point.h \
eye.c \

View File

@ -61,7 +61,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "create.h"
#include "pcreate.h"
typedef struct _VipsBlack {
VipsCreate parent_instance;

View File

@ -47,7 +47,7 @@
#include <vips/vips.h>
#include <vips/internal.h>
#include "create.h"
#include "pcreate.h"
/**
* SECTION: create

View File

@ -58,7 +58,7 @@
#include <vips/vips.h>
#include "create.h"
#include "pcreate.h"
#include "point.h"
typedef struct _VipsEye {

View File

@ -59,7 +59,7 @@
#include <vips/vips.h>
#include "create.h"
#include "pcreate.h"
typedef struct _VipsGaussnoise {
VipsCreate parent_instance;

View File

@ -65,7 +65,7 @@
#include <vips/vips.h>
#include "create.h"
#include "pcreate.h"
#include "point.h"
typedef VipsPoint VipsGrey;

View File

@ -28,12 +28,8 @@
*/
/* We don't want to get confused with the create.h in include, put an
* extra _ in there.
*/
#ifndef VIPS__CREATE_H
#define VIPS__CREATE_H
#ifndef VIPS_PCREATE_H
#define VIPS_PCREATE_H
#ifdef __cplusplus
extern "C" {
@ -74,6 +70,6 @@ GType vips_create_get_type( void );
}
#endif /*__cplusplus*/
#endif /*VIPS__CREATE_H*/
#endif /*VIPS_PCREATE_H*/

View File

@ -58,7 +58,7 @@
#include <vips/vips.h>
#include "create.h"
#include "pcreate.h"
#include "point.h"
G_DEFINE_ABSTRACT_TYPE( VipsPoint, vips_point, VIPS_TYPE_CREATE );

View File

@ -28,12 +28,8 @@
*/
/* We don't want to get confused with the point.h in include, put an
* extra _ in there.
*/
#ifndef VIPS__POINT_H
#define VIPS__POINT_H
#ifndef VIPS_POINT_H
#define VIPS_POINT_H
#ifdef __cplusplus
extern "C" {
@ -77,4 +73,4 @@ GType vips_point_get_type( void );
}
#endif /*__cplusplus*/
#endif /*VIPS__POINT_H*/
#endif /*VIPS_POINT_H*/

View File

@ -57,7 +57,7 @@
#include <vips/vips.h>
#include "create.h"
#include "pcreate.h"
#include "point.h"
typedef struct _VipsSines {

View File

@ -56,7 +56,7 @@
#include <pango/pango.h>
#include <pango/pangoft2.h>
#include "create.h"
#include "pcreate.h"
typedef struct _VipsText {
VipsCreate parent_instance;

View File

@ -52,7 +52,7 @@
#include <vips/internal.h>
#include <vips/debug.h>
#include "create.h"
#include "pcreate.h"
typedef struct _VipsXyz {
VipsCreate parent_instance;

View File

@ -58,7 +58,7 @@
#include <vips/vips.h>
#include "create.h"
#include "pcreate.h"
#include "point.h"
typedef VipsPoint VipsZone;

View File

@ -8,7 +8,7 @@ libresample_la_SOURCES = \
affine.c \
quadratic.c \
resample.c \
resample.h \
presample.h \
shrink.c \
interpolate.c \
transform.c \
@ -22,7 +22,7 @@ else
libresample_la_SOURCES = \
resample.c \
resample.h \
presample.h \
shrink.c \
affine.c \
interpolate.c \

View File

@ -129,7 +129,7 @@
#include <vips/internal.h>
#include <vips/transform.h>
#include "resample.h"
#include "presample.h"
typedef struct _VipsAffine {
VipsResample parent_instance;

View File

@ -28,12 +28,8 @@
*/
/* We don't want to get confused with the resample.h in include, put an
* extra _ in there.
*/
#ifndef VIPS__RESAMPLE_H
#define VIPS__RESAMPLE_H
#ifndef VIPS_PRESAMPLE_H
#define VIPS_PRESAMPLE_H
#ifdef __cplusplus
extern "C" {
@ -73,6 +69,6 @@ GType vips_resample_get_type( void );
}
#endif /*__cplusplus*/
#endif /*VIPS__RESAMPLE_H*/
#endif /*VIPS_PRESAMPLE_H*/

View File

@ -51,7 +51,7 @@
#include <vips/vips.h>
#include <vips/debug.h>
#include "resample.h"
#include "presample.h"
/* The transform we compute:

View File

@ -50,7 +50,7 @@
#include <vips/vips.h>
#include <vips/internal.h>
#include "resample.h"
#include "presample.h"
G_DEFINE_ABSTRACT_TYPE( VipsResample, vips_resample, VIPS_TYPE_OPERATION );

View File

@ -86,7 +86,7 @@
#include <vips/vips.h>
#include <vips/debug.h>
#include "resample.h"
#include "presample.h"
typedef struct _VipsShrink {
VipsResample parent_instance;