Move from valadoc generation to GTK-Doc
This commit is contained in:
85
docs/reference/matrix-glib-sdk/Makefile.am
Normal file
85
docs/reference/matrix-glib-sdk/Makefile.am
Normal file
@@ -0,0 +1,85 @@
|
||||
# This is a blank Makefile.am for using gtk-doc.
|
||||
# Copy this to your project's API docs directory and modify the variables to
|
||||
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
|
||||
# of using the various options.
|
||||
|
||||
# The name of the module, e.g. 'glib'.
|
||||
DOC_MODULE=matrix-glib-sdk
|
||||
|
||||
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
|
||||
#DOC_MODULE_VERSION=2
|
||||
|
||||
# The top-level XML file.
|
||||
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
|
||||
|
||||
# Directories containing the source code.
|
||||
# gtk-doc will search all .c and .h files beneath these paths
|
||||
# for inline comments documenting functions and macros.
|
||||
# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
|
||||
DOC_SOURCE_DIR=$(top_srcdir)/src
|
||||
|
||||
# Extra options to pass to gtkdoc-scangobj. Normally not needed.
|
||||
SCANGOBJ_OPTIONS=
|
||||
|
||||
# Extra options to supply to gtkdoc-scan.
|
||||
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
|
||||
SCAN_OPTIONS=
|
||||
|
||||
# Extra options to supply to gtkdoc-mkdb
|
||||
# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
|
||||
MKDB_OPTIONS=--xml-mode --output-format=xml
|
||||
|
||||
# Extra options to supply to gtkdoc-mkhtml
|
||||
MKHTML_OPTIONS=
|
||||
|
||||
# Extra options to supply to gtkdoc-fixref. Normally not needed.
|
||||
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
|
||||
FIXXREF_OPTIONS=
|
||||
|
||||
# Used for dependencies. The docs will be rebuilt if any of these change.
|
||||
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
|
||||
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
|
||||
HFILE_GLOB=$(top_srcdir)/src/*.h
|
||||
CFILE_GLOB=$(top_srcdir)/src/*.c
|
||||
|
||||
# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
|
||||
# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
|
||||
EXTRA_HFILES=
|
||||
|
||||
# Header files or dirs to ignore when scanning. Use base file/dir names
|
||||
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
|
||||
IGNORE_HFILES=utils.h
|
||||
|
||||
# Images to copy into HTML directory.
|
||||
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
|
||||
HTML_IMAGES=
|
||||
|
||||
# Extra files that are included by $(DOC_MAIN_SGML_FILE).
|
||||
# e.g. content_files=running.xml building.xml changes-2.0.xml
|
||||
content_files=
|
||||
|
||||
# Files where gtk-doc abbrevations (#GtkWidget) are expanded
|
||||
# e.g. expand_content_files=running.xml
|
||||
expand_content_files=
|
||||
|
||||
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
|
||||
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
|
||||
# signals and properties.
|
||||
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
|
||||
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
|
||||
GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_srcdir)/src
|
||||
GTKDOC_LIBS=$(top_builddir)/src/libmatrix-glib-0.0.la
|
||||
|
||||
# This includes the standard gtk-doc make rules, copied by gtkdocize.
|
||||
include $(top_srcdir)/gtk-doc.make
|
||||
|
||||
# Comment this out if you want 'make check' to test you doc status
|
||||
# and run some sanity checks
|
||||
if ENABLE_GTK_DOC
|
||||
TESTS_ENVIRONMENT = \
|
||||
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
|
||||
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
|
||||
TESTS = $(GTKDOC_CHECK)
|
||||
endif
|
||||
|
||||
-include $(top_srcdir)/git.mk
|
||||
98
docs/reference/matrix-glib-sdk/matrix-glib-sdk-docs.xml
Normal file
98
docs/reference/matrix-glib-sdk/matrix-glib-sdk-docs.xml
Normal file
@@ -0,0 +1,98 @@
|
||||
<?xml version="1.0"?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
||||
"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">
|
||||
<bookinfo>
|
||||
<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="http://[SERVER]/&package_name;/index.html">http://[SERVER]/&package_name;/</ulink>.
|
||||
</releaseinfo>
|
||||
</bookinfo>
|
||||
|
||||
<chapter id="matrix-glib-sdk-basic-types">
|
||||
<title>Basic types</title>
|
||||
<xi:include href="xml/matrix-enumtypes.xml"/>
|
||||
<xi:include href="xml/matrix-compacts.xml"/>
|
||||
<xi:include href="xml/matrix-profile.xml"/>
|
||||
<xi:include href="xml/matrix-room.xml"/>
|
||||
<xi:include href="xml/matrix-types.xml"/>
|
||||
<xi:include href="xml/matrix-version.xml"/>
|
||||
</chapter>
|
||||
|
||||
<chapter id="matrix-glib-sdk-events">
|
||||
<title>Event types</title>
|
||||
<xi:include href="xml/event-handling.xml"/>
|
||||
<xi:include href="xml/matrix-event-base.xml"/>
|
||||
<xi:include href="xml/matrix-event-call-base.xml"/>
|
||||
<xi:include href="xml/matrix-event-call-answer.xml"/>
|
||||
<xi:include href="xml/matrix-event-call-candidates.xml"/>
|
||||
<xi:include href="xml/matrix-event-call-hangup.xml"/>
|
||||
<xi:include href="xml/matrix-event-call-invite.xml"/>
|
||||
<xi:include href="xml/matrix-event-presence.xml"/>
|
||||
<xi:include href="xml/matrix-event-receipt.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-aliases.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-avatar.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-base.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-canonical-alias.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-create.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-guest-access.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-history-visibility.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-join-rules.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-member.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-message.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-message-feedback.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-name.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-power-levels.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-redaction.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-third-party-invite.xml"/>
|
||||
<xi:include href="xml/matrix-event-room-topic.xml"/>
|
||||
<xi:include href="xml/matrix-event-state-base.xml"/>
|
||||
<xi:include href="xml/matrix-event-tag.xml"/>
|
||||
<xi:include href="xml/matrix-event-typing.xml"/>
|
||||
</chapter>
|
||||
|
||||
<chapter id="matrix-glib-sdk-messages">
|
||||
<title>Message types</title>
|
||||
<xi:include href="xml/message-handling.xml"/>
|
||||
<xi:include href="xml/matrix-message-base.xml"/>
|
||||
<xi:include href="xml/matrix-message-text.xml"/>
|
||||
<xi:include href="xml/matrix-message-emote.xml"/>
|
||||
<xi:include href="xml/matrix-message-notice.xml"/>
|
||||
<xi:include href="xml/matrix-message-file.xml"/>
|
||||
<xi:include href="xml/matrix-message-audio.xml"/>
|
||||
<xi:include href="xml/matrix-message-image.xml"/>
|
||||
<xi:include href="xml/matrix-message-video.xml"/>
|
||||
<xi:include href="xml/matrix-message-location.xml"/>
|
||||
</chapter>
|
||||
|
||||
<chapter>
|
||||
<title>Communicating with homeservers</title>
|
||||
<xi:include href="xml/matrix-api.xml"/>
|
||||
<xi:include href="xml/matrix-client.xml"/>
|
||||
<xi:include href="xml/matrix-http-api.xml"/>
|
||||
<xi:include href="xml/matrix-http-client.xml"/>
|
||||
</chapter>
|
||||
|
||||
<chapter id="object-tree">
|
||||
<title>Object Hierarchy</title>
|
||||
<xi:include href="xml/tree_index.sgml"/>
|
||||
</chapter>
|
||||
|
||||
<index id="api-index-full">
|
||||
<title>API Index</title>
|
||||
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
|
||||
</index>
|
||||
|
||||
<index id="deprecated-api-index" role="deprecated">
|
||||
<title>Index of deprecated API</title>
|
||||
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
|
||||
</index>
|
||||
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
|
||||
</book>
|
||||
1159
docs/reference/matrix-glib-sdk/matrix-glib-sdk-sections.txt
Normal file
1159
docs/reference/matrix-glib-sdk/matrix-glib-sdk-sections.txt
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user