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

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

View File

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

View File

@ -1,72 +1,162 @@
## Process this file with automake to produce Makefile.in
# The name of the module.
DOC_MODULE=libgimpwidgets
DOC_MODULE = libgimpwidgets
# The top-level SGML file.
DOC_MAIN_SGML_FILE=libgimpwidgets-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)/libgimpwidgets
# 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 = libgimp-include.c
# CFLAGS and LDFLAGS for compiling scan program. Only needed
# if $(DOC_MODULE).types is non-empty.
GTKDOC_CFLAGS = @STRIP_BEGIN@ \
@CFLAGS@ \
-I$(top_srcdir) \
-I$(top_builddir) \
@GTK_CFLAGS@ \
@STRIP_END@
GTKDOC_LIBS = @STRIP_BEGIN@ \
$(top_builddir)/libgimpbase/libgimpbase-$(LT_RELEASE).la \
$(top_builddir)/libgimpcolor/libgimpcolor-$(LT_RELEASE).la \
$(top_builddir)/libgimpmath/libgimpmath-$(LT_RELEASE).la \
$(top_builddir)/libgimpwidgets/libgimpwidgets-$(LT_RELEASE).la \
$(top_builddir)/libgimp/libgimp-$(LT_RELEASE).la \
$(top_builddir)/libgimp/libgimpui-$(LT_RELEASE).la \
@GTK_LIBS@ \
@STRIP_END@
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)
libgimpwidgets_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/libgimpwidgets-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/libgimpwidgets-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 +165,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

File diff suppressed because it is too large Load Diff

View File

@ -1,35 +0,0 @@
GtkObject
GtkWidget
GtkRange
GtkScrollbar
GtkVScrollbar
GtkHScrollbar
GtkScale
GtkHScale
GtkVScale
GtkContainer
GtkBin
GtkButton
GtkToggleButton
GtkCheckButton
GtkRadioButton
GimpColorButton
GtkOptionMenu
GimpUnitMenu
GtkScrolledWindow
GtkPaned
GtkVPaned
GtkHPaned
GtkTable
GimpChainButton
GimpSizeEntry
GtkBox
GtkHBox
GimpFileSelection
GtkVBox
GimpPathEditor
GtkMisc
GtkPixmap
GimpPixmap
GtkData
GtkAdjustment

View File

@ -1,48 +0,0 @@
<SIGNAL>
<NAME>GimpChainButton::toggled</NAME>
<RETURNS>void</RETURNS>
GimpChainButton *gimpchainbutton
</SIGNAL>
<SIGNAL>
<NAME>GimpColorButton::color-changed</NAME>
<RETURNS>void</RETURNS>
GimpColorButton *gimpcolorbutton
</SIGNAL>
<SIGNAL>
<NAME>GimpFileSelection::filename-changed</NAME>
<RETURNS>void</RETURNS>
GimpFileSelection *gimpfileselection
</SIGNAL>
<SIGNAL>
<NAME>GimpPathEditor::path-changed</NAME>
<RETURNS>void</RETURNS>
GimpPathEditor *gimppatheditor
</SIGNAL>
<SIGNAL>
<NAME>GimpSizeEntry::value-changed</NAME>
<RETURNS>void</RETURNS>
GimpSizeEntry *gimpsizeentry
</SIGNAL>
<SIGNAL>
<NAME>GimpSizeEntry::refval-changed</NAME>
<RETURNS>void</RETURNS>
GimpSizeEntry *gimpsizeentry
</SIGNAL>
<SIGNAL>
<NAME>GimpSizeEntry::unit-changed</NAME>
<RETURNS>void</RETURNS>
GimpSizeEntry *gimpsizeentry
</SIGNAL>
<SIGNAL>
<NAME>GimpUnitMenu::unit-changed</NAME>
<RETURNS>void</RETURNS>
GimpUnitMenu *gimpunitmenu
</SIGNAL>

View File

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

View File

