callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Handle gtk-doc just like GTK+ does it now:

Browse Source 
2002-03-08  Sven Neumann  <sven@gimp.org>

	Handle gtk-doc just like GTK+ does it now:

	* configure.in: check for gtk-doc version 0.9. Do not build the API
	reference by default.

	* autogen.sh: pass --enable-gtk-doc to configure.

	* Makefile.am: Added a slightly modified distcheck rule that passes
        --enable-gtk-doc to the configure inside.

	* NEWS: updated.

Revival of the API reference framework.
Misc fixes.
This commit is contained in:
Sven Neumann
2002-03-08 12:36:40 +00:00
committed by Sven Neumann
parent 2d1b904752
commit 906a8784ba
67 changed files with 936 additions and 6066 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
devel-docs/libgimpcolor/.cvsignore
View File

@ -1,7 +1,12 @@
Makefile
Makefile.in
libgimpcolor.html
libgimpcolor.args
libgimpcolor.hierarchy
libgimpcolor.signals
libgimpcolor-decl.txt
libgimpcolor-decl-list.txt
libgimpcolor-unused.txt
libgimpcolor-undocumented.txt
html
sgml
*.stamp

194
devel-docs/libgimpcolor/Makefile.am
View File

@ -1,72 +1,148 @@
## Process this file with automake to produce Makefile.in
# The name of the module.
DOC_MODULE=libgimpcolor
DOC_MODULE = libgimpcolor
# The top-level SGML file.
DOC_MAIN_SGML_FILE=libgimpcolor-docs.sgml
DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml
# The directory containing the source code (if it contains documentation).
DOC_SOURCE_DIR=$(top_srcdir)/libgimpcolor
# The directory containing the source code.
DOC_SOURCE_DIR = $(top_srcdir)/$(DOC_MODULE)
CFLAGS=`gimptool-1.4 --cflags`
LDFLAGS=`gimptool-1.4 --libs`
# Extra options to pass to gtkdoc-scangobj
SCANGOBJ_OPTIONS =
# Extra options to supply to gtkdoc-scan
SCAN_OPTIONS =
# Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS =
# Extra options to supply to gtkdoc-fixref
FIXXREF_OPTIONS =
# Used for dependencies
HFILE_GLOB = $(DOC_SOURCE_DIR)/*.h
CFILE_GLOB = $(DOC_SOURCE_DIR)/*.c
# Header files to ignore when scanning
IGNORE_HFILES =
# Images to copy into HTML directory
HTML_IMAGES=
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
content_files =
# Other files to distribute
extra_files =
# CFLAGS and LDFLAGS for compiling scan program. Only needed
# if $(DOC_MODULE).types is non-empty.
GTKDOC_CFLAGS =
GTKDOC_LIBS =
GTKDOC_CC = $(LIBTOOL) --mode=compile $(CC)
GTKDOC_LD = $(LIBTOOL) --mode=link $(CC)
####################################
# Everything below here is generic #
####################################
# We set GPATH here; this gives us semantics for GNU make
# which are more like other make's VPATH, when it comes to
# whether a source that is a target of one rule is then
# searched for in VPATH/GPATH.
#
GPATH = $(srcdir)
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
libgimpcolor_docdir = $(HTML_DIR)
EXTRA_DIST = \
$(DOC_MAIN_SGML_FILE) \
$(DOC_MODULE).hierarchy \
$(DOC_MODULE).signals \
EXTRA_DIST = \
$(content_files) \
$(extra_files) \
$(HTML_IMAGES) \
$(DOC_MAIN_SGML_FILE) \
$(DOC_MODULE).types \
$(DOC_MODULE)-include.c \
$(DOC_MODULE)-decl.txt \
$(DOC_MODULE)-sections.txt
DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
$(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
SCANOBJ_FILES = \
$(DOC_MODULE).args \
$(DOC_MODULE).hierarchy \
$(DOC_MODULE).signals
if ENABLE_GTK_DOC
html/index.html: sgml/libgimpcolor-doc.bottom
$(MAKE) html
else
html/index.html:
all-local: html-build.stamp
#### scan ####
scan-build.stamp: $(HFILE_GLOB)
@echo '*** Scanning header files ***'
if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
else \
cd $(srcdir) ; \
for i in $(SCANOBJ_FILES) ; do \
test -f $$i || touch $$i ; \
done \
fi
cd $(srcdir) && \
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
touch scan-build.stamp
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
@true
#### templates ####
tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt
@echo '*** Rebuilding template files ***'
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
touch tmpl-build.stamp
tmpl.stamp: tmpl-build.stamp
@true
#### sgml ####
sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
@echo '*** Building SGML ***'
cd $(srcdir) && \
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS)
touch sgml-build.stamp
sgml.stamp: sgml-build.stamp
@true
#### html ####
html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
@echo '*** Building HTML ***'
rm -rf $(srcdir)/html
mkdir $(srcdir)/html
cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
@echo '-- Fixing Crossreferences'
cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
touch html-build.stamp
endif
sgml/libgimpcolor-doc.bottom: $(tmpl_sources)
$(MAKE) sgml
scan:
-(cd $(srcdir) \
&& env \
CFLAGS="$(CFLAGS)" \
CPPFLAGS="$(CPPFLAGS)" \
LDFLAGS="$(LDFLAGS)" \
gtkdoc-scanobj --module=$(DOC_MODULE) \
&& gtkdoc-scan \
--module=$(DOC_MODULE) \
--source-dir=$(DOC_SOURCE_DIR))
templates: scan
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
sgml:
cd $(srcdir) \
&& gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
html:
test -d $(srcdir)/html || mkdir $(srcdir)/html
-cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
##############
clean-local:
rm -f *~ *.bak *-unused.txt
rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
maintainer-clean-local: clean
cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
install-data-local:
install-data-local:
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
(installfiles=`echo $(srcdir)/html/*.html`; \
if test "$$installfiles" = '$(srcdir)/html/*.html'; \
(installfiles=`echo $(srcdir)/html/*`; \
if test "$$installfiles" = '$(srcdir)/html/*'; \
then echo '-- Nothing to install' ; \
else \
for i in $$installfiles; do \
@ -75,17 +151,25 @@ install-data-local:
done; \
echo '-- Installing $(srcdir)/html/index.sgml' ; \
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
echo '-- Fixing Crossreferences' ; \
gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \
fi)
dist-hook:
mkdir $(distdir)/html
mkdir $(distdir)/sgml
#
# Require gtk-doc when making dist
#
if ENABLE_GTK_DOC
dist-check-gtkdoc:
else
dist-check-gtkdoc:
@echo "*** gtk-doc must be installed and enabled in order to make dist"
@false
endif
dist-hook: dist-check-gtkdoc dist-hook-local
mkdir $(distdir)/tmpl
-cp $(srcdir)/html/*.html $(srcdir)/html/index.sgml $(distdir)/html
mkdir $(distdir)/sgml
mkdir $(distdir)/html
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
-cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
-cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
-cp $(srcdir)/html/* $(distdir)/html
.PHONY : html sgml templates scan
.PHONY : dist-hook-local

306
devel-docs/libgimpcolor/libgimpcolor-decl.txt
View File

@ -1,306 +0,0 @@
<ENUM>
<NAME>GimpRGBCompositeMode</NAME>
typedef enum
{
GIMP_RGB_COMPOSITE_NONE = 0,
GIMP_RGB_COMPOSITE_NORMAL,
GIMP_RGB_COMPOSITE_BEHIND
} GimpRGBCompositeMode;
</ENUM>
<FUNCTION>
<NAME>gimp_rgb_set</NAME>
<RETURNS>void </RETURNS>
GimpRGB *rgb,gdouble r,gdouble g,gdouble b
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_set_alpha</NAME>
<RETURNS>void </RETURNS>
GimpRGB *rgb,gdouble a
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_set_uchar</NAME>
<RETURNS>void </RETURNS>
GimpRGB *rgb,guchar r,guchar g,guchar b
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_get_uchar</NAME>
<RETURNS>void </RETURNS>
const GimpRGB *rgb,guchar *r,guchar *g,guchar *b
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_add</NAME>
<RETURNS>void </RETURNS>
GimpRGB *rgb1,const GimpRGB *rgb2
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_subtract</NAME>
<RETURNS>void </RETURNS>
GimpRGB *rgb1,const GimpRGB *rgb2
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_multiply</NAME>
<RETURNS>void </RETURNS>
GimpRGB *rgb1,gdouble factor
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_distance</NAME>
<RETURNS>gdouble </RETURNS>
const GimpRGB *rgb1,const GimpRGB *rgb2
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_max</NAME>
<RETURNS>gdouble </RETURNS>
const GimpRGB *rgb
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_min</NAME>
<RETURNS>gdouble </RETURNS>
const GimpRGB *rgb
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_clamp</NAME>
<RETURNS>void </RETURNS>
GimpRGB *rgb
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_gamma</NAME>
<RETURNS>void </RETURNS>
GimpRGB *rgb,gdouble gamma
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_intensity</NAME>
<RETURNS>gdouble </RETURNS>
const GimpRGB *rgb
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_intensity_uchar</NAME>
<RETURNS>guchar </RETURNS>
const GimpRGB *rgb
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_composite</NAME>
<RETURNS>void </RETURNS>
GimpRGB *color1,const GimpRGB *color2,GimpRGBCompositeMode mode
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgba_set</NAME>
<RETURNS>void </RETURNS>
GimpRGB *rgba,gdouble r,gdouble g,gdouble b,gdouble a
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgba_set_uchar</NAME>
<RETURNS>void </RETURNS>
GimpRGB *rgba,guchar r,guchar g,guchar b,guchar a
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgba_get_uchar</NAME>
<RETURNS>void </RETURNS>
const GimpRGB *rgba,guchar *r,guchar *g,guchar *b,guchar *a
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgba_add</NAME>
<RETURNS>void </RETURNS>
GimpRGB *rgba1,const GimpRGB *rgba2
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgba_subtract</NAME>
<RETURNS>void </RETURNS>
GimpRGB *rgba1,const GimpRGB *rgba2
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgba_multiply</NAME>
<RETURNS>void </RETURNS>
GimpRGB *rgba,gdouble factor
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgba_distance</NAME>
<RETURNS>gdouble </RETURNS>
const GimpRGB *rgba1,const GimpRGB *rgba2
</FUNCTION>
<MACRO>
<NAME>INTENSITY_RED</NAME>
#define INTENSITY_RED 0.30
</MACRO>
<MACRO>
<NAME>INTENSITY_GREEN</NAME>
#define INTENSITY_GREEN 0.59
</MACRO>
<MACRO>
<NAME>INTENSITY_BLUE</NAME>
#define INTENSITY_BLUE 0.11
</MACRO>
<MACRO>
<NAME>INTENSITY</NAME>
#define INTENSITY(r,g,b) ((r) * INTENSITY_RED + \
(g) * INTENSITY_GREEN + \
(b) * INTENSITY_BLUE + 0.001)
</MACRO>
<FUNCTION>
<NAME>gimp_hsv_set</NAME>
<RETURNS>void </RETURNS>
GimpHSV *hsv,gdouble h,gdouble s,gdouble v
</FUNCTION>
<FUNCTION>
<NAME>gimp_hsv_clamp</NAME>
<RETURNS>void </RETURNS>
GimpHSV *hsv
</FUNCTION>
<FUNCTION>
<NAME>gimp_hsva_set</NAME>
<RETURNS>void </RETURNS>
GimpHSV *hsva,gdouble h,gdouble s,gdouble v,gdouble a
</FUNCTION>
<STRUCT>
<NAME>GimpRGB</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpRGB</NAME>
struct GimpRGB
{
gdouble r, g, b, a;
};
</STRUCT>
<STRUCT>
<NAME>GimpHSV</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpHSV</NAME>
struct GimpHSV
{
gdouble h, s, v, a;
};
</STRUCT>
<USER_FUNCTION>
<NAME>GimpRenderFunc</NAME>
<RETURNS>void </RETURNS>
gdouble x,
gdouble y,
GimpRGB *color,
gpointer data
</USER_FUNCTION>
<USER_FUNCTION>
<NAME>GimpPutPixelFunc</NAME>
<RETURNS>void </RETURNS>
gint x,
gint y,
GimpRGB *color,
gpointer data
</USER_FUNCTION>
<USER_FUNCTION>
<NAME>GimpProgressFunc</NAME>
<RETURNS>void </RETURNS>
gint min,
gint max,
gint current,
gpointer data
</USER_FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_to_hsv</NAME>
<RETURNS>void </RETURNS>
const GimpRGB *rgb,GimpHSV *hsv
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_to_hsl</NAME>
<RETURNS>void </RETURNS>
const GimpRGB *rgb,gdouble *hue,gdouble *saturation,gdouble *lightness
</FUNCTION>
<FUNCTION>
<NAME>gimp_hsv_to_rgb</NAME>
<RETURNS>void </RETURNS>
const GimpHSV *hsv,GimpRGB *rgb
</FUNCTION>
<FUNCTION>
<NAME>gimp_hsl_to_rgb</NAME>
<RETURNS>void </RETURNS>
gdouble hue,gdouble saturation,gdouble lightness,GimpRGB *rgb
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_to_hwb</NAME>
<RETURNS>void </RETURNS>
const GimpRGB *rgb,gdouble *hue,gdouble *whiteness,gdouble *blackness
</FUNCTION>
<FUNCTION>
<NAME>gimp_hwb_to_rgb</NAME>
<RETURNS>void </RETURNS>
gdouble hue,gdouble whiteness,gdouble blackness,GimpRGB *rgb
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_to_hsv_int</NAME>
<RETURNS>void </RETURNS>
gint *red ,gint *green ,gint *blue
</FUNCTION>
<FUNCTION>
<NAME>gimp_hsv_to_rgb_int</NAME>
<RETURNS>void </RETURNS>
gint *hue ,gint *saturation ,gint *value
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_to_hls_int</NAME>
<RETURNS>void </RETURNS>
gint *red ,gint *green ,gint *blue
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_to_l_int</NAME>
<RETURNS>gint </RETURNS>
gint red,gint green,gint blue
</FUNCTION>
<FUNCTION>
<NAME>gimp_hls_to_rgb_int</NAME>
<RETURNS>void </RETURNS>
gint *hue ,gint *lightness ,gint *saturation
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_to_hsv_double</NAME>
<RETURNS>void </RETURNS>
gdouble *red ,gdouble *green ,gdouble *blue
</FUNCTION>
<FUNCTION>
<NAME>gimp_hsv_to_rgb_double</NAME>
<RETURNS>void </RETURNS>
gdouble *hue ,gdouble *saturation,gdouble *value
</FUNCTION>
<FUNCTION>
<NAME>gimp_rgb_to_hsv4</NAME>
<RETURNS>void </RETURNS>
guchar *hsv,gdouble *red,gdouble *green,gdouble *blue
</FUNCTION>
<FUNCTION>
<NAME>gimp_hsv_to_rgb4</NAME>
<RETURNS>void </RETURNS>
guchar *rgb,gdouble hue,gdouble saturation,gdouble value
</FUNCTION>
<FUNCTION>
<NAME>gimp_adaptive_supersample_area</NAME>
<RETURNS>gulong </RETURNS>
gint x1,gint y1,gint x2,gint y2,gint max_depth,gdouble threshold,GimpRenderFunc render_func,gpointer render_data,GimpPutPixelFunc put_pixel_func,gpointer put_pixel_data,GimpProgressFunc progress_func,gpointer progress_data
</FUNCTION>
<FUNCTION>
<NAME>gimp_bilinear</NAME>
<RETURNS>gdouble </RETURNS>
gdouble x,gdouble y,gdouble *values
</FUNCTION>
<FUNCTION>
<NAME>gimp_bilinear_8</NAME>
<RETURNS>guchar </RETURNS>
gdouble x,gdouble y,guchar *values
</FUNCTION>
<FUNCTION>
<NAME>gimp_bilinear_16</NAME>
<RETURNS>guint16 </RETURNS>
gdouble x,gdouble y,guint16 *values
</FUNCTION>
<FUNCTION>
<NAME>gimp_bilinear_32</NAME>
<RETURNS>guint32 </RETURNS>
gdouble x,gdouble y,guint32 *values
</FUNCTION>
<FUNCTION>
<NAME>gimp_bilinear_rgb</NAME>
<RETURNS>GimpRGB </RETURNS>
gdouble x,gdouble y,GimpRGB *values
</FUNCTION>
<FUNCTION>
<NAME>gimp_bilinear_rgba</NAME>
<RETURNS>GimpRGB </RETURNS>
gdouble x,gdouble y,GimpRGB *values
</FUNCTION>

15
devel-docs/libgimpcolor/libgimpcolor-include.c
View File

@ -1,15 +0,0 @@
/*
* gtk-doc can't build libgimpcolor-scan.c without PLUG_IN_INFO being defined
* so we include this file as a workaround
*/
#include <glib.h>
#include <libgimp/gimp.h>
GimpPlugInInfo PLUG_IN_INFO =
{
NULL,
NULL,
NULL,
NULL,
};

0
devel-docs/libgimpcolor/libgimpcolor.args
View File

21
devel-docs/libgimpcolor/libgimpcolor.hierarchy
View File

@ -1,21 +0,0 @@
GtkObject
GtkWidget
GtkRange
GtkScrollbar
GtkVScrollbar
GtkHScrollbar
GtkScale
GtkHScale
GtkVScale
GtkContainer
GtkBin
GtkButton
GtkToggleButton
GtkCheckButton
GtkRadioButton
GtkScrolledWindow
GtkPaned
GtkVPaned
GtkHPaned
GtkData
GtkAdjustment

0
devel-docs/libgimpcolor/libgimpcolor.signals
View File

3
devel-docs/libgimpcolor/libgimpcolor.types
View File

@ -1,3 +0,0 @@
#include <gtk/gtk.h>
#include "libgimpcolor-include.c"