Skip to content
Snippets Groups Projects
Commit 5296f6f0 authored by Romain Bouvier's avatar Romain Bouvier Committed by Simon Steinbeiß
Browse files

Revamp the documentation to modernize and uniformize accross components

parent 8b29c0dd
No related branches found
No related tags found
1 merge request!13Revamp the documentation to modernize and uniformize accross components
Pipeline #6524 passed
Stage: build
Stage: distcheck
Hide whitespace changes
Inline Side-by-side
Showing
with 30 additions and 406 deletions
configure.ac.in
+ 1
− 3
View file @ 5296f6f0
......@@ -98,7 +98,6 @@ LT_INIT([disable-static])
dnl ***************************************
dnl *** Check for standard header files ***
dnl ***************************************
AC_HEADER_STDC()
AC_CHECK_HEADERS([fcntl.h errno.h sys/mman.h sys/stat.h sys/wait.h memory.h \
stdlib.h stdio.h string.h sys/types.h sys/time.h unistd.h \
time.h stdarg.h sys/types.h sys/uio.h sched.h ctype.h])
......@@ -128,7 +127,7 @@ XDT_CHECK_PACKAGE([LIBXFCE4UI2], [libxfce4ui-2], [4.15.7])
dnl *************************
dnl *** Check for gtk-doc ***
dnl *************************
GTK_DOC_CHECK([1.0])
GTK_DOC_CHECK([1.20])
dnl ***************************************
dnl *** Check for GObject Introspection ***
......@@ -151,7 +150,6 @@ data/Makefile
data/xfce/Makefile
docs/Makefile
docs/reference/Makefile
docs/reference/version.xml
garcon/Makefile
garcon/garcon-1.pc
garcon/garcon-config.h
......
docs/reference/Makefile.am
+ 6
− 41
View file @ 5296f6f0
# vi:set ts=8 sw=8 noet ai nocindent syntax=automake:
#
# Copyright (c) 2009 Jannis Pohlmann <jannis@xfce.org>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Library General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Library General Public License for more details.
#
# You should have received a copy of the GNU Library General
# Public License along with this library; if not, write to the
# Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
# Boston, MA 02110-1301, USA.
AUTOMAKE_OPTIONS = 1.8
# Name of the module
DOC_MODULE=garcon
......@@ -31,23 +10,17 @@ SCAN_OPTIONS=
SCANGOBJ_OPTIONS=
# Directory containing the source code
DOC_SOURCE_DIR= \
../../garcon \
../../garcon-gtk
DOC_SOURCE_DIR=$(top_srcdir)/garcon $(top_srcdir)/garcon-gtk
# Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS=--sgml-mode --output-format=xml
MKDB_OPTIONS=--xml-mode --output-format=xml
# Extra options to supply to gtkdoc-fixref
FIXXREF_OPTIONS=
# Used for dependencies
HFILE_GLOB= \
$(top_srcdir)/garcon/*.h \
$(top_srcdir)/garcon-gtk/*.h
CFILE_GLOB= \
$(top_srcdir)/garcon/*.c \
$(top_srcdir)/garcon-gtk/*.c
HFILE_GLOB=
CFILE_GLOB=
# Extra files to add when scanning (relative to $srcdir)
EXTRA_HFILES=
......@@ -56,12 +29,11 @@ EXTRA_HFILES=
HTML_IMAGES =
# Extra SGML files that are included by DOC_MAIN_SGML_FILE
content_files = \
version.xml
content_files =
# CFLAGS and LDFLAGS for compiling scan program. Only needed
# if $(DOC_MODULE).types is non-empty.
AM_CPPFLAGS = \
GTKDOC_CFLAGS = \
-I$(top_srcdir) \
-I$(top_builddir) \
$(GIO_CFLAGS) \
......@@ -82,10 +54,3 @@ GTKDOC_LIBS = \
$(top_builddir)/garcon-gtk/libgarcon-gtk3-1.la
include $(top_srcdir)/gtk-doc.make
# Other files to distribute
EXTRA_DIST += \
version.xml.in
# Required for make distcheck
dist-hook: all
docs/reference/garcon-docs.xml
+ 14
− 27
View file @ 5296f6f0
......@@ -3,38 +3,22 @@
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
%gtkdocentities;
]>
<book id="index" lang="en">
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>garcon Reference Manual</title>
<releaseinfo>Version <xi:include href="version.xml" parse="text"/></releaseinfo>
<title>&package_name; Reference Manual</title>
<releaseinfo>
For &package_string;.
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="https://developer.xfce.org/&package_name;/index.html">https://developer.xfce.org/&package_name;/</ulink>.
</releaseinfo>
<copyright>
<year>2006</year>
<year>2007</year>
<year>2008</year>
<year>2009</year>
<holder>Jannis Pohlmann</holder>
<year>2021</year>
<holder>The Xfce Development Team</holder>
</copyright>
<legalnotice id="legalnotice">
<para>
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. The complete license text is available from the <ulink
type="http" url="http://www.gnu.org/">Free Software Foundation</ulink>.
</para>
</legalnotice>
<authorgroup>
<author>
<firstname>Jannis</firstname>
<surname>Pohlmann</surname>
<affiliation>
<address><email>jannis@xfce.org</email></address>
</affiliation>
</author>
</authorgroup>
</bookinfo>
<part>
......@@ -102,4 +86,7 @@
</xi:include>
<xi:include href="xml/api-index-deprecated.xml" />
</index>
<xi:include href="xml/annotation-glossary.xml">
<xi:fallback />
</xi:include>
</book>
docs/reference/garcon.types
+ 9
− 6
View file @ 5296f6f0
garcon_menu_item_pool_get_type
garcon_gtk_menu_get_type
garcon_menu_directory_get_type
garcon_menu_separator_get_type
garcon_menu_element_get_type
garcon_menu_get_type
garcon_menu_parser_get_type
garcon_menu_tree_provider_get_type
garcon_menu_node_get_type
garcon_menu_item_action_get_type
garcon_menu_item_cache_get_type
garcon_menu_element_get_type
garcon_menu_item_get_type
garcon_menu_item_pool_get_type
garcon_menu_merger_get_type
garcon_menu_node_get_type
garcon_menu_node_type_get_type
garcon_menu_parser_get_type
garcon_menu_separator_get_type
garcon_menu_tree_provider_get_type
docs/reference/gdesktopmenu-overrides.txt deleted 100644 → 0
+ 0
− 0
View file @ 8b29c0dd
docs/reference/gdesktopmenu-sections.txt deleted 100644 → 0
+ 0
− 317
View file @ 8b29c0dd
<SECTION>
<FILE>gdesktopmenuseparator</FILE>
GDesktopMenuSeparatorClass
GDesktopMenuSeparator
g_desktop_menu_separator_get_default
<SUBSECTION Standard>
G_DESKTOP_MENU_SEPARATOR
G_IS_DESKTOP_MENU_SEPARATOR
G_TYPE_DESKTOP_MENU_SEPARATOR
g_desktop_menu_separator_get_type
G_DESKTOP_MENU_SEPARATOR_CLASS
G_IS_DESKTOP_MENU_SEPARATOR_CLASS
G_DESKTOP_MENU_SEPARATOR_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdesktopmenuparser</FILE>
GDesktopMenuParserPrivate
g_desktop_menu_parser_new
g_desktop_menu_parser_run
<TITLE>GDesktopMenuParser</TITLE>
GDesktopMenuParser
<SUBSECTION Standard>
G_DESKTOP_MENU_PARSER
G_IS_DESKTOP_MENU_PARSER
G_TYPE_DESKTOP_MENU_PARSER
g_desktop_menu_parser_get_type
G_DESKTOP_MENU_PARSER_CLASS
G_IS_DESKTOP_MENU_PARSER_CLASS
G_DESKTOP_MENU_PARSER_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdesktopmenuitempool</FILE>
GDesktopMenuItemPoolPrivate
GDesktopMenuItemPoolClass
GDesktopMenuItemPool
g_desktop_menu_item_pool_new
g_desktop_menu_item_pool_insert
g_desktop_menu_item_pool_lookup
g_desktop_menu_item_pool_foreach
g_desktop_menu_item_pool_apply_exclude_rule
g_desktop_menu_item_pool_get_empty
<SUBSECTION Standard>
G_DESKTOP_MENU_ITEM_POOL
G_IS_DESKTOP_MENU_ITEM_POOL
G_TYPE_DESKTOP_MENU_ITEM_POOL
g_desktop_menu_item_pool_get_type
G_DESKTOP_MENU_ITEM_POOL_CLASS
G_IS_DESKTOP_MENU_ITEM_POOL_CLASS
G_DESKTOP_MENU_ITEM_POOL_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdesktopmenunode</FILE>
GDesktopMenuNodeType
GDesktopMenuLayoutMergeType
GDesktopMenuMergeFileType
GDesktopMenuNodeClass
GDesktopMenuNode
g_desktop_menu_node_new
g_desktop_menu_node_get_node_type
g_desktop_menu_node_create
g_desktop_menu_node_copy
g_desktop_menu_node_get_string
g_desktop_menu_node_set_string
g_desktop_menu_node_get_merge_file_type
g_desktop_menu_node_set_merge_file_type
g_desktop_menu_node_get_merge_file_filename
g_desktop_menu_node_set_merge_file_filename
g_desktop_menu_node_tree_get_child_node
g_desktop_menu_node_tree_get_child_nodes
g_desktop_menu_node_tree_get_string_children
g_desktop_menu_node_tree_get_boolean_child
g_desktop_menu_node_tree_get_string_child
g_desktop_menu_node_tree_rule_matches
g_desktop_menu_node_tree_get_node_type
g_desktop_menu_node_tree_get_string
g_desktop_menu_node_tree_set_string
g_desktop_menu_node_tree_get_layout_merge_type
g_desktop_menu_node_tree_get_merge_file_type
g_desktop_menu_node_tree_get_merge_file_filename
g_desktop_menu_node_tree_set_merge_file_filename
g_desktop_menu_node_tree_compare
g_desktop_menu_node_tree_copy
g_desktop_menu_node_tree_free
g_desktop_menu_node_tree_free_data
<SUBSECTION Standard>
G_DESKTOP_MENU_NODE
G_IS_DESKTOP_MENU_NODE
G_TYPE_DESKTOP_MENU_NODE
g_desktop_menu_node_get_type
G_DESKTOP_MENU_NODE_CLASS
G_IS_DESKTOP_MENU_NODE_CLASS
G_DESKTOP_MENU_NODE_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdesktopmenutreeprovider</FILE>
GDesktopMenuTreeProviderIface
GDesktopMenuTreeProvider
g_desktop_menu_tree_provider_get_tree
g_desktop_menu_tree_provider_get_file
<SUBSECTION Standard>
G_DESKTOP_MENU_TREE_PROVIDER
G_IS_DESKTOP_MENU_TREE_PROVIDER
G_TYPE_DESKTOP_MENU_TREE_PROVIDER
g_desktop_menu_tree_provider_get_type
G_DESKTOP_MENU_TREE_PROVIDER_GET_IFACE
</SECTION>
<SECTION>
<FILE>gdesktopmenumerger</FILE>
GDesktopMenuMergerPrivate
g_desktop_menu_merger_new
g_desktop_menu_merger_run
<TITLE>GDesktopMenuMerger</TITLE>
GDesktopMenuMerger
<SUBSECTION Standard>
G_DESKTOP_MENU_MERGER
G_IS_DESKTOP_MENU_MERGER
G_TYPE_DESKTOP_MENU_MERGER
g_desktop_menu_merger_get_type
G_DESKTOP_MENU_MERGER_CLASS
G_IS_DESKTOP_MENU_MERGER_CLASS
G_DESKTOP_MENU_MERGER_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdesktopmenuelement</FILE>
GDesktopMenuElement
GDesktopMenuElementIface
g_desktop_menu_element_get_name
g_desktop_menu_element_get_comment
g_desktop_menu_element_get_icon_name
g_desktop_menu_element_get_visible
g_desktop_menu_element_get_show_in_environment
g_desktop_menu_element_get_no_display
<SUBSECTION Standard>
G_DESKTOP_MENU_ELEMENT
G_IS_DESKTOP_MENU_ELEMENT
G_TYPE_DESKTOP_MENU_ELEMENT
g_desktop_menu_element_get_type
G_DESKTOP_MENU_ELEMENT_GET_IFACE
</SECTION>
<SECTION>
<FILE>gdesktopmenuitemcache</FILE>
GDesktopMenuItemCachePrivate
GDesktopMenuItemCacheClass
GDesktopMenuItemCache
g_desktop_menu_item_cache_get_default
g_desktop_menu_item_cache_lookup
g_desktop_menu_item_cache_foreach
g_desktop_menu_item_cache_invalidate
<SUBSECTION Standard>
G_DESKTOP_MENU_ITEM_CACHE
G_IS_DESKTOP_MENU_ITEM_CACHE
G_TYPE_DESKTOP_MENU_ITEM_CACHE
g_desktop_menu_item_cache_get_type
G_DESKTOP_MENU_ITEM_CACHE_CLASS
G_IS_DESKTOP_MENU_ITEM_CACHE_CLASS
G_DESKTOP_MENU_ITEM_CACHE_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdesktopmenu</FILE>
GDESKTOPMENU_INSIDE_GDESKTOPMENU_H
GDesktopMenuPrivate
GDesktopMenuClass
GDesktopMenu
g_desktop_menu_new
g_desktop_menu_new_for_file
g_desktop_menu_new_applications
g_desktop_menu_load
g_desktop_menu_get_file
g_desktop_menu_get_directory
g_desktop_menu_get_menus
g_desktop_menu_get_menu_with_name
g_desktop_menu_get_parent
g_desktop_menu_get_elements
<SUBSECTION Standard>
G_DESKTOP_MENU
G_IS_DESKTOP_MENU
g_desktop_menu_get_type
G_DESKTOP_MENU_CLASS
G_IS_DESKTOP_MENU_CLASS
G_DESKTOP_MENU_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdesktopmenudirectory</FILE>
GDesktopMenuDirectoryPrivate
GDesktopMenuDirectoryClass
GDesktopMenuDirectory
g_desktop_menu_directory_get_file
g_desktop_menu_directory_get_name
g_desktop_menu_directory_set_name
g_desktop_menu_directory_get_comment
g_desktop_menu_directory_set_comment
g_desktop_menu_directory_get_icon
g_desktop_menu_directory_set_icon
g_desktop_menu_directory_get_no_display
g_desktop_menu_directory_set_no_display
g_desktop_menu_directory_get_hidden
g_desktop_menu_directory_get_show_in_environment
g_desktop_menu_directory_get_visible
g_desktop_menu_directory_equal
<SUBSECTION Standard>
G_DESKTOP_MENU_DIRECTORY
G_IS_DESKTOP_MENU_DIRECTORY
G_TYPE_DESKTOP_MENU_DIRECTORY
g_desktop_menu_directory_get_type
G_DESKTOP_MENU_DIRECTORY_CLASS
G_IS_DESKTOP_MENU_DIRECTORY_CLASS
G_DESKTOP_MENU_DIRECTORY_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdesktopmenuitem</FILE>
GDesktopMenuItemPrivate
GDesktopMenuItemClass
GDesktopMenuItem
g_desktop_menu_item_new
g_desktop_menu_item_get_desktop_id
g_desktop_menu_item_set_desktop_id
g_desktop_menu_item_get_filename
g_desktop_menu_item_set_filename
g_desktop_menu_item_get_command
g_desktop_menu_item_set_command
g_desktop_menu_item_get_try_exec
g_desktop_menu_item_set_try_exec
g_desktop_menu_item_get_name
g_desktop_menu_item_set_name
g_desktop_menu_item_get_generic_name
g_desktop_menu_item_set_generic_name
g_desktop_menu_item_get_comment
g_desktop_menu_item_set_comment
g_desktop_menu_item_get_icon_name
g_desktop_menu_item_set_icon_name
g_desktop_menu_item_get_path
g_desktop_menu_item_set_path
g_desktop_menu_item_requires_terminal
g_desktop_menu_item_set_requires_terminal
g_desktop_menu_item_get_no_display
g_desktop_menu_item_set_no_display
g_desktop_menu_item_supports_startup_notification
g_desktop_menu_item_set_supports_startup_notification
g_desktop_menu_item_get_categories
g_desktop_menu_item_set_categories
g_desktop_menu_item_has_category
g_desktop_menu_item_get_show_in_environment
g_desktop_menu_item_only_show_in_environment
g_desktop_menu_item_ref
g_desktop_menu_item_unref
g_desktop_menu_item_get_allocated
g_desktop_menu_item_increment_allocated
g_desktop_menu_item_decrement_allocated
<SUBSECTION Standard>
G_DESKTOP_MENU_ITEM
G_IS_DESKTOP_MENU_ITEM
G_TYPE_DESKTOP_MENU_ITEM
g_desktop_menu_item_get_type
G_DESKTOP_MENU_ITEM_CLASS
G_IS_DESKTOP_MENU_ITEM_CLASS
G_DESKTOP_MENU_ITEM_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdesktopmenumonitor</FILE>
GDesktopMenuMonitorFlags
GDesktopMenuMonitorVTable
g_desktop_menu_monitor_set_vtable
g_desktop_menu_monitor_add_item
g_desktop_menu_monitor_remove_item
g_desktop_menu_monitor_add_directory
g_desktop_menu_monitor_remove_directory
g_desktop_menu_monitor_add_file
g_desktop_menu_monitor_remove_file
g_desktop_menu_monitor_set_flags
g_desktop_menu_monitor_get_flags
g_desktop_menu_monitor_has_flags
</SECTION>
<SECTION>
<FILE>gdesktopmenumain</FILE>
g_desktop_menu_init
g_desktop_menu_shutdown
g_desktop_menu_config_lookup
G_TYPE_DESKTOP_MENU
</SECTION>
<SECTION>
<FILE>gdesktopmenuenvironment</FILE>
g_desktop_menu_set_environment
g_desktop_menu_get_environment
</SECTION>
<SECTION>
<FILE>gdesktopmenugio</FILE>
g_file_new_for_unknown_input
g_file_new_relative_to_file
g_file_get_uri_relative_to_file
</SECTION>
<SECTION>
<FILE>gdesktopmenu-config</FILE>
GDESKTOPMENU_MAJOR_VERSION
GDESKTOPMENU_MINOR_VERSION
GDESKTOPMENU_MICRO_VERSION
GDESKTOPMENU_CHECK_VERSION
gdesktopmenu_major_version
gdesktopmenu_minor_version
gdesktopmenu_micro_version
gdesktopmenu_check_version
</SECTION>
docs/reference/gdesktopmenu.types deleted 100644 → 0
+ 0
− 11
View file @ 8b29c0dd
g_desktop_menu_item_pool_get_type
g_desktop_menu_directory_get_type
g_desktop_menu_separator_get_type
g_desktop_menu_get_type
g_desktop_menu_parser_get_type
g_desktop_menu_tree_provider_get_type
g_desktop_menu_node_get_type
g_desktop_menu_item_cache_get_type
g_desktop_menu_element_get_type
g_desktop_menu_item_get_type
g_desktop_menu_merger_get_type
docs/reference/version.xml.in deleted 100644 → 0
+ 0
− 1
View file @ 8b29c0dd
@VERSION@
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