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

doc: switch to Gtkdoc XML

Browse Source
This commit is contained in:
Pierre Pronchery 2024-09-09 21:03:12 +02:00
parent 91b9cfeaf3
commit e6b1fbfe7a
15 changed files with 32 additions and 751 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/gtkdoc/Mailer-docs.xml
View File

@ -3,17 +3,18 @@
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" "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 % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY server "www.defora.org/doc/gtk-doc/html"> <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
<!ENTITY title "DeforaOS Mailer"> %gtkdocentities;
<!ENTITY version "0.1.6"> <!ENTITY % configentities SYSTEM "config.ent">
%configentities;
]> ]>
<book id="index"> <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo> <bookinfo>
<title>Mailer Reference Manual</title> <title>&vendor; &package; &title;</title>
<releaseinfo> <releaseinfo>
for Mailer &version;. for &vendor; &package; &version;.
The latest version of this documentation can be found on-line at The latest version of this documentation can be found on-line at
<ulink role="online-location" url="https://&server;/Mailer/index.html">https://&server;/Mailer/</ulink>. <ulink role="online-location" url="https://&server;/&package;/">https://&server;/&package;/</ulink>.
</releaseinfo> </releaseinfo>
</bookinfo> </bookinfo>
@ -27,6 +28,12 @@
<xi:include href="xml/plugin.xml"/> <xi:include href="xml/plugin.xml"/>
</chapter> </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"> <index id="api-index-full">
<title>API Index</title> <title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
@ -35,6 +42,7 @@
<title>Index of deprecated API</title> <title>Index of deprecated API</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index> </index>
<!-- enable this when you use gobject introspection annotations
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
-->
</book> </book>

3
doc/gtkdoc/project.conf
View File

@ -1,2 +1 @@
subdirs=tmpl dist=Makefile,Mailer-docs.xml,Mailer-sections.txt,xml/gtkdocentities.ent
dist=Makefile,Mailer-docs.xml

17
doc/gtkdoc/tmpl/Mailer-unused.sgml
View File

@ -1,17 +0,0 @@
<!-- ##### FUNCTION folder_get_messages ##### -->
<para>
</para>
@folder:
@Returns:
<!-- ##### USER_FUNCTION status ##### -->
<para>
</para>
@account:
@format:
@...:

22
doc/gtkdoc/tmpl/Mailer.sgml
View File

@ -1,22 +0,0 @@
<!-- ##### SECTION Title ##### -->
Mailer
<!-- ##### SECTION Short_Description ##### -->
DeforaOS Desktop Mailer
<!-- ##### SECTION Long_Description ##### -->
<para>
e-mail client for the DeforaOS desktop.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
DeforaOS libDesktop, DeforaOS libSystem
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->

253
doc/gtkdoc/tmpl/account.sgml
View File

@ -1,253 +0,0 @@
<!-- ##### SECTION Title ##### -->
Account
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT Account ##### -->
<para>
</para>
<!-- ##### ENUM AccountConfigType ##### -->
<para>
</para>
@ACT_NONE:
@ACT_STRING:
@ACT_PASSWORD:
@ACT_FILE:
@ACT_UINT16:
@ACT_BOOLEAN:
@ACT_SEPARATOR:
<!-- ##### ENUM AccountEventType ##### -->
<para>
</para>
@AET_STARTED:
@AET_STOPPED:
@AET_STATUS:
<!-- ##### STRUCT AccountPlugin ##### -->
<para>
</para>
<!-- ##### ENUM AccountStatus ##### -->
<para>
</para>
@AS_CONNECTING:
@AS_CONNECTED:
@AS_DISCONNECTED:
@AS_AUTHENTICATED:
@AS_IDLE:
<!-- ##### USER_FUNCTION authenticate ##### -->
<para>
</para>
@account:
@message:
@Returns:
<!-- ##### USER_FUNCTION confirm ##### -->
<para>
</para>
@account:
@message:
@Returns:
<!-- ##### USER_FUNCTION destroy ##### -->
<para>
</para>
@plugin:
@Returns:
<!-- ##### USER_FUNCTION error ##### -->
<para>
</para>
@account:
@message:
@ret:
@Returns:
<!-- ##### USER_FUNCTION event ##### -->
<para>
</para>
@account:
@event:
<!-- ##### USER_FUNCTION folder_delete ##### -->
<para>
</para>
@folder:
<!-- ##### USER_FUNCTION folder_new ##### -->
<para>
</para>
@account:
@folder:
@parent:
@type:
@name:
@Returns:
<!-- ##### USER_FUNCTION get_config ##### -->
<para>
</para>
@plugin:
@Returns:
<!-- ##### USER_FUNCTION get_source ##### -->
<para>
</para>
@plugin:
@folder:
@message:
@Returns:
<!-- ##### USER_FUNCTION get_ssl_context ##### -->
<para>
</para>
@account:
@Returns:
<!-- ##### USER_FUNCTION init ##### -->
<para>
</para>
@helper:
@Returns:
<!-- ##### USER_FUNCTION message_delete ##### -->
<para>
</para>
@message:
<!-- ##### USER_FUNCTION message_new ##### -->
<para>
</para>
@account:
@folder:
@message:
@Returns:
<!-- ##### USER_FUNCTION message_set_body ##### -->
<para>
</para>
@message:
@buf:
@cnt:
@append:
@Returns:
<!-- ##### FUNCTION message_set_flag ##### -->
<para>
</para>
@message:
@flag:
<!-- ##### USER_FUNCTION message_set_header ##### -->
<para>
</para>
@message:
@header:
@Returns:
<!-- ##### USER_FUNCTION refresh ##### -->
<para>
</para>
@plugin:
@folder:
@message:
@Returns:
<!-- ##### USER_FUNCTION start ##### -->
<para>
</para>
@plugin:
@Returns:
<!-- ##### USER_FUNCTION stop ##### -->
<para>
</para>
@plugin:

