Commit 6ef4d95f authored by Sven Neumann's avatar Sven Neumann Committed by Sven Neumann

added devel-docs/app.

2003-08-09  Sven Neumann  <neo@bender>

	* configure.in: added devel-docs/app.

	* app/core/gimpitem.c
	* app/widgets/gimpdialogfactory.c: more documentation fixes.

2003-08-09  Sven Neumann  <sven@gimp.org>

	* Makefile.am
	* app: added a first version of docs for the application. The
	templates are not yet in CVS and it's not built by default (and
	probably never will be).
parent 9aaf432d
2003-08-09 Sven Neumann <neo@bender>
* configure.in: added devel-docs/app.
* app/core/gimpitem.c
* app/widgets/gimpdialogfactory.c: more documentation fixes.
2003-08-09 Sven Neumann <sven@gimp.org>
* app/app_procs.c
......@@ -576,6 +576,7 @@ gimp_item_scale_by_factors (GimpItem *item,
* @item: The item to be transformed by width & height scale factors
* @new_width: The width that item will acquire
* @new_height: The height that the item will acquire
* @interpolation:
* @local_origin: sets fixed point of the scaling transform. See below.
*
* Sets item dimensions to new_width and
......
......@@ -561,7 +561,7 @@ gimp_dialog_factory_dialog_new_internal (GimpDialogFactory *factory,
* @factory: a #GimpDialogFactory
* @identifier: the identifier of the dialog as registered with
* gimp_dialog_factory_register_entry()
* preview_size:
* @preview_size:
*
* Creates a new toplevel dialog or a #GimpDockable, depending on whether
* %factory is a toplevel of dockable factory.
......@@ -621,7 +621,7 @@ gimp_dialog_factory_dialog_raise (GimpDialogFactory *factory,
* @dock : a #GimpDock crated by this %factory.
* @identifier: the identifier of the dialog as registered with
* gimp_dialog_factory_register_entry()
* preview_size:
* @preview_size:
*
* Creates a new #GimpDockable in the context of the #GimpDock it will be
* added to.
......
......@@ -1245,6 +1245,8 @@ plug-ins/twain/Makefile
plug-ins/winsnap/Makefile
modules/Makefile
devel-docs/Makefile
devel-docs/app/Makefile
devel-docs/app/version.xml
devel-docs/libgimp/Makefile
devel-docs/libgimp/version.xml
devel-docs/libgimpbase/Makefile
......
2003-08-09 Sven Neumann <sven@gimp.org>
* Makefile.am
* app: added a first version of docs for the application. The
templates are not yet in CVS and it's not built by default (and
probably never will be).
2003-07-28 Sven Neumann <sven@gimp.org>
* libgimpbase/Makefile.am: exclude libgimbase/gimpwin32-io.h.
......
......@@ -12,6 +12,7 @@ EXTRA_DIST = \
ChangeLog \
README \
README.gtkdoc \
app \
debug-plug-ins.txt \
gbr.txt \
gih.txt \
......
Makefile
Makefile.in
deprecated
app.args
app.hierarchy
app.signals
app-decl.txt
app-decl-list.txt
app-unused.txt
app-undocumented.txt
html
tmpl
xml
version.xml
*.stamp
## Process this file with automake to produce Makefile.in
# The name of the module.
DOC_MODULE = app
# The top-level SGML file.
DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml
# The directory containing the source code.
DOC_SOURCE_DIR = $(top_srcdir)/$(DOC_MODULE)
# 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 = --sgml-mode --output-format=xml
# 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 = \
gimp-composite-dispatch.h \
gimp-composite-regression.h \
gimp-composite-mmx.h \
gimp-composite-sse.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 = \
-g \
-I$(top_srcdir) \
$(GTK_CFLAGS) \
-I$(includedir)
GTKDOC_LIBS = \
$(top_builddir)/app/app_procs.o \
$(top_builddir)/app/batch.o \
$(top_builddir)/app/errors.o \
$(top_builddir)/app/libgimp_glue.o \
$(top_builddir)/app/config/libappconfig.a \
$(top_builddir)/app/gui/libappgui.a \
$(top_builddir)/app/display/libappdisplay.a \
$(top_builddir)/app/tools/libapptools.a \
$(top_builddir)/app/widgets/libappwidgets.a \
$(top_builddir)/app/core/libappcore.a \
$(top_builddir)/app/pdb/libapppdb.a \
$(top_builddir)/app/paint/libapppaint.a \
$(top_builddir)/app/xcf/libappxcf.a \
$(top_builddir)/app/text/libapptext.a \
$(top_builddir)/app/vectors/libappvectors.a \
$(top_builddir)/app/file/libappfile.a \
$(top_builddir)/app/plug-in/libappplug-in.a \
$(top_builddir)/app/paint-funcs/libapppaint-funcs.a \
$(top_builddir)/app/base/libappbase.a \
$(top_builddir)/app/composite/libappcomposite.a \
$(top_builddir)/libgimpcolor/libgimpcolor-$(LT_RELEASE).la \
$(top_builddir)/libgimpmath/libgimpmath-$(LT_RELEASE).la \
$(top_builddir)/libgimpbase/libgimpbase-$(LT_RELEASE).la \
$(top_builddir)/libgimpmodule/libgimpmodule-$(LT_RELEASE).la \
$(top_builddir)/libgimpwidgets/libgimpwidgets-$(LT_RELEASE).la \
$(GTK_LIBS) \
$(LIBART_LIBS) \
$(PANGOFT2_LIBS) \
$(FONTCONFIG_LIBS) \
$(FREETYPE_LIBS) \
$(GIMP_THREAD_LIBS) \
$(GIMP_MP_LIBS) \
$(INTLLIBS) \
$(REGEXREPL)
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)
EXTRA_DIST = \
$(content_files) \
$(extra_files) \
$(HTML_IMAGES) \
$(DOC_MAIN_SGML_FILE) \
$(DOC_MODULE).types \
$(DOC_MODULE)-sections.txt
DOC_STAMPS=scan-build.stamp tmpl-build.stamp xml-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
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
#### xml ####
xml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
@echo '*** Building XML ***'
cd $(srcdir) && \
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS)
touch xml-build.stamp
sgml.stamp: xml-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
else
all-local:
endif
##############
clean-local:
rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
maintainer-clean-local: clean
cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
install-data-local:
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
(installfiles=`echo $(srcdir)/html/*`; \
if test "$$installfiles" = '$(srcdir)/html/*'; \
then echo '-- Nothing to install' ; \
else \
for i in $$installfiles; do \
echo '-- Installing '$$i ; \
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
done; \
echo '-- Installing $(srcdir)/html/index.sgml' ; \
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
fi)
uninstall-local:
(installfiles=`echo $(srcdir)/html/*`; \
for i in $$installfiles; do \
rm -f $(DESTDIR)$(TARGET_DIR)/`basename $$i`; \
done; \
rm -f $(DESTDIR)$(TARGET_DIR)/index.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
mkdir $(distdir)/xml
mkdir $(distdir)/html
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
-cp $(srcdir)/xml/*.xml $(distdir)/xml
-cp $(srcdir)/html/* $(distdir)/html
.PHONY : dist-hook-local
This diff is collapsed.
This diff is collapsed.
GimpRc GimpConfigInterface
GimpViewable GimpConfigInterface
GimpData GimpConfigInterface
GimpBrush GimpConfigInterface
GimpBrushGenerated GimpConfigInterface
GimpBrushPipe GimpConfigInterface
GimpGradient GimpConfigInterface
GimpPalette GimpConfigInterface
GimpPattern GimpConfigInterface
GimpToolInfo GimpConfigInterface
GimpBuffer GimpConfigInterface
GimpItem GimpConfigInterface
GimpDrawable GimpConfigInterface
GimpChannel GimpConfigInterface
GimpLayerMask GimpConfigInterface
GimpLayer GimpConfigInterface
GimpTextLayer GimpConfigInterface
GimpVectors GimpConfigInterface
GimpImage GimpConfigInterface
GimpImagefile GimpConfigInterface
GimpUndo GimpConfigInterface
GimpItemUndo GimpConfigInterface
GimpUndoStack GimpConfigInterface
GimpTemplate GimpConfigInterface
GimpFont GimpConfigInterface
GimpContainer GimpConfigInterface
GimpList GimpConfigInterface
GimpDataList GimpConfigInterface
GimpDocumentList GimpConfigInterface
GimpFontList GimpConfigInterface
GimpContext GimpConfigInterface
GimpToolOptions GimpConfigInterface
GimpPaintOptions GimpConfigInterface
GimpAirbrushOptions GimpConfigInterface
GimpCloneOptions GimpConfigInterface
GimpConvolveOptions GimpConfigInterface
GimpDodgeBurnOptions GimpConfigInterface
GimpEraserOptions GimpConfigInterface
GimpPencilOptions GimpConfigInterface
GimpSmudgeOptions GimpConfigInterface
GimpBlendOptions GimpConfigInterface
GimpBucketFillOptions GimpConfigInterface
GimpInkOptions GimpConfigInterface
GimpColorOptions GimpConfigInterface
GimpColorPickerOptions GimpConfigInterface
GimpCropOptions GimpConfigInterface
GimpTransformOptions GimpConfigInterface
GimpFlipOptions GimpConfigInterface
GimpMagnifyOptions GimpConfigInterface
GimpMeasureOptions GimpConfigInterface
GimpMoveOptions GimpConfigInterface
GimpSelectionOptions GimpConfigInterface
GimpVectorOptions GimpConfigInterface
GimpTextOptions GimpConfigInterface
GimpDeviceInfo GimpConfigInterface
GimpGrid GimpConfigInterface
GimpParasiteList GimpConfigInterface
GtkWidget AtkImplementorIface
GtkContainer AtkImplementorIface
GtkBin AtkImplementorIface
GtkWindow AtkImplementorIface
GimpDisplayShell AtkImplementorIface
GimpContainerPopup AtkImplementorIface
GimpDock AtkImplementorIface
GimpImageDock AtkImplementorIface
GimpToolbox AtkImplementorIface
GtkDialog AtkImplementorIface
GimpDialog AtkImplementorIface
GimpTextEditor AtkImplementorIface
GimpViewableDialog AtkImplementorIface
GtkButton AtkImplementorIface
GimpButton AtkImplementorIface
GimpColorButton AtkImplementorIface
GimpColorPanel AtkImplementorIface
GimpViewableButton AtkImplementorIface
GimpDockable AtkImplementorIface
GtkItem AtkImplementorIface
GtkMenuItem AtkImplementorIface
GimpMenuItem AtkImplementorIface
GtkBox AtkImplementorIface
GtkVBox AtkImplementorIface
GimpEditor AtkImplementorIface
GimpNavigationView AtkImplementorIface
GimpDataEditor AtkImplementorIface
GimpBrushEditor AtkImplementorIface
GimpGradientEditor AtkImplementorIface
GimpPaletteEditor AtkImplementorIface
GimpContainerView AtkImplementorIface
GimpContainerTreeView AtkImplementorIface
GimpItemTreeView AtkImplementorIface
GimpDrawableTreeView AtkImplementorIface
GimpChannelTreeView AtkImplementorIface
GimpLayerTreeView AtkImplementorIface
GimpVectorsTreeView AtkImplementorIface
GimpContainerGridView AtkImplementorIface
GimpColorEditor AtkImplementorIface
GimpImageEditor AtkImplementorIface
GimpColormapEditor AtkImplementorIface
GimpComponentEditor AtkImplementorIface
GimpSelectionEditor AtkImplementorIface
GimpUndoEditor AtkImplementorIface
GimpDeviceStatus AtkImplementorIface
GimpErrorConsole AtkImplementorIface
GimpTemplateEditor AtkImplementorIface
GimpContainerEditor AtkImplementorIface
GimpDataFactoryView AtkImplementorIface
GimpBrushFactoryView AtkImplementorIface
GimpBufferView AtkImplementorIface
GimpDocumentView AtkImplementorIface
GimpImageView AtkImplementorIface
GimpTemplateView AtkImplementorIface
GimpHistogramBox AtkImplementorIface
GtkHBox AtkImplementorIface
GtkStatusbar AtkImplementorIface
GimpStatusbar AtkImplementorIface
GimpFontSelection AtkImplementorIface
GtkMenuShell AtkImplementorIface
GtkMenu AtkImplementorIface
GimpContainerMenu AtkImplementorIface
GimpContainerMenuImpl AtkImplementorIface
GimpEnumMenu AtkImplementorIface
GtkNotebook AtkImplementorIface
GimpDockbook AtkImplementorIface
GtkWrapBox AtkImplementorIface
GtkHWrapBox AtkImplementorIface
GtkVWrapBox AtkImplementorIface
GtkDrawingArea AtkImplementorIface
GimpHistogramView AtkImplementorIface
GimpPreview AtkImplementorIface
GimpNavigationPreview AtkImplementorIface
GimpText GimpConfigInterface
GimpConfigInterface GObject
#include <gtk/gtk.h>
#include "libgimpwidgets/gimpwidgets.h"
gimp_base_config_get_type
gimp_core_config_get_type
gimp_display_config_get_type
gimp_gui_config_get_type
gimp_plugin_config_get_type
gimp_rc_get_type
gimp_get_type
gimp_brush_get_type
gimp_brush_generated_get_type
gimp_brush_pipe_get_type
gimp_buffer_get_type
gimp_channel_get_type
gimp_container_get_type
gimp_context_get_type
gimp_data_get_type
gimp_data_factory_get_type
gimp_data_list_get_type
gimp_document_list_get_type
gimp_drawable_get_type
gimp_environ_table_get_type
gimp_gradient_get_type
gimp_grid_get_type
gimp_image_get_type
gimp_imagefile_get_type
gimp_image_map_get_type
gimp_item_get_type
gimp_item_undo_get_type
gimp_layer_get_type
gimp_layer_mask_get_type
gimp_list_get_type
gimp_object_get_type
gimp_paint_info_get_type
gimp_palette_get_type
gimp_parasite_list_get_type
gimp_pattern_get_type
gimp_template_get_type
gimp_tool_info_get_type
gimp_tool_options_get_type
gimp_undo_get_type
gimp_undo_stack_get_type
gimp_viewable_get_type
gimp_display_get_type
gimp_display_shell_get_type
gimp_navigation_view_get_type
gimp_statusbar_get_type
gimp_airbrush_get_type
gimp_airbrush_options_get_type
gimp_clone_get_type
gimp_clone_options_get_type
gimp_convolve_get_type
gimp_convolve_options_get_type
gimp_dodge_burn_get_type
gimp_dodge_burn_options_get_type
gimp_eraser_get_type
gimp_eraser_options_get_type
gimp_paintbrush_get_type
gimp_paint_core_get_type
gimp_paint_options_get_type
gimp_pencil_get_type
gimp_pencil_options_get_type
gimp_smudge_get_type
gimp_smudge_options_get_type
gimp_font_get_type
gimp_font_list_get_type
gimp_text_get_type
gimp_text_layer_get_type
gimp_text_layout_get_type
gimp_airbrush_tool_get_type
gimp_blend_options_get_type
gimp_blend_tool_get_type
gimp_brightness_contrast_tool_get_type
gimp_bucket_fill_options_get_type
gimp_bucket_fill_tool_get_type
gimp_by_color_select_tool_get_type
gimp_clone_tool_get_type
gimp_color_balance_tool_get_type
gimp_colorize_tool_get_type
gimp_color_options_get_type
gimp_color_picker_options_get_type
gimp_color_picker_tool_get_type
gimp_color_tool_get_type
gimp_convolve_tool_get_type
gimp_crop_options_get_type
gimp_crop_tool_get_type
gimp_curves_tool_get_type
gimp_dodgeburn_tool_get_type
gimp_draw_tool_get_type
gimp_ellipse_select_tool_get_type
gimp_eraser_tool_get_type
gimp_flip_options_get_type
gimp_flip_tool_get_type
gimp_free_select_tool_get_type
gimp_fuzzy_select_tool_get_type
gimp_histogram_tool_get_type
gimp_hue_saturation_tool_get_type
gimp_image_map_tool_get_type
gimp_ink_options_get_type
gimp_ink_tool_get_type
gimp_iscissors_tool_get_type
gimp_levels_tool_get_type
gimp_magnify_options_get_type
gimp_magnify_tool_get_type
gimp_measure_options_get_type
gimp_measure_tool_get_type
gimp_move_options_get_type
gimp_move_tool_get_type
gimp_paintbrush_tool_get_type
gimp_paint_tool_get_type
gimp_pencil_tool_get_type
gimp_perspective_tool_get_type
gimp_posterize_tool_get_type
gimp_rect_select_tool_get_type
gimp_rotate_tool_get_type
gimp_scale_tool_get_type
gimp_selection_options_get_type
gimp_selection_tool_get_type
gimp_shear_tool_get_type
gimp_smudge_tool_get_type
gimp_text_options_get_type
gimp_text_tool_get_type
gimp_threshold_tool_get_type
gimp_tool_get_type
gimp_tool_control_get_type
gimp_transform_options_get_type
gimp_transform_tool_get_type
gimp_vector_options_get_type
gimp_vector_tool_get_type
gimp_bezier_stroke_get_type
gimp_stroke_get_type
gimp_vectors_get_type
gimp_brush_editor_get_type
gimp_brush_factory_view_get_type
gimp_buffer_view_get_type
gimp_cell_renderer_toggle_get_type
gimp_cell_renderer_viewable_get_type
gimp_channel_tree_view_get_type
gimp_color_editor_get_type
gimp_colormap_editor_get_type
gimp_color_panel_get_type
gimp_component_editor_get_type
gimp_container_editor_get_type
gimp_container_grid_view_get_type
gimp_container_menu_get_type
gimp_container_menu_impl_get_type
gimp_container_popup_get_type
gimp_container_tree_view_get_type
gimp_container_view_get_type
gimp_data_editor_get_type
gimp_data_factory_view_get_type
gimp_device_info_get_type
gimp_device_status_get_type
gimp_dialog_factory_get_type
gimp_dock_get_type
gimp_dockable_get_type
gimp_dockbook_get_type
gimp_document_view_get_type
gimp_drawable_tree_view_get_type
gimp_editor_get_type
gimp_enum_menu_get_type
gimp_error_console_get_type
gimp_font_selection_get_type
gimp_gradient_editor_get_type
gimp_histogram_box_get_type
gimp_histogram_view_get_type
gimp_image_dock_get_type
gimp_image_editor_get_type
gimp_image_view_get_type
gimp_item_factory_get_type
gimp_item_tree_view_get_type
gimp_layer_tree_view_get_type
gimp_menu_factory_get_type
gimp_menu_item_get_type
gimp_navigation_preview_get_type
gimp_palette_editor_get_type
gimp_preview_get_type
gimp_preview_renderer_get_type
gimp_preview_renderer_brush_get_type
gimp_preview_renderer_drawable_get_type
gimp_preview_renderer_gradient_get_type
gimp_preview_renderer_image_get_type
gimp_preview_renderer_text_layer_get_type
gimp_selection_editor_get_type
gimp_template_editor_get_type
gimp_template_view_get_type
gimp_text_editor_get_type
gimp_toolbox_get_type
gimp_undo_editor_get_type
gimp_vectors_tree_view_get_type
gimp_viewable_button_get_type
gimp_viewable_dialog_get_type
gtk_hwrap_box_get_type
gtk_vwrap_box_get_type
gtk_wrap_box_get_type
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment