DeforaOS/libApp
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use config.ent for the Gtk-Doc documentation

Browse Source
This commit is contained in:
Pierre Pronchery 2020-02-13 09:33:43 +01:00
parent b4cd799664
commit 91c2a0aadf
6 changed files with 91 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/gtkdoc/libApp-docs.xml
View File

@ -3,28 +3,35 @@
"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 server "www.defora.org/doc/gtk-doc/html">
<!ENTITY title "DeforaOS libApp">
<!ENTITY version "0.1.5">
<!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
%gtkdocentities;
<!ENTITY % configentities SYSTEM "config.ent">
%configentities;
]>
<book id="index">
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>libApp Reference Manual</title>
<title>&vendor; &package; &title;</title>
<releaseinfo>
for libApp &version;.
for &vendor; &package; &version;.
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://&server;/libApp/index.html">http://&server;/libApp/</ulink>.
<ulink role="online-location" url="https://&server;/&package;/">https://&server;/&package;/</ulink>.
</releaseinfo>
</bookinfo>
<chapter>
<title>&title;</title>
<title>&vendor; &package;</title>
<xi:include href="xml/app.xml"/>
<xi:include href="xml/appclient.xml"/>
<xi:include href="xml/appmessage.xml"/>
<xi:include href="xml/appserver.xml"/>
<xi:include href="xml/apptransport.xml"/>
</chapter>
<!-- enable this when you use gobject types
<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>
@ -33,6 +40,7 @@
<title>Index of deprecated API</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index>
<!-- enable this when you use gobject introspection annotations
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
-->
</book>

56
doc/gtkdoc/libApp-sections.txt Normal file
View File

@ -0,0 +1,56 @@
<SECTION>
<FILE>App</FILE>
</SECTION>
<SECTION>
<FILE>app</FILE>
AppMessage
</SECTION>
<SECTION>
<FILE>appclient</FILE>
AppClient
appclient_call
appclient_delete
appclient_new
appclient_new_event
</SECTION>
<SECTION>
<FILE>appmessage</FILE>
AppMessageType
appmessage_delete
appmessage_get_method
appmessage_get_type
appmessage_new_call
appmessage_new_deserialize
appmessage_serialize
</SECTION>
<SECTION>
<FILE>appserver</FILE>
APPSERVER_MAX_ARGUMENTS
AppServer
AppServerOptions
appserver_delete
appserver_get_client_id
appserver_loop
appserver_new
appserver_new_event
</SECTION>
<SECTION>
<FILE>apptransport</FILE>
AppTransport
AppTransportClient
AppTransportMode
AppTransportPlugin
AppTransportPluginDefinition
AppTransportStatus
client_delete
client_new
client_receive
status
</SECTION>

2
doc/gtkdoc/project.conf
View File

@ -1 +1 @@
dist=Makefile,libApp-docs.xml
dist=Makefile,libApp-docs.xml,libApp-sections.txt,xml/gtkdocentities.ent

2
doc/gtkdoc/xml/gtkdocentities.ent Normal file
View File

@ -0,0 +1,2 @@
<!ENTITY server "www.defora.org/doc/gtk-doc/html">
<!ENTITY title "Reference Manual">

22
doc/project.conf
View File

@ -1,7 +1,8 @@
subdirs=gtkdoc
targets=AppBroker.1,AppBroker.html,AppClient.1,AppClient.html,gtkdoc/libApp.types,gtkdoc/tmpl.stamp,gtkdoc/sgml.stamp,gtkdoc/html.stamp
targets=AppBroker.1,AppBroker.html,AppClient.1,AppClient.html,gtkdoc/html.stamp,gtkdoc/libApp.types,gtkdoc/tmpl.stamp,gtkdoc/xml.stamp
dist=Makefile,AppBroker.css.xml,AppBroker.xml,AppClient.css.xml,AppClient.xml,docbook.sh,gtkdoc.sh,manual.css.xml
#targets
[AppBroker.1]
type=script
script=./docbook.sh
@ -26,22 +27,23 @@ script=./docbook.sh
depends=AppClient.css.xml,AppClient.xml,manual.css.xml
#install=
[gtkdoc/html.stamp]
type=script
script=./gtkdoc.sh
depends=gtkdoc.sh,gtkdoc/libApp-docs.xml,$(OBJDIR)gtkdoc/xml.stamp,gtkdoc/xml/gtkdocentities.ent,../config.ent
install=
[gtkdoc/libApp.types]
type=script
script=./gtkdoc.sh
depends=gtkdoc.sh
[gtkdoc/tmpl.stamp]
type=script
script=./gtkdoc.sh
depends=$(OBJDIR)gtkdoc/libApp.types
depends=gtkdoc.sh,$(OBJDIR)gtkdoc/libApp.types
[gtkdoc/sgml.stamp]
[gtkdoc/xml.stamp]
type=script
script=./gtkdoc.sh
depends=$(OBJDIR)gtkdoc/tmpl.stamp
[gtkdoc/html.stamp]
type=script
script=./gtkdoc.sh
depends=gtkdoc/libApp-docs.xml,$(OBJDIR)gtkdoc/sgml.stamp,$(OBJDIR)gtkdoc/tmpl.stamp
install=
depends=gtkdoc.sh,$(OBJDIR)gtkdoc/tmpl.stamp

4
project.conf
View File

@ -1,7 +1,7 @@
package=libApp
version=0.3.2
config=h,sh
dist=Makefile,COPYING,README.md,config.h,config.sh
config=ent,h,sh
dist=Makefile,COPYING,README.md,config.ent,config.h,config.sh
subdirs=data,doc,include,src,src/transport,tools,tests
targets=tests