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/libgimp/.cvsignore
View File

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

199
devel-docs/libgimp/Makefile.am
View File

@ -1,73 +1,152 @@
## Process this file with automake to produce Makefile.in
# The name of the module.
DOC_MODULE=libgimp
DOC_MODULE = libgimp
# The top-level SGML file.
DOC_MAIN_SGML_FILE=libgimp-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)/libgimp
# 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 = --extra-dir=../libgimpbase/html --extra-dir=../libgimpcolor/html --extra-dir=../libgimpmath/html --extra-dir=../libgimpwidgets/html
# Used for dependencies
HFILE_GLOB = $(DOC_SOURCE_DIR)/*.h
CFILE_GLOB = $(DOC_SOURCE_DIR)/*.c
# Header files to ignore when scanning
IGNORE_HFILES = \
gimpintl.h \
libgimp-intl.h \
stdplugins-intl.h \
gserialize.h
# 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)
libgimp_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/libgimp-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/libgimp-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) \
--ignore-headers="gimpintl.h libgimp-intl.h stdplugins-intl.h gserialize.h")
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 \
@ -76,17 +155,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

2725
devel-docs/libgimp/libgimp-decl.txt
View File

File diff suppressed because it is too large Load Diff

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

21
devel-docs/libgimp/libgimp.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/libgimp/libgimp.signals
View File

5
devel-docs/libgimp/libgimp.types
View File

@ -1,5 +0,0 @@
#include <gtk/gtk.h>
#include <libgimp/gimp.h>
#include <libgimp/gimpui.h>
#include "libgimp-include.c"

16
devel-docs/libgimp/tmpl/gimp.sgml
View File

@ -286,22 +286,6 @@ all other GIMP Library headers.
@Returns:
<!-- ##### FUNCTION gimp_use_xshm ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gimp_color_cube ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gimp_min_colors ##### -->
<para>

4
devel-docs/libgimp/tmpl/gimpcolorselector.sgml
View File

@ -133,9 +133,11 @@ instances have finished. The callback could be used to unload
dynamiclly loaded code, for example.
</para>
@id: The @id as returned by gimp_color_selector_register().
@selector_id:
@finished_cb: Optional callback which will be called once all instances have finished.
@finished_data: The @finished_data which will be passed to @finished_cb.
@Returns: #TRUE on success, #FALSE if @id was not found.
<!-- # Unused Parameters # -->
@id: The @id as returned by gimp_color_selector_register().

2
devel-docs/libgimp/tmpl/gimpdrawable.sgml
View File

@ -19,7 +19,7 @@ gimpdrawable
</para>
@id:
@drawable_id:
@width:
@height:
@bpp:

43
devel-docs/libgimp/tmpl/gimpenums.sgml
View File

@ -25,6 +25,8 @@ Enums and definitions.
@GIMP_ALPHA_MASK:
@GIMP_SELECTION_MASK:
@GIMP_INV_SELECTION_MASK:
@GIMP_COPY_MASK:
@GIMP_INV_COPY_MASK:
<!-- ##### ENUM GimpBlendMode ##### -->
<para>
@ -135,15 +137,6 @@ Enums and definitions.
@GIMP_SHARPEN_CONVOLVE:
@GIMP_CUSTOM_CONVOLVE:
<!-- ##### ENUM GimpDodgeBurnMode ##### -->
<para>
</para>
@GIMP_DODGEBURN_HIGHLIGHTS:
@GIMP_DODGEBURN_MIDTONES:
@GIMP_DODGEBURN_SHADOWS:
<!-- ##### ENUM GimpDodgeBurnType ##### -->
<para>
@ -233,15 +226,6 @@ Enums and definitions.
@GIMP_BLUE_HUES:
@GIMP_MAGENTA_HUES:
<!-- ##### ENUM GimpInterpolationType ##### -->
<para>
</para>
@GIMP_LINEAR_INTERPOLATION:
@GIMP_CUBIC_INTERPOLATION:
@GIMP_NEAREST_NEIGHBOR_INTERPOLATION:
<!-- ##### ENUM GimpLayerModeEffects ##### -->
<para>
@ -266,6 +250,7 @@ Enums and definitions.
@GIMP_DODGE_MODE:
@GIMP_BURN_MODE:
@GIMP_HARDLIGHT_MODE:
@GIMP_COLOR_ERASE_MODE:
<!-- ##### ENUM GimpMaskApplyMode ##### -->
<para>
@ -285,15 +270,6 @@ Enums and definitions.
@GIMP_CLIP_TO_BOTTOM_LAYER:
@GIMP_FLATTEN_IMAGE:
<!-- ##### ENUM GimpMessageHandlerType ##### -->
<para>
</para>
@GIMP_MESSAGE_BOX:
@GIMP_CONSOLE:
@GIMP_ERROR_CONSOLE:
<!-- ##### ENUM GimpOrientationType ##### -->
<para>
@ -320,15 +296,17 @@ Enums and definitions.
@GIMP_REPEAT_SAWTOOTH:
@GIMP_REPEAT_TRIANGULAR:
<!-- ##### ENUM GimpRunModeType ##### -->
<!-- ##### MACRO GimpRunModeType ##### -->
<para>
</para>
<!-- # Unused Parameters # -->
@GIMP_RUN_INTERACTIVE:
@GIMP_RUN_NONINTERACTIVE:
@GIMP_RUN_WITH_LAST_VALS:
<!-- ##### ENUM GimpSizeType ##### -->
<para>
@ -337,15 +315,6 @@ Enums and definitions.
@GIMP_PIXELS:
@GIMP_POINTS:
<!-- ##### ENUM GimpStackTraceMode ##### -->
<para>
</para>
@GIMP_STACK_TRACE_NEVER:
@GIMP_STACK_TRACE_QUERY:
@GIMP_STACK_TRACE_ALWAYS:
<!-- ##### ENUM GimpTransferMode ##### -->
<para>

2
devel-docs/libgimp/tmpl/gimpgradients.sgml
View File

@ -65,8 +65,8 @@ gimpgradients
</para>
@name:
@width:
@sample_size:
@width:
@grad_data:
@Returns:

4
devel-docs/libgimp/tmpl/gimpmenu.sgml
View File

@ -30,8 +30,10 @@ Widgets and functions for selecting images, layers, brushes, patterns etc.
</para>
@id:
@any_id:
@data:
<!-- # Unused Parameters # -->
@id:
<!-- ##### USER_FUNCTION GimpRunBrushCallback ##### -->

15
devel-docs/libgimp/tmpl/gimptools.sgml
View File

@ -133,10 +133,10 @@ gimptools
@sample_merged:
@sample_average:
@average_radius:
@save_color:
@color:
@Returns:
<!-- # Unused Parameters # -->
@save_color:
@red:
@green:
@blue:
@ -166,19 +166,6 @@ gimptools
@Returns:
<!-- ##### FUNCTION gimp_crop ##### -->
<para>
</para>
@image_ID:
@new_width:
@new_height:
@offx:
@offy:
@Returns:
<!-- ##### FUNCTION gimp_dodgeburn ##### -->
<para>