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

Use GtkDoc with XML templates

Browse Source
This commit is contained in:
Pierre Pronchery 2020-03-03 01:19:01 +01:00
parent 8eeaca462d
commit 7343b08bde
8 changed files with 175 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

144
doc/gtkdoc.sh
View File

@ -1,6 +1,6 @@
#!/bin/sh
#$Id$
#Copyright (c) 2012-2017 Pierre Pronchery <khorben@defora.org>
#Copyright (c) 2012-2020 Pierre Pronchery <khorben@defora.org>
#
#Redistribution and use in source and binary forms, with or without
#modification, are permitted provided that the following conditions are met:
@ -38,6 +38,7 @@ GTKDOC_SCAN="gtkdoc-scan"
INSTALL="install -m 0644"
MKDIR="mkdir -m 0755 -p"
RM="rm -f"
RMDIR="rmdir"
TOUCH="touch"
[ -f "../config.sh" ] && . "../config.sh"
@ -60,6 +61,77 @@ _error()
}
#gtkdoc_fixxref
_gtkdoc_fixxref()
{
module="$1"
moduledir="$2"
htmldir="$3"
outputdir="$4"
(cd "$outputdir" &&
$DEBUG $GTKDOC_FIXXREF \
--module="$module" \
--module-dir="$moduledir" \
--html-dir="$htmldir") || exit 2
}
#gtkdoc_mkdb
_gtkdoc_mkdb()
{
module="$1"
sourcedir="$2"
outputdir="$3"
(cd "$sourcedir" &&
$DEBUG $GTKDOC_MKDB --module="$module" \
--output-dir="$outputdir" \
--output-format="xml" --tmpl-dir="tmpl")
}
#gtkdoc_mkhtml
_gtkdoc_mkhtml()
{
module="$1"
path="$2"
driver="$3"
outputdir="$4"
(cd "$outputdir" &&
$DEBUG $GTKDOC_MKHTML --path "$path" "$module" "$driver")
}
#gtkdoc_mktmpl
_gtkdoc_mktmpl()
{
module="$1"
sourcedir="$2"
outputdir="$3"
(cd "$sourcedir" &&
$DEBUG $GTKDOC_MKTMPL --module="$module" \
--output-dir="$outputdir")
}
#gtkdoc_scan
_gtkdoc_scan()
{
module="$1"
sourcedir="$2"
outputdir="$3"
(cd ".." &&
$DEBUG $GTKDOC_SCAN --module="$module" \
--source-dir="$sourcedir" \
--output-dir="$outputdir")
# --rebuild-types
}
#usage
_usage()
{
@ -129,23 +201,28 @@ while [ $# -gt 0 ]; do
file="${i##*/}"
$DEBUG $RM -- "$instdir/$MODULE/$file" || exit 2
done
if [ -d "$instdir/$MODULE" ]; then
$DEBUG $RMDIR -- "$instdir/$MODULE" || exit 2
fi
continue
fi
#create
case "$target" in
gtkdoc/html.stamp)
driver="../$MODULE-docs.xml"
if [ -n "$OBJDIR" ]; then
driver="gtkdoc/$MODULE-docs.xml"
$DEBUG $CP -- "$driver" "${OBJDIR}gtkdoc" \
|| exit 2
fi
output="${OBJDIR}gtkdoc/html"
$DEBUG $MKDIR -- "$output" || exit 2
(cd "$output" &&
$DEBUG $GTKDOC_MKHTML "$MODULE" \
"${OBJDIR}$driver")
driver="$MODULE-docs.xml"
oldpath="$PWD"
[ -n "$OBJDIR" ] && for file in \
"gtkdoc/$driver" \
"gtkdoc/xml/gtkdocentities.ent"; do
[ -f "$file" ] || continue
$DEBUG $CP -- "$file" \
"${OBJDIR}$file" || exit 2
done
_gtkdoc_mkhtml "$MODULE" "${oldpath%/*}" "../$driver" \
"$output"
#detect when gtk-doc is not available
res=$?
if [ $res -eq 127 ]; then
@ -156,24 +233,7 @@ while [ $# -gt 0 ]; do
exit 2
fi
output="${OBJDIR}gtkdoc"
(cd "$output" &&
$DEBUG $GTKDOC_FIXXREF \
--module="$MODULE" \
--module-dir="html" \
--html-dir="$instdir") || exit 2
;;
gtkdoc/sgml.stamp)
output="xml"
if [ -n "$OBJDIR" ]; then
output="${OBJDIR}gtkdoc/xml"
$DEBUG $MKDIR -- "$output" || exit 2
fi
(cd "${OBJDIR}gtkdoc" &&
$DEBUG $GTKDOC_MKDB \
--module="$MODULE" \
--output-dir="$output" \
--output-format="xml" \
--tmpl-dir="tmpl")
_gtkdoc_fixxref "$MODULE" "html" "$instdir" "$output"
;;
gtkdoc/tmpl.stamp)
output="tmpl"
@ -181,22 +241,28 @@ while [ $# -gt 0 ]; do
output="${OBJDIR}gtkdoc/tmpl"
$DEBUG $MKDIR -- "$output" || exit 2
fi
(cd "${OBJDIR}gtkdoc" &&
$DEBUG $GTKDOC_MKTMPL \
--module="$MODULE" \
--output-dir="$output")
_gtkdoc_mktmpl "$MODULE" "${OBJDIR}gtkdoc" "$output"
;;
gtkdoc/xml.stamp)
output="xml"
if [ -n "$OBJDIR" ]; then
output="${OBJDIR}gtkdoc"
sections="gtkdoc/$MODULE-sections.txt"
$DEBUG $MKDIR -- "$output/xml" || exit 2
$DEBUG $CP -- "$sections" "$output" \
|| exit 2
_gtkdoc_scan "$MODULE" "include" "$output"
output="${OBJDIR}gtkdoc/xml"
fi
_gtkdoc_mkdb "$MODULE" "${OBJDIR}gtkdoc" "$output"
;;
gtkdoc/*.types)
output="doc/gtkdoc" || exit 2
output="$PWD/gtkdoc" || exit 2
if [ -n "$OBJDIR" ]; then
output="${OBJDIR}gtkdoc"
$DEBUG $MKDIR -- "$output" || exit 2
fi
(cd ".." &&
$DEBUG $GTKDOC_SCAN \
--module="$MODULE" \
--source-dir="include" \
--output-dir="$output")
_gtkdoc_scan "$MODULE" "include" "$output"
;;
*)
_error "$target: Unknown type"
@ -208,7 +274,7 @@ while [ $# -gt 0 ]; do
_error "$target: Could not create documentation"
install=0
fi
$TOUCH "$target"
$TOUCH "${OBJDIR}$target"
#install
if [ "$install" -eq 1 ]; then

52
doc/gtkdoc/Browser-sections.txt Normal file
View File

@ -0,0 +1,52 @@
<SECTION>
<FILE>Browser</FILE>
</SECTION>
<SECTION>
<FILE>desktop</FILE>
DesktopAlignment
DesktopIcons
DESKTOP_ICONS_LAST
DESKTOP_ICONS_COUNT
DesktopLayout
DesktopMessage
DesktopMessageShow
DESKTOP_CLIENT_MESSAGE
</SECTION>
<SECTION>
<FILE>plugin</FILE>
config_get
config_set
error
get_icon
get_mime
get_type
refresh
set_location
init
destroy
get_widget
Browser
BrowserPlugin
</SECTION>
<SECTION>
<FILE>vfs</FILE>
browser_vfs_can_eject
browser_vfs_can_mount
browser_vfs_can_unmount
browser_vfs_is_mountpoint
browser_vfs_opendir
browser_vfs_closedir
browser_vfs_readdir
browser_vfs_eject
browser_vfs_mount
browser_vfs_unmount
browser_vfs_mime_icon
browser_vfs_mime_type
browser_vfs_lstat
browser_vfs_stat
</SECTION>

3
doc/gtkdoc/project.conf
View File

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

22
doc/gtkdoc/tmpl/Browser.tmpl
View File

@ -1,22 +0,0 @@
<!-- ##### SECTION Title ##### -->
Browser
<!-- ##### SECTION Short_Description ##### -->
DeforaOS Desktop Browser
<!-- ##### SECTION Long_Description ##### -->
<para>
File manager and image browser for the DeforaOS desktop.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
DeforaOS libDesktop, DeforaOS libSystem
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->

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

@ -1 +0,0 @@
dist=Makefile,Browser.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">

26
doc/project.conf
View File

@ -1,6 +1,6 @@
subdirs=gtkdoc
targets=browser.1,browser.html,browser.xml,copy.1,copy.html,copy.xml,delete.1,delete.html,delete.xml,desktop.1,desktop.html,desktop.xml,desktopctl.1,desktopctl.html,desktopctl.xml,gtkdoc/Browser.types,gtkdoc/tmpl.stamp,gtkdoc/sgml.stamp,gtkdoc/html.stamp,move.1,move.html,move.xml,open.1,open.html,open.xml,pinentry-sudo-askpass,properties.1,properties.html,properties.xml,view.1,view.html,view.xml,zenity-sudo-askpass
dist=Makefile,browser.css.xml,browser.xml.in,copy.css.xml,copy.xml.in,delete.css.xml,delete.xml.in,desktop.css.xml,desktop.xml.in,desktopctl.css.xml,desktopctl.xml.in,docbook.sh,manual.css.xml,mime.conf,move.css.xml,move.xml.in,open.css.xml,open.xml.in,pinentry-sudo-askpass.in,properties.css.xml,properties.xml.in,view.css.xml,view.xml.in,zenity-sudo-askpass.in
targets=browser.1,browser.html,browser.xml,copy.1,copy.html,copy.xml,delete.1,delete.html,delete.xml,desktop.1,desktop.html,desktop.xml,desktopctl.1,desktopctl.html,desktopctl.xml,gtkdoc/Browser.types,gtkdoc/html.stamp,gtkdoc/tmpl.stamp,gtkdoc/xml.stamp,move.1,move.html,move.xml,open.1,open.html,open.xml,pinentry-sudo-askpass,properties.1,properties.html,properties.xml,view.1,view.html,view.xml,zenity-sudo-askpass
dist=Makefile,browser.css.xml,browser.xml.in,copy.css.xml,copy.xml.in,delete.css.xml,delete.xml.in,desktop.css.xml,desktop.xml.in,desktopctl.css.xml,desktopctl.xml.in,docbook.sh,gtkdoc.sh,manual.css.xml,mime.conf,move.css.xml,move.xml.in,open.css.xml,open.xml.in,pinentry-sudo-askpass.in,properties.css.xml,properties.xml.in,view.css.xml,view.xml.in,zenity-sudo-askpass.in
#targets
[browser.1]
@ -93,22 +93,22 @@ type=script
script=./gtkdoc.sh
depends=../config.sh
[gtkdoc/tmpl.stamp]
type=script
script=./gtkdoc.sh
depends=gtkdoc.sh,gtkdoc/Browser.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/Browser-docs.xml,gtkdoc/sgml.stamp
depends=gtkdoc.sh,gtkdoc/Browser-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/Browser.types
[gtkdoc/xml.stamp]
type=script
script=./gtkdoc.sh
depends=gtkdoc.sh,$(OBJDIR)gtkdoc/tmpl.stamp
[move.1]
type=script
script=./docbook.sh

4
project.conf
View File

@ -1,10 +1,10 @@
package=Browser
version=0.5.3
config=h,sh
config=ent,h,sh
subdirs=data,doc,include,po,src/lib,src,src/plugins,src/widget,tests,tools
targets=tests
dist=Makefile,COPYING,README.md,TODO,config.h,config.sh
dist=Makefile,COPYING,README.md,TODO,config.ent,config.h,config.sh
#targets
[tests]