86
doc/gtkdoc/tmpl/folder.sgml
View File

@ -1,86 +0,0 @@
<!-- ##### SECTION Title ##### -->
Folder
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT AccountFolder ##### -->
<para>
</para>
<!-- ##### MACRO FT_COUNT ##### -->
<para>
</para>
<!-- ##### MACRO FT_LAST ##### -->
<para>
</para>
<!-- ##### TYPEDEF Folder ##### -->
<para>
</para>
<!-- ##### ENUM FolderType ##### -->
<para>
</para>
@FT_INBOX:
@FT_DRAFTS:
@FT_SENT:
@FT_TRASH:
@FT_FOLDER:
<!-- ##### FUNCTION folder_get_name ##### -->
<para>
</para>
@folder:
@Returns:
<!-- ##### FUNCTION folder_get_type ##### -->
<para>
</para>
@folder:
@Returns:
<!-- ##### FUNCTION folder_set_type ##### -->
<para>
</para>
@folder:
@type:

59
doc/gtkdoc/tmpl/helper.sgml
View File

@ -1,59 +0,0 @@
<!-- ##### SECTION Title ##### -->
Helper
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### FUNCTION mailer_helper_get_date ##### -->
<para>
</para>
@date:
@tm:
@Returns:
<!-- ##### FUNCTION mailer_helper_get_email ##### -->
<para>
</para>
@header:
@Returns:
<!-- ##### FUNCTION mailer_helper_get_name ##### -->
<para>
</para>
@header:
@Returns:
<!-- ##### FUNCTION mailer_helper_is_email ##### -->
<para>
</para>
@email:
@Returns:

99
doc/gtkdoc/tmpl/mailer.sgml
View File

@ -1,99 +0,0 @@
<!-- ##### SECTION Title ##### -->
Mailer
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### MACRO MFC_COUNT ##### -->
<para>
</para>
<!-- ##### MACRO MFC_LAST ##### -->
<para>
</para>
<!-- ##### MACRO MHC_COUNT ##### -->
<para>
</para>
<!-- ##### MACRO MHC_LAST ##### -->
<para>
</para>
<!-- ##### STRUCT Mailer ##### -->
<para>
</para>
<!-- ##### STRUCT MailerFolder ##### -->
<para>
</para>
<!-- ##### ENUM MailerFolderColumn ##### -->
<para>
</para>
@MFC_ACCOUNT:
@MFC_ENABLED:
@MFC_DELETE:
@MFC_FOLDER:
@MFC_ICON:
@MFC_NAME:
<!-- ##### ENUM MailerHeaderColumn ##### -->
<para>
</para>
@MHC_ACCOUNT:
@MHC_FOLDER:
@MHC_MESSAGE:
@MHC_ICON:
@MHC_SUBJECT:
@MHC_FROM:
@MHC_FROM_EMAIL:
@MHC_TO:
@MHC_TO_EMAIL:
@MHC_DATE:
@MHC_DATE_DISPLAY:
@MHC_READ:
@MHC_WEIGHT:
<!-- ##### STRUCT MailerMessage ##### -->
<para>
</para>

92
doc/gtkdoc/tmpl/message.sgml
View File

