diff options
author | Matthew Barnes <mbarnes@redhat.com> | 2010-02-10 07:02:51 +0800 |
---|---|---|
committer | Matthew Barnes <mbarnes@redhat.com> | 2010-02-10 07:02:51 +0800 |
commit | 1040078ce60b4641e5a3cdad6a2cef14660e63a3 (patch) | |
tree | 0c59410ca87afb492bfa60cf43668b7af6f72533 /doc/reference/shell | |
parent | 64984ad5b86bb5c97868107d462825cbfa301e30 (diff) | |
download | gsoc2013-evolution-1040078ce60b4641e5a3cdad6a2cef14660e63a3.tar.gz gsoc2013-evolution-1040078ce60b4641e5a3cdad6a2cef14660e63a3.tar.zst gsoc2013-evolution-1040078ce60b4641e5a3cdad6a2cef14660e63a3.zip |
Update API documentation.
Also, start fixing some Gtk-Doc warnings. There's a lot.
Diffstat (limited to 'doc/reference/shell')
-rw-r--r-- | doc/reference/shell/Makefile.am | 2 | ||||
-rw-r--r-- | doc/reference/shell/eshell-docs.sgml | 3 | ||||
-rw-r--r-- | doc/reference/shell/eshell-sections.txt | 9 | ||||
-rw-r--r-- | doc/reference/shell/tmpl/e-shell-searchbar.sgml | 60 | ||||
-rw-r--r-- | doc/reference/shell/tmpl/e-shell-window.sgml | 9 | ||||
-rw-r--r-- | doc/reference/shell/tmpl/e-util.sgml | 4 |
6 files changed, 81 insertions, 6 deletions
diff --git a/doc/reference/shell/Makefile.am b/doc/reference/shell/Makefile.am index f15d4b9c18..97322a1c40 100644 --- a/doc/reference/shell/Makefile.am +++ b/doc/reference/shell/Makefile.am @@ -8,7 +8,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml # gtk-doc will search all .c & .h files beneath here for inline comments # documenting the functions and macros. # e.g. DOC_SOURCE_DIR=../../../gtk -DOC_SOURCE_DIR=../../../ +DOC_SOURCE_DIR=../../.. # Extra options to pass to gtkdoc-scangobj. Not normally needed. SCANGOBJ_OPTIONS= diff --git a/doc/reference/shell/eshell-docs.sgml b/doc/reference/shell/eshell-docs.sgml index b744d9c78a..99948f5007 100644 --- a/doc/reference/shell/eshell-docs.sgml +++ b/doc/reference/shell/eshell-docs.sgml @@ -6,8 +6,7 @@ <title>Evolution Shell Reference Manual</title> <releaseinfo> The latest version of this documentation can be found on-line at - <ulink role="online-location" -url="http://mbarnes.fedorapeople.org/docs/eshell/">http://mbarnes.fedorapeople.org/docs/eshell/</ulink>. + <ulink role="online-location" url="http://library.gnome.org/devel/eshell/unstable/">http://library.gnome.org/devel/eshell/unstable/</ulink>. </releaseinfo> </bookinfo> diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt index f65ce604a2..2ae9b9153a 100644 --- a/doc/reference/shell/eshell-sections.txt +++ b/doc/reference/shell/eshell-sections.txt @@ -100,6 +100,8 @@ e_shell_searchbar_get_shell_view e_shell_searchbar_get_filter_combo_box e_shell_searchbar_get_filter_visible e_shell_searchbar_set_filter_visible +e_shell_searchbar_get_label_visible +e_shell_searchbar_set_label_visible e_shell_searchbar_get_search_hint e_shell_searchbar_set_search_hint e_shell_searchbar_get_search_option @@ -111,7 +113,11 @@ e_shell_searchbar_set_search_visible e_shell_searchbar_get_scope_combo_box e_shell_searchbar_get_scope_visible e_shell_searchbar_set_scope_visible -e_shell_searchbar_restore_state +e_shell_searchbar_set_state_dirty +e_shell_searchbar_get_state_group +e_shell_searchbar_set_state_group +e_shell_searchbar_load_state +e_shell_searchbar_save_state <SUBSECTION Standard> E_SHELL_SEARCHBAR E_IS_SHELL_SEARCHBAR @@ -292,6 +298,7 @@ e_shell_window_get_shell e_shell_window_get_shell_view e_shell_window_peek_shell_view e_shell_window_get_shell_view_action +e_shell_window_get_focus_tracker e_shell_window_get_ui_manager e_shell_window_get_action e_shell_window_get_action_group diff --git a/doc/reference/shell/tmpl/e-shell-searchbar.sgml b/doc/reference/shell/tmpl/e-shell-searchbar.sgml index 3c55a58f6d..71f8894845 100644 --- a/doc/reference/shell/tmpl/e-shell-searchbar.sgml +++ b/doc/reference/shell/tmpl/e-shell-searchbar.sgml @@ -123,6 +123,24 @@ EShellSearchbar @filter_visible: +<!-- ##### FUNCTION e_shell_searchbar_get_label_visible ##### --> +<para> + +</para> + +@searchbar: +@Returns: + + +<!-- ##### FUNCTION e_shell_searchbar_set_label_visible ##### --> +<para> + +</para> + +@searchbar: +@label_visible: + + <!-- ##### FUNCTION e_shell_searchbar_get_search_hint ##### --> <para> @@ -222,3 +240,45 @@ EShellSearchbar @scope_visible: +<!-- ##### FUNCTION e_shell_searchbar_set_state_dirty ##### --> +<para> + +</para> + +@searchbar: + + +<!-- ##### FUNCTION e_shell_searchbar_get_state_group ##### --> +<para> + +</para> + +@searchbar: +@Returns: + + +<!-- ##### FUNCTION e_shell_searchbar_set_state_group ##### --> +<para> + +</para> + +@searchbar: +@state_group: + + +<!-- ##### FUNCTION e_shell_searchbar_load_state ##### --> +<para> + +</para> + +@searchbar: + + +<!-- ##### FUNCTION e_shell_searchbar_save_state ##### --> +<para> + +</para> + +@searchbar: + + diff --git a/doc/reference/shell/tmpl/e-shell-window.sgml b/doc/reference/shell/tmpl/e-shell-window.sgml index 383c782da2..0dcb1c4b5f 100644 --- a/doc/reference/shell/tmpl/e-shell-window.sgml +++ b/doc/reference/shell/tmpl/e-shell-window.sgml @@ -131,6 +131,15 @@ EShellWindow @Returns: +<!-- ##### FUNCTION e_shell_window_get_focus_tracker ##### --> +<para> + +</para> + +@shell_window: +@Returns: + + <!-- ##### FUNCTION e_shell_window_get_ui_manager ##### --> <para> diff --git a/doc/reference/shell/tmpl/e-util.sgml b/doc/reference/shell/tmpl/e-util.sgml index b94e7e8b41..72bf737586 100644 --- a/doc/reference/shell/tmpl/e-util.sgml +++ b/doc/reference/shell/tmpl/e-util.sgml @@ -1,5 +1,5 @@ <!-- ##### SECTION Title ##### --> -Miscellaneous Utility Functions +Miscellaneous Utilities <!-- ##### SECTION Short_Description ##### --> @@ -122,7 +122,7 @@ Miscellaneous Utility Functions </para> -@s: +@string: @Returns: |