From 04a5b8dc505f3663a4ae298b257c523a986ca6fb Mon Sep 17 00:00:00 2001 From: Xan Lopez Date: Sun, 10 Feb 2013 11:32:36 +0100 Subject: Remove API doc generation We don't have extensions anymore, so this serves no purpose. If we ever add a new (hopefully much smaller!) API set for next-generation extensions we'll resurrect the docs for it. --- configure.ac | 7 - doc/Makefile.am | 2 - doc/reference-howto.txt | 28 --- doc/reference/Makefile.am | 264 ---------------------------- doc/reference/epiphany-docs.sgml | 32 ---- doc/reference/epiphany-overrides.txt | 0 doc/reference/epiphany-sections.txt | 222 ----------------------- doc/reference/epiphany.types | 22 --- doc/reference/tmpl/ephy-location-entry.sgml | 209 ---------------------- doc/reference/tmpl/ephy-search-entry.sgml | 51 ------ doc/reference/tmpl/ephy-window.sgml | 107 ----------- doc/reference/tmpl/epiphany-unused.sgml | 0 12 files changed, 944 deletions(-) delete mode 100644 doc/reference-howto.txt delete mode 100644 doc/reference/Makefile.am delete mode 100644 doc/reference/epiphany-docs.sgml delete mode 100644 doc/reference/epiphany-overrides.txt delete mode 100644 doc/reference/epiphany-sections.txt delete mode 100644 doc/reference/epiphany.types delete mode 100644 doc/reference/tmpl/ephy-location-entry.sgml delete mode 100644 doc/reference/tmpl/ephy-search-entry.sgml delete mode 100644 doc/reference/tmpl/ephy-window.sgml delete mode 100644 doc/reference/tmpl/epiphany-unused.sgml diff --git a/configure.ac b/configure.ac index 5433eab00..b4c41c609 100644 --- a/configure.ac +++ b/configure.ac @@ -238,12 +238,6 @@ fi AC_DEFINE_UNQUOTED([LSB_DISTRIBUTOR],["$LSB_DISTRIBUTOR"],[Distributor name]) -# ***************** -# API Documentation -# ***************** - -GTK_DOC_CHECK([1.0]) - # ************ # Output files # ************ @@ -257,7 +251,6 @@ data/epiphany-${EPIPHANY_API_VERSION}.pc:data/epiphany.pc.in data/epiphany.desktop.in data/pages/Makefile doc/Makefile -doc/reference/Makefile lib/Makefile lib/egg/Makefile lib/history/Makefile diff --git a/doc/Makefile.am b/doc/Makefile.am index 3c8a68366..729e61c6d 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,5 +1,3 @@ -SUBDIRS = reference - NULL = man_MANS = epiphany.1 diff --git a/doc/reference-howto.txt b/doc/reference-howto.txt deleted file mode 100644 index a9926e051..000000000 --- a/doc/reference-howto.txt +++ /dev/null @@ -1,28 +0,0 @@ -Documenting Epiphany Reference -============================== - -Documenting Epiphany's API is fairly trivial following these instructions: - -- Add documentation headers to the .c file public functions, some pointers: - + good examples can be found in WebKit/WebKit/gtk/ files and epiphany itself - + don't forget to match arg names in the .c and .h files - + add a SECTION comment at the beginning of the file - -- If it's a GObject add the get_type function and include the .h in - doc/reference/epiphany.types in case it's not there already - -- Remove the .h from the IGNORE_HFILES section of doc/reference/Makefile.am - -- Clean current docs build using: - + make maintainer-clean-local - -- Build and commit: - + modified .c and .h files - + modified Makefile.am - + modified epiphany-docs.sgml - + modified epiphany.types - - Remember that the generated files shouldn't be committed. - Don't forget to prefix your commit with 'docs:' - -Last updated: December 1st, 2009 by diegoe. diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am deleted file mode 100644 index 2963dc0e5..000000000 --- a/doc/reference/Makefile.am +++ /dev/null @@ -1,264 +0,0 @@ -# The name of the module -DOC_MODULE=epiphany - -# The top-level SGML file. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml - -# The directory containing the source code. Relative to $(srcdir). -# gtk-doc will search all .c & .h files beneath here for inline comments -# documenting functions and macros. -DOC_SOURCE_DIR=../.. - -# 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=$(top_srcdir)/lib/*.h -CFILE_GLOB=$(top_srcdir)/lib/*.c - -# Header files to ignore when scanning. -IGNORE_HFILES = \ - config.h \ - ephy-dnd.h \ - ephy-file-chooser.h \ - ephy-gui.h \ - ephy-langs.h \ - ephy-node-common.h \ - ephy-node-filter.h \ - ephy-node.h \ - ephy-prefs.h \ - ephy-state.h \ - ephy-stock-icons.h \ - ephy-string.h \ - ephy-zoom.h \ - downloader-view.h \ - ephy-embed-dialog.h \ - ephy-embed-event.h \ - ephy-embed-popup-control.h \ - ephy-embed-prefs.h \ - ephy-embed-shell.h \ - ephy-encodings.h \ - ephy-permission-manager.h \ - find-dialog.h \ - print-dialog.h \ - eggtreemultidnd.h \ - ephy-bookmark-action.h \ - ephy-bookmark-properties.h \ - ephy-bookmarks-editor.h \ - ephy-bookmarks-export.h \ - ephy-bookmarks.h \ - ephy-bookmarks-import.h \ - ephy-bookmarks-menu.h \ - ephy-topic-action.h \ - ephy-topics-selector.h \ - ephy-completion-model.h \ - ephy-encoding-dialog.h \ - ephy-encoding-menu.h \ - ephy-favicon-action.h \ - ephy-history-window.h \ - ephy-navigation-action.h \ - ephy-notebook.h \ - ephy-tabs-menu.h \ - ephy-shell \ - pdm-dialog.h \ - popup-commands.h \ - ppview-toolbar.h \ - prefs-dialog.h \ - ephy-link.h \ - window-commands.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 = -DEPIPHANY_COMPILATION \ - -I$(top_srcdir)/src \ - -I$(top_srcdir)/lib \ - -I$(top_builddir)/lib \ - -I$(top_srcdir)/lib/widgets \ - -I$(top_srcdir)/embed \ - -I$(top_builddir)/embed \ - -I$(top_srcdir)/src/bookmarks \ - -I$(top_srcdir)/lib/egg \ - -I$(top_srcdir)/lib/history \ - $(DEPENDENCIES_CFLAGS) \ - $(DBUS_CFLAGS) \ - $(CODE_COVERAGE_CFLAGS) \ - $(INCINTL) - -GTKDOC_LIBS = \ - $(top_builddir)/src/libephymain.la \ - $(top_builddir)/src/bookmarks/libephybookmarks.la \ - $(top_builddir)/embed/libephyembed.la \ - $(top_builddir)/lib/widgets/libephywidgets.la \ - $(top_builddir)/lib/history/libephyhistory.la \ - $(top_builddir)/lib/libephymisc.la \ - $(top_builddir)/lib/egg/libegg.la \ - $(DEPENDENCIES_LIBS) \ - $(DBUS_LIBS) \ - $(CODE_COVERAGE_LDFLAGS) \ - $(LIBINTL) - -# If you need to override some of the declarations, place them in the -# $(DOC_MODULE)-overrides.txt file and uncomment the second line here. -DOC_OVERRIDES = - -# include common portion ... -# include $(top_srcdir)/gtk-doc.make -# We need to copy/paste this to be able to change LD_LIBRARY_PATH - -if GTK_DOC_USE_LIBTOOL -GTKDOC_CC = $(LIBTOOL) --mode=compile $(CC) $(INCLUDES) $(AM_CFLAGS) $(CFLAGS) -GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(LDFLAGS) -else -GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CFLAGS) $(CFLAGS) -GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(LDFLAGS) -endif - -# 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) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE).types \ - $(DOC_MODULE)-sections.txt \ - $(DOC_MODULE)-overrides.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).interfaces \ - $(DOC_MODULE).prerequisites \ - $(DOC_MODULE).signals - -CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-scan.o $(DOC_MODULE)-unused.txt $(DOC_STAMPS) - -if ENABLE_GTK_DOC -all-local: html-build.stamp - -#### scan #### - -scan-build.stamp: $(HFILE_GLOB) - @echo '*** Scanning header files ***' - @-chmod -R u+w $(srcdir) - if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ - CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --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 $(DOC_MODULE)-overrides.txt - @echo '*** Rebuilding template files ***' - @-chmod -R u+w $(srcdir) - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - touch tmpl-build.stamp - -tmpl.stamp: tmpl-build.stamp - @true - -#### xml #### - -sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml - @echo '*** Building XML ***' - @-chmod -R u+w $(srcdir) - cd $(srcdir) && \ - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml $(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 ***' - @-chmod -R u+w $(srcdir) - 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=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -endif - -############## - -clean-local: - rm -f *~ *.bak - -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: - rm -f $(DESTDIR)$(TARGET_DIR)/* - -# -# 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 diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml deleted file mode 100644 index 17d4320b7..000000000 --- a/doc/reference/epiphany-docs.sgml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - Epiphany Reference Manual - - - - Epiphany - - - - - - - Library - - - - - - Widgets - - - - - - - - - diff --git a/doc/reference/epiphany-overrides.txt b/doc/reference/epiphany-overrides.txt deleted file mode 100644 index e69de29bb..000000000 diff --git a/doc/reference/epiphany-sections.txt b/doc/reference/epiphany-sections.txt deleted file mode 100644 index 4260f1941..000000000 --- a/doc/reference/epiphany-sections.txt +++ /dev/null @@ -1,222 +0,0 @@ -
-ephy-web-view -EphyWebView -EphyWebView -EphyWebViewChrome -EphyWebViewClass -EphyWebViewDocumentType -EphyWebViewNavigationFlags -EphyWebViewNetState -EphyWebViewPrintPreviewNavType -EphyWebViewPrivate -EphyWebViewSecurityLevel -ephy_web_view_can_go_up -ephy_web_view_copy_back_history -ephy_web_view_get_address -ephy_web_view_get_document_type -ephy_web_view_get_go_up_list -ephy_web_view_get_icon -ephy_web_view_get_is_blank -ephy_web_view_get_link_message -ephy_web_view_get_loading_title -ephy_web_view_get_navigation_flags -ephy_web_view_get_security_level -ephy_web_view_get_status_message -ephy_web_view_get_title -ephy_web_view_get_title_composite -ephy_web_view_get_typed_address -ephy_web_view_get_visibility -ephy_web_view_go_up -ephy_web_view_has_modified_forms -ephy_web_view_is_loading -ephy_web_view_load_failed -ephy_web_view_load_request -ephy_web_view_load_url -ephy_web_view_new -ephy_web_view_popups_manager_reset -ephy_web_view_print_preview_n_pages -ephy_web_view_print_preview_navigate -ephy_web_view_save -ephy_web_view_set_address -ephy_web_view_set_link_message -ephy_web_view_set_loading_title -ephy_web_view_set_print_preview_mode -ephy_web_view_set_security_level -ephy_web_view_set_title -ephy_web_view_set_typed_address -ephy_web_view_set_visibility -ephy_web_view_show_page_certificate -ephy_web_view_update_from_net_state -
- -
-ephy-location-entry -EphyLocationEntry -EphyLocationEntry -ephy_location_entry_set_location -ephy_location_entry_get_location -ephy_location_entry_get_can_undo -ephy_location_entry_get_can_redo -ephy_location_entry_get_entry -ephy_location_entry_activate -ephy_location_entry_reset -ephy_location_entry_undo_reset -ephy_location_entry_set_favicon -ephy_location_entry_set_secure -ephy_location_entry_set_show_lock -ephy_location_entry_set_lock_stock -ephy_location_entry_set_lock_tooltip -ephy_location_entry_set_completion -ephy_location_entry_set_match_func -
- -
-ephy-node-view -EphyNodeView -EphyNodeView -EphyNodeViewPriority -EphyNodeViewFlags -ephy_node_view_new -ephy_node_view_add_toggle -ephy_node_view_add_column -ephy_node_view_add_data_column -ephy_node_view_set_sort -ephy_node_view_set_priority -ephy_node_view_remove -ephy_node_view_get_selection -ephy_node_view_select_node -ephy_node_view_enable_drag_source -ephy_node_view_enable_drag_dest -ephy_node_view_edit -ephy_node_view_is_target -ephy_node_view_popup -
- -
-ephy-tree-model-node -EphyTreeModelNode -EphyTreeModelNode -ephy_tree_model_node_new -ephy_tree_model_node_add_prop_column -ephy_tree_model_node_add_func_column -ephy_tree_model_node_node_from_iter -ephy_tree_model_node_iter_from_node -
- -
-ephy-tree-model-sort -EphyTreeModelSort -EphyTreeModelSort -ephy_tree_model_sort_new -ephy_tree_model_sort_set_base_drag_column_id -ephy_tree_model_sort_set_extra_drag_column_id -
- -
-ephy-zoom-action -EphyZoomAction -EphyZoomAction -ephy_zoom_action_set_zoom_level -ephy_zoom_action_get_zoom_level -
- -
-ephy-debug -Epiphany Debug Helpers -ephy_debug_init -ephy_profiler_start -ephy_profiler_stop -
- -
-ephy-dialog -EphyDialog -EphyDialog -EphyDialogProperty -EphyDialogApplyType -ephy_dialog_new -ephy_dialog_new_with_parent -ephy_dialog_construct -ephy_dialog_add_enum -ephy_dialog_set_data_column -ephy_dialog_set_size_group -ephy_dialog_run -ephy_dialog_show -ephy_dialog_hide -ephy_dialog_set_parent -ephy_dialog_get_parent -ephy_dialog_set_modal -ephy_dialog_get_control -ephy_dialog_get_controls -ephy_dialog_get_value -ephy_dialog_set_value -ephy_dialog_set_pref -
- -
-ephy-file-helpers -Epiphany File Helpers -EphyMimePermission -ephy_file -ephy_file_add_recent_item -ephy_file_browse_to -ephy_file_check_mime -ephy_file_delete_directory -ephy_file_delete_on_exit -ephy_file_delete_uri -ephy_file_desktop_dir -ephy_file_downloads_dir -ephy_file_find -ephy_file_get_downloads_dir -ephy_file_helpers_init -ephy_file_helpers_shutdown -ephy_file_launch_application -ephy_file_launch_desktop_file -ephy_file_launch_handler -ephy_file_tmp_dir -ephy_file_tmp_filename -ephy_file_create_data_uri_for_filename -ephy_sanitize_filename -
- -
-ephy-location-action -EphyLocationAction -EphyLocationAction -ephy_location_action_get_address -ephy_location_action_set_address -
- -
-ephy-toolbar -EphyToolbar -EphyToolbar -ephy_toolbar_new -ephy_toolbar_get_action_group -ephy_toolbar_set_favicon -ephy_toolbar_set_show_leave_fullscreen -ephy_toolbar_activate_location -ephy_toolbar_get_location -ephy_toolbar_set_location -ephy_toolbar_set_navigation_actions -ephy_toolbar_set_navigation_tooltips -ephy_toolbar_set_security_state -ephy_toolbar_set_spinning -ephy_toolbar_set_zoom -
- -
-ephy-window -EphyWindow -EphyWindow -ephy_window_new -ephy_window_new_with_chrome -ephy_window_get_ui_manager -ephy_window_get_notebook -ephy_window_load_url -ephy_window_set_zoom -ephy_window_activate_location -ephy_window_get_is_print_preview -ephy_window_get_context_event -ephy_window_close -
diff --git a/doc/reference/epiphany.types b/doc/reference/epiphany.types deleted file mode 100644 index 00416bf32..000000000 --- a/doc/reference/epiphany.types +++ /dev/null @@ -1,22 +0,0 @@ -#include - -ephy_web_view_get_type - -#include -#include -#include -#include - -ephy_node_view_get_type -ephy_location_entry_get_type -ephy_tree_model_node_get_type -ephy_tree_model_sort_get_type -ephy_zoom_action_get_type - -#include - -ephy_dialog_get_type - -#include - -ephy_window_get_type diff --git a/doc/reference/tmpl/ephy-location-entry.sgml b/doc/reference/tmpl/ephy-location-entry.sgml deleted file mode 100644 index acc02be2a..000000000 --- a/doc/reference/tmpl/ephy-location-entry.sgml +++ /dev/null @@ -1,209 +0,0 @@ - -EphyLocationEntry - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@ephylocationentry: the object which received the signal. -@Returns: - - - - - - -@ephylocationentry: the object which received the signal. -@Returns: - - - - - - -@ephylocationentry: the object which received the signal. - - - - - - -@ephylocationentry: the object which received the signal. - - - - - - - - - - - - - - - - -@entry: -@address: - - - - - - - -@entry: -@Returns: - - - - - - - -@entry: -@Returns: - - - - - - - -@entry: -@Returns: - - - - - - - -@entry: -@Returns: - - - - - - - -@entry: - - - - - - - -@entry: -@Returns: - - - - - - - -@entry: - - - - - - - -@entry: -@pixbuf: - - - - - - - -@entry: -@secure: - - - - - - - -@entry: -@show_lock: - - - - - - - -@entry: -@stock_id: - - - - - - - -@entry: -@tooltip: - - - - - - - -@entry: -@model: -@text_col: -@action_col: -@keywords_col: -@relevance_col: -@url_col: -@extra_col: -@favicon_col: - - - - - - - -@entry: -@match_func: -@user_data: -@notify: - - diff --git a/doc/reference/tmpl/ephy-search-entry.sgml b/doc/reference/tmpl/ephy-search-entry.sgml deleted file mode 100644 index 3a9d3ff58..000000000 --- a/doc/reference/tmpl/ephy-search-entry.sgml +++ /dev/null @@ -1,51 +0,0 @@ - -EphySearchEntry - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@ephysearchentry: the object which received the signal. -@arg1: - - - - - - -@Returns: - - - - - - - -@entry: - - diff --git a/doc/reference/tmpl/ephy-window.sgml b/doc/reference/tmpl/ephy-window.sgml deleted file mode 100644 index 31b1e0713..000000000 --- a/doc/reference/tmpl/ephy-window.sgml +++ /dev/null @@ -1,107 +0,0 @@ - -EphyWindow - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@Returns: - - - - - - - -@chrome: -@is_popup: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@url: - - - - - - - -@window: -@zoom: - - - - - - - -@window: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - diff --git a/doc/reference/tmpl/epiphany-unused.sgml b/doc/reference/tmpl/epiphany-unused.sgml deleted file mode 100644 index e69de29bb..000000000 -- cgit v1.2.3