@ -1,92 +0,0 @@
<!-- ##### SECTION Title ##### -->
Message
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT AccountMessage ##### -->
<para>
</para>
<!-- ##### ENUM MailerMessageFlag ##### -->
<para>
</para>
@MMF_READ:
@MMF_ANSWERED:
@MMF_URGENT:
@MMF_DRAFT:
@MMF_DELETED:
<!-- ##### TYPEDEF Message ##### -->
<para>
</para>
<!-- ##### FUNCTION message_get_flags ##### -->
<para>
</para>
@message:
@Returns:
<!-- ##### FUNCTION message_get_header ##### -->
<para>
</para>
@message:
@header:
@Returns:
<!-- ##### FUNCTION message_save ##### -->
<para>
</para>
@message:
@filename:
@Returns:
<!-- ##### FUNCTION message_set_flag ##### -->
<para>
</para>
@message:
@flag:
<!-- ##### FUNCTION message_set_flags ##### -->
<para>
</para>
@message:
@flags:

77
doc/gtkdoc/tmpl/plugin.sgml
View File

@ -1,77 +0,0 @@
<!-- ##### SECTION Title ##### -->
MailerPlugin
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT MailerPlugin ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION destroy ##### -->
<para>
</para>
@plugin:
@Returns:
<!-- ##### USER_FUNCTION error ##### -->
<para>
</para>
@account:
@message:
@ret:
@Returns:
<!-- ##### USER_FUNCTION get_widget ##### -->
<para>
</para>
@plugin:
@Returns:
<!-- ##### USER_FUNCTION init ##### -->
<para>
</para>
@helper:
@Returns:
<!-- ##### USER_FUNCTION refresh ##### -->
<para>
</para>
@plugin:
@folder:
@message:
@Returns:

1
doc/gtkdoc/tmpl/project.conf
View File

@ -1 +0,0 @@
dist=Makefile,Mailer.sgml

22
doc/gtkdoc/tmpl/transport.sgml
View File

@ -1,22 +0,0 @@
<!-- ##### SECTION Title ##### -->
Transport
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->

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">

24
doc/project.conf
View File

@ -1,5 +1,5 @@
subdirs=gtkdoc subdirs=gtkdoc
targets=compose.1,compose.html,gtkdoc/Mailer.types,gtkdoc/tmpl.stamp,gtkdoc/sgml.stamp,gtkdoc/html.stamp,mailer.1,mailer.html targets=compose.1,compose.html,gtkdoc/Mailer.types,gtkdoc/tmpl.stamp,gtkdoc/html.stamp,gtkdoc/xml.stamp,mailer.1,mailer.html
dist=Makefile,compose.css.xml,compose.xml,docbook.sh,gtkdoc.sh,mailer.css.xml,mailer.xml,manual.css.xml dist=Makefile,compose.css.xml,compose.xml,docbook.sh,gtkdoc.sh,mailer.css.xml,mailer.xml,manual.css.xml
[compose.1] [compose.1]
@ -19,22 +19,22 @@ type=script
script=./gtkdoc.sh script=./gtkdoc.sh
depends=../config.sh depends=../config.sh
[gtkdoc/tmpl.stamp]
type=script
script=./gtkdoc.sh
depends=gtkdoc/Mailer.types
[gtkdoc/sgml.stamp]
type=script
script=./gtkdoc.sh
depends=gtkdoc/tmpl.stamp
[gtkdoc/html.stamp] [gtkdoc/html.stamp]
type=script type=script
script=./gtkdoc.sh script=./gtkdoc.sh
depends=gtkdoc/Mailer-docs.xml,gtkdoc/sgml.stamp depends=gtkdoc/Mailer-docs.xml,$(OBJDIR)gtkdoc/xml.stamp,gtkdoc/xml/gtkdocentities.ent,../config.ent
install= install=
[gtkdoc/tmpl.stamp]
type=script
script=./gtkdoc.sh
depends=gtkdoc.sh,$(OBJDIR)gtkdoc/Mailer.types
[gtkdoc/xml.stamp]
type=script
script=./gtkdoc.sh
depends=gtkdoc.sh,$(OBJDIR)gtkdoc/tmpl.stamp
[mailer.1] [mailer.1]
type=script type=script
script=./docbook.sh script=./docbook.sh

2
project.conf
View File

@ -1,7 +1,7 @@
vendor=Desktop vendor=Desktop
package=Mailer package=Mailer
version=0.2.0 version=0.2.0
config=h,sh config=h,sh,ent
subdirs=data,doc,include,po,src,src/plugins,tests subdirs=data,doc,include,po,src,src/plugins,tests
targets=tests targets=tests