@ -51,6 +51,8 @@ up two GimpSizeEntries (see #GimpSizeEntry) linked with a #GimpChainButton.
</para>
@gcb:
@active:
<!-- # Unused Parameters # -->
@is_active:

View File

@ -69,6 +69,8 @@ color, the "color_changed" signal is emitted.
</para>
@gcb:
@type:
<!-- # Unused Parameters # -->
@alpha:

View File

@ -49,14 +49,6 @@ dialog-related stuff.
@Returns:
<!-- ##### FUNCTION gimp_dialog_set_icon ##### -->
<para>
</para>
@dialog:
<!-- ##### FUNCTION gimp_dialog_create_action_area ##### -->
<para>

View File

@ -63,16 +63,6 @@ See #GimpHelpFunc for the naming conventions of HTML help files.
@help_data: A string containing the path to a HTML page.
<!-- ##### FUNCTION gimp_help_connect_help_accel ##### -->
<para>
</para>
@widget:
@help_func:
@help_data:
<!-- ##### FUNCTION gimp_help_set_help_data ##### -->
<para>

View File

@ -166,7 +166,7 @@ Note that you have to g_free() the returned string.
@title:
@help_func:
@help_data:
@eek:
@stock_id:
@message:
@true_button:
@false_button:
@ -175,5 +175,7 @@ Note that you have to g_free() the returned string.
@callback:
@data:
@Returns:
<!-- # Unused Parameters # -->
@eek:

View File

@ -59,9 +59,11 @@ gimp_coordinates_new()
@menu_show_pixels:
@menu_show_percent:
@show_refval:
@spinbutton_usize:
@spinbutton_width:
@update_policy:
@Returns:
<!-- # Unused Parameters # -->
@spinbutton_usize:
<!-- ##### FUNCTION gimp_size_entry_add_field ##### -->
@ -206,13 +208,6 @@ gimp_coordinates_new()
@gse:
<!-- ##### SIGNAL GimpSizeEntry::value-changed ##### -->
<para>
</para>
@gimpsizeentry: the object which received the signal.
<!-- ##### SIGNAL GimpSizeEntry::refval-changed ##### -->
<para>
@ -227,3 +222,10 @@ gimp_coordinates_new()
@gimpsizeentry: the object which received the signal.
<!-- ##### SIGNAL GimpSizeEntry::value-changed ##### -->
<para>
</para>
@gimpsizeentry: the object which received the signal.

View File

@ -96,10 +96,12 @@ gtk_object_set_user_data().</entry>
@menu_only:
@menu_item_callback:
@data:
@menu_item_callback_data:
@initial:
@Varargs:
@Returns:
<!-- # Unused Parameters # -->
@data:
<!-- ##### FUNCTION gimp_option_menu_set_history ##### -->
@ -108,6 +110,8 @@ gtk_object_set_user_data().</entry>
</para>
@option_menu:
@item_data:
<!-- # Unused Parameters # -->
@user_data:
@ -194,10 +198,12 @@ gtk_object_set_user_data().</entry>
@in_frame:
@frame_title:
@radio_button_callback:
@data:
@radio_button_callback_data:
@initial:
@Varargs:
@Returns:
<!-- # Unused Parameters # -->
@data:
<!-- ##### FUNCTION gimp_spin_button_new ##### -->
@ -266,8 +272,8 @@ Returns the #GtkAdjustment of the scale_entry's #GtkSpinButton.
@column:
@row:
@text:
@scale_usize:
@spinbutton_usize:
@scale_width:
@spinbutton_width:
@value:
@lower:
@upper:
@ -280,6 +286,9 @@ Returns the #GtkAdjustment of the scale_entry's #GtkSpinButton.
@tooltip:
@help_data:
@Returns:
<!-- # Unused Parameters # -->
@scale_usize:
@spinbutton_usize:
<!-- ##### MACRO GIMP_RANDOM_SEED_SPINBUTTON ##### -->
@ -335,7 +344,7 @@ Returns the #GimpChainButton which is attached to the #GimpSizeEntry.
@unit_format:
@menu_show_pixels:
@menu_show_percent:
@spinbutton_usize:
@spinbutton_width:
@update_policy:
@chainbutton_active:
@chain_constrains_ratio:
@ -354,6 +363,8 @@ Returns the #GimpChainButton which is attached to the #GimpSizeEntry.
@ysize_0:
@ysize_100:
@Returns:
<!-- # Unused Parameters # -->
@spinbutton_usize:
<!-- ##### MACRO GIMP_MEM_SIZE_ENTRY_SPINBUTTON ##### -->

View File

@ -28,7 +28,6 @@ gimpwidgetstypes
</para>
@parent_instance:
<!-- ##### STRUCT GimpChainButton ##### -->
<para>
@ -41,6 +40,7 @@ gimpwidgetstypes
</para>
@parent_instance:
<!-- ##### STRUCT GimpColorButton ##### -->
<para>