From b59fc10752cd7d6e7c0affb262d441081dd9b587 Mon Sep 17 00:00:00 2001 From: Marco Pesenti Gritti Date: Wed, 19 Nov 2003 19:12:14 +0000 Subject: Complete docs base implementation. Should work more or less. 2003-11-19 Marco Pesenti Gritti * doc/reference/.cvsignore: * doc/reference/Makefile.am: * doc/reference/epiphany-docs.sgml: * doc/reference/epiphany.types: * doc/reference/tmpl/config.sgml: * doc/reference/tmpl/ephy-session.sgml: * doc/reference/tmpl/ephy-shell.sgml: Complete docs base implementation. Should work more or less. * embed/Makefile.am: * lib/Makefile.am: * src/Makefile.am: Cleanup a bit libs build and use a static lib also for the src/ code so that we can use it for documents. * src/ephy-nautilus-view.c: Bad chpe forgot to modify func signature. --- doc/reference/.cvsignore | 15 ++ doc/reference/Makefile.am | 276 +++++++++++++++++++++++++++++++- doc/reference/epiphany-docs.sgml | 40 +---- doc/reference/epiphany.types | 24 +++ doc/reference/tmpl/config.sgml | 228 ++++++++++++++++++++++++++ doc/reference/tmpl/ephy-session.sgml | 91 +++++++++++ doc/reference/tmpl/ephy-shell.sgml | 192 ++++++++++++++++++++++ doc/reference/tmpl/epiphany-unused.sgml | 0 8 files changed, 824 insertions(+), 42 deletions(-) create mode 100644 doc/reference/.cvsignore create mode 100644 doc/reference/tmpl/config.sgml create mode 100644 doc/reference/tmpl/ephy-session.sgml create mode 100644 doc/reference/tmpl/ephy-shell.sgml create mode 100644 doc/reference/tmpl/epiphany-unused.sgml (limited to 'doc/reference') diff --git a/doc/reference/.cvsignore b/doc/reference/.cvsignore new file mode 100644 index 000000000..bc80ac90e --- /dev/null +++ b/doc/reference/.cvsignore @@ -0,0 +1,15 @@ +Makefile +Makefile.in +epiphany-decl-list.txt +epiphany-decl.txt +epiphany-sections.txt +epiphany-undocumented.txt +epiphany-unused.txt +epiphany.args +epiphany.hierarchy +epiphany.interfaces +epiphany.prerequisites +epiphany.signals +*.stamp +html +xml diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index 9973047af..8d63ecca5 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -26,7 +26,124 @@ HFILE_GLOB=$(top_srcdir)/lib/*.h CFILE_GLOB=$(top_srcdir)/lib/*.c # Header files to ignore when scanning. -IGNORE_HFILES= BaseProtocolContentHandler.h BaseProtocolHandler.h ContentHandler.h EphyAboutRedirector.h EphyBrowser.h EphyEventListener.h EphyHeaderSniffer.h EventContext.h ExternalProtocolHandlers.h ExternalProtocolService.h FilePicker.h GlobalHistory.h GtkNSSClientAuthDialogs.h GtkNSSDialogs.h GtkNSSKeyPairDialogs.h MozDownload.h mozilla-download.h mozilla-embed.h mozilla-embed-persist.h mozilla-embed-single.h mozilla-notifiers.h MozillaPrivate.h MozRegisterComponents.h nsUnicharUtils.h PrintingPromptService.h +IGNORE_HFILES = \ + eel-gconf-extensions.h \ + ephy-bonobo-extensions.h \ + ephy-debug.h \ + ephy-dialog.h \ + ephy-dnd.h \ + ephy-file-chooser.h \ + ephy-file-helpers.h \ + ephy-glade.h \ + ephy-gui.h \ + ephy-langs.h \ + ephy-marshal.h \ + ephy-module-loader.h \ + ephy-node-common.h \ + ephy-node-db.h \ + ephy-node-filter.h \ + ephy-node.h \ + ephy-prefs.h \ + ephy-state.h \ + ephy-stock-icons.h \ + ephy-string.h \ + ephy-thread-helpers.h \ + ephy-zoom.h \ + ephy-arrow-toolbutton.h \ + ephy-cell-renderer-progress.h \ + ephy-ellipsizing-label.h \ + ephy-location-entry.h \ + ephy-node-view.h \ + ephy-search-entry.h \ + ephy-spinner.h \ + ephy-tree-model-node.h \ + ephy-tree-model-sort.h \ + ephy-zoom-action.h \ + ephy-zoom-control.h \ + downloader-view.h \ + ephy-command-manager.h \ + ephy-download.h \ + ephy-embed-dialog.h \ + ephy-embed-event.h \ + ephy-embed.h \ + ephy-embed-persist.h \ + ephy-embed-popup-control.h \ + ephy-embed-prefs.h \ + ephy-embed-shell.h \ + ephy-embed-single.h \ + ephy-encodings.h \ + ephy-favicon-cache.h \ + ephy-history.h \ + find-dialog.h \ + print-dialog.h \ + BaseProtocolContentHandler.h \ + BaseProtocolHandler.h \ + ContentHandler.h \ + EphyAboutRedirector.h \ + EphyBrowser.h \ + EphyEventListener.h \ + EphyHeaderSniffer.h \ + EventContext.h \ + ExternalProtocolHandlers.h \ + ExternalProtocolService.h \ + FilePicker.h \ + GlobalHistory.h \ + GtkNSSClientAuthDialogs.h \ + GtkNSSDialogs.h \ + GtkNSSKeyPairDialogs.h \ + MozDownload.h \ + mozilla-download.h \ + mozilla-embed.h \ + mozilla-embed-persist.h \ + mozilla-embed-single.h \ + mozilla-notifiers.h \ + MozillaPrivate.h \ + MozRegisterComponents.h \ + nsUnicharUtils.h \ + PrintingPromptService.h \ + egg-editable-toolbar.h \ + eggintl.h \ + eggmarshalers.h \ + egg-toolbar-editor.h \ + egg-toolbars-model.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-new-bookmark.h \ + ephy-topic-action.h \ + ephy-topics-selector.h \ + ephy-automation.h \ + EphyAutomation.h \ + ephy-completion-model.h \ + ephy-encoding-dialog.h \ + ephy-encoding-menu.h \ + ephy-extension.h \ + ephy-extensions-manager.h \ + ephy-favicon-action.h \ + ephy-favorites-menu.h \ + ephy-go-action.h \ + ephy-history-window.h \ + ephy-location-action.h \ + ephy-nautilus-view.h \ + ephy-navigation-action.h \ + ephy-notebook.h \ + ephy-tab.h \ + ephy-tabs-menu.h \ + ephy-toolbars-model.h \ + ephy-window.h \ + language-editor.h \ + pdm-dialog.h \ + popup-commands.h \ + ppview-toolbar.h \ + prefs-dialog.h \ + statusbar.h \ + toolbar.h \ + window-commands.h # Images to copy into HTML directory. HTML_IMAGES = @@ -48,15 +165,164 @@ GTKDOC_CFLAGS = -I$(top_srcdir)/src \ $(EPIPHANY_DEPENDENCY_CFLAGS) GTKDOC_LIBS = \ - $(top_builddir)/embed/libephyembed.la \ - $(top_builddir)/lib/libephy.la \ + $(top_builddir)/src/libephymain.la \ $(top_builddir)/src/bookmarks/libephybookmarks.la \ - $(EPIPHANY_DEPENDENCY_LIBS) + $(top_builddir)/embed/libephyembed.la \ + $(top_builddir)/embed/mozilla/libephymozillaembed.la \ + $(top_builddir)/lib/widgets/libephywidgets.la \ + $(top_builddir)/lib/libephymisc.la \ + $(top_builddir)/lib/egg/libegg.la \ + $(MOZILLA_COMPONENT_LIBS) \ + $(EPIPHANY_DEPENDENCY_LIBS) \ + $(INTLLIBS) # 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 +# 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 \ + LD_LIBRARY_PATH=$(MOZILLA_HOME):$$LD_LIBRARY_PATH 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 $(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-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 index bc8dbb8d8..7115f2aa7 100644 --- a/doc/reference/epiphany-docs.sgml +++ b/doc/reference/epiphany-docs.sgml @@ -8,42 +8,8 @@ [Insert title here] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + diff --git a/doc/reference/epiphany.types b/doc/reference/epiphany.types index 18f11650f..5b19d2a3a 100644 --- a/doc/reference/epiphany.types +++ b/doc/reference/epiphany.types @@ -17,3 +17,27 @@ ephy_location_entry_get_type ephy_zoom_action_get_type ephy_zoom_control_get_type ephy_cell_renderer_progress_get_type + +#include +#include +#include +#include +#include +#include +#include + +ephy_embed_get_type +downloader_view_get_type +ephy_command_manager_get_type +ephy_download_get_type +ephy_embed_dialog_get_type +ephy_embed_event_get_type +ephy_embed_persist_get_type + +#include +#include +#include + +ephy_window_get_type +ephy_shell_get_type +ephy_session_get_type diff --git a/doc/reference/tmpl/config.sgml b/doc/reference/tmpl/config.sgml new file mode 100644 index 000000000..54b74acd4 --- /dev/null +++ b/doc/reference/tmpl/config.sgml @@ -0,0 +1,228 @@ + +config + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/reference/tmpl/ephy-session.sgml b/doc/reference/tmpl/ephy-session.sgml new file mode 100644 index 000000000..03ba6989f --- /dev/null +++ b/doc/reference/tmpl/ephy-session.sgml @@ -0,0 +1,91 @@ + +ephy-session + + + + + + + + + + + + + + + + + + + + + +@session: +@Returns: + + + + + + + +@session: +@filename: +@Returns: + + + + + + + +@session: +@filename: +@Returns: + + + + + + + +@session: +@Returns: + + + + + + + +@session: + + + + + + + +@session: +@Returns: + + + + + + + +@session: +@window: + + + + + + + +@session: +@window: + + diff --git a/doc/reference/tmpl/ephy-shell.sgml b/doc/reference/tmpl/ephy-shell.sgml new file mode 100644 index 000000000..176490882 --- /dev/null +++ b/doc/reference/tmpl/ephy-shell.sgml @@ -0,0 +1,192 @@ + +ephy-shell + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@EPHY_SHELL_ERROR_MISSING_SERVER: +@EPHY_SHELL_ERROR_OBJECT_REG_FAILED: +@EPHY_SHELL_ERROR_FACTORY_REG_FAILED: + + + + + + +@EPHY_SHELL_STARTUP_TABS: +@EPHY_SHELL_STARTUP_EXISTING_WINDOW: +@EPHY_SHELL_STARTUP_FULLSCREEN: +@EPHY_SHELL_STARTUP_BOOKMARKS_EDITOR: +@EPHY_SHELL_STARTUP_SESSION: +@EPHY_SHELL_STARTUP_IMPORT_BOOKMARKS: +@EPHY_SHELL_STARTUP_ADD_BOOKMARK: +@EPHY_SHELL_STARTUP_SERVER: + + + + + + +@EPHY_NEW_TAB_HOME_PAGE: +@EPHY_NEW_TAB_NEW_PAGE: +@EPHY_NEW_TAB_OPEN_PAGE: +@EPHY_NEW_TAB_FULLSCREEN_MODE: +@EPHY_NEW_TAB_APPEND_GROUPED: +@EPHY_NEW_TAB_APPEND_LAST: +@EPHY_NEW_TAB_APPEND_AFTER: +@EPHY_NEW_TAB_JUMP: +@EPHY_NEW_TAB_IN_NEW_WINDOW: +@EPHY_NEW_TAB_IN_EXISTING_WINDOW: + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@gs: +@flags: +@args: +@string_arg: +@error: +@Returns: + + + + + + + +@gs: +@Returns: + + + + + + + +@shell: +@parent_window: +@previous_tab: +@url: +@flags: +@Returns: + + + + + + + +@gs: +@Returns: + + + + + + + +@gs: +@Returns: + + + + + + + +@gs: +@fullscreen: +@Returns: + + + + + + + +@es: +@Returns: + + + + + + + +@gs: +@Returns: + + + + + + + +@gs: +@Returns: + + + + + + + +@gs: +@path: + + diff --git a/doc/reference/tmpl/epiphany-unused.sgml b/doc/reference/tmpl/epiphany-unused.sgml new file mode 100644 index 000000000..e69de29bb -- cgit v1.2.3