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

Generate the Gtk-Doc documentation with XML

Browse Source
This commit is contained in:
Pierre Pronchery 2020-02-23 19:52:58 +01:00
parent a37a6ec013
commit 43e9b1f002
8 changed files with 17 additions and 173 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/gtkdoc/project.conf
View File

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

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

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

128
doc/gtkdoc/tmpl/database.sgml
View File

@ -1,128 +0,0 @@
<!-- ##### SECTION Title ##### -->
database
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT Database ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION DatabaseCallback ##### -->
<para>
</para>
@data:
@argc:
@argv:
@columns:
@Returns:
<!-- ##### STRUCT DatabaseStatement ##### -->
<para>
</para>
<!-- ##### ENUM DatabaseType ##### -->
<para>
</para>
@DT_NULL:
@DT_INTEGER:
@DT_TIMESTAMP:
@DT_VARCHAR:
<!-- ##### FUNCTION database_delete ##### -->
<para>
</para>
@database:
<!-- ##### FUNCTION database_get_last_id ##### -->
<para>
</para>
@database:
@Returns:
<!-- ##### FUNCTION database_new ##### -->
<para>
</para>
@engine:
@config:
@section:
@Returns:
<!-- ##### FUNCTION database_prepare_delete ##### -->
<para>
</para>
@database:
@statement:
<!-- ##### FUNCTION database_prepare_new ##### -->
<para>
</para>
@database:
@query:
@Returns:
<!-- ##### FUNCTION database_prepare_query ##### -->
<para>
</para>
@database:
@statement:
@callback:
@data:
@...:
@Returns:
<!-- ##### FUNCTION database_query ##### -->
<para>
</para>
@database:
@query:
@callback:
@data:
@Returns:

6
doc/gtkdoc/tmpl/libDatabase-unused.sgml
View File

@ -1,6 +0,0 @@
<!-- ##### STRUCT DatabasePlugin ##### -->
<para>
</para>

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

@ -1 +0,0 @@
dist=Makefile,Database.sgml,database.sgml,libDatabase-unused.sgml

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
targets=database.1,database.html,database.xml,gtkdoc/libDatabase.types,gtkdoc/tmpl.stamp,gtkdoc/sgml.stamp,gtkdoc/html.stamp
targets=database.1,database.html,database.xml,gtkdoc/html.stamp,gtkdoc/libDatabase.types,gtkdoc/tmpl.stamp,gtkdoc/xml.stamp
dist=Makefile,database.css.xml,database.xml.in,docbook.sh,gtkdoc.sh,manual.css.xml
#targets
@ -25,18 +25,18 @@ type=script
script=./gtkdoc.sh
depends=gtkdoc.sh,../config.sh
[gtkdoc/tmpl.stamp]
type=script
script=./gtkdoc.sh
depends=gtkdoc.sh,gtkdoc/libDatabase.types
[gtkdoc/sgml.stamp]
type=script
script=./gtkdoc.sh
depends=gtkdoc.sh,gtkdoc/tmpl.stamp
[gtkdoc/html.stamp]
type=script
script=./gtkdoc.sh
depends=gtkdoc.sh,gtkdoc/libDatabase-docs.xml,gtkdoc/sgml.stamp
depends=gtkdoc.sh,gtkdoc/libDatabase-docs.xml,$(OBJDIR)gtkdoc/xml.stamp,gtkdoc/xml/gtkdocentities.ent,../config.ent
install=
[gtkdoc/tmpl.stamp]
type=script
script=./gtkdoc.sh
depends=gtkdoc.sh,$(OBJDIR)gtkdoc/libDatabase.types
[gtkdoc/xml.stamp]
type=script
script=./gtkdoc.sh
depends=gtkdoc.sh,$(OBJDIR)gtkdoc/tmpl.stamp

4
project.conf
View File

@ -1,6 +1,6 @@
package=libDatabase
version=0.0.2
config=h,sh
config=ent,h,sh
subdirs=data,doc,include,src,tests,tools
dist=Makefile,config.h,config.sh
dist=Makefile,config.ent,config.h,config.sh