Basic layout for gtkdoc

git-svn-id: https://svn.code.sf.net/p/gphoto/code/trunk/libgphoto2@1783 67ed7778-7388-44ab-90cf-0a291f65f57c
This commit is contained in:
Lutz Mueller
2001-03-22 11:59:34 +00:00
parent 2d9fb8ca5b
commit be03e1bca7
5 changed files with 123 additions and 0 deletions

10
doc/api/.cvsignore Normal file
View File

@@ -0,0 +1,10 @@
Makefile
Makefile.in
gphoto2-api.html
html
sgml
gphoto2-scan.c
gphoto2-scan
html.stamp
sgml.stamp

88
doc/api/Makefile.am Normal file
View File

@@ -0,0 +1,88 @@
DOC_MODULE=gphoto2
DOC_MAIN_SGML_FILE=gphoto2-api.sgml
DOC_SOURCE_DIR=$(top_srcdir)/libgphoto2
CFLAGS="-I../.. `gphoto2-config --cflags`"
LDFLAGS="`gphoto2-config --ldflags`"
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
tmpl_sources = \
tmpl/widget.sgml
gphoto2_docdir = $(HTML_DIR)
gphoto2_doc_DATA = \
gphoto2-api.sgml \
gphoto2-api.html
EXTRA_DIST = $(gphoto2_doc_DATA)
if ENABLE_GTK_DOC
gphoto2-api.html: html/book1.html
-cp $(srcdir)/html/book1.html $(srcdir)/gphoto2-api.html
else
gphoto2-api.html:
endif
html/book1.html: sgml/gphoto2-doc.bottom
$(MAKE) html
sgml/gphoto2-doc.bottom: $(tmpl_sources)
$(MAKE) sgml
scan:
-(cd $(srcdir) \
&& env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \
gtkdoc-scanobj --module=$(DOC_MODULE) \
&& gtkdoc-scan --module=$(DOC_MODULE) \
../../include/gphoto2-widget.h
templates:
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
sgml:
cd $(srcdir) \
&& gtkdoc-mkdb --module=$(DOC_MODULE) \
--source-dir=$(top_srcdir)/libgphoto2
html:
test -d $(srcdir)/html || mkdir $(srcdir)/html
-cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
clean-local:
rm -f *~ *.bak *-unused.txt
maintainer-clean-local: clean
cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
install-data-local:
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
(installfiles=`echo $(srcdir)/html/*.html`; \
if test "$$installfiles" = '$(srcdir)/html/*.html'; \
then echo '-- Nothing to install' ; \
else \
for i in $$installfiles; do \
echo '-- Installing '$$i ; \
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
done; \
echo '-- Installing $(srcdir)/html/index.sgml' ; \
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
echo '-- Fixing Crossreferences' ; \
gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \
fi)
dist-hook:
mkdir $(distdir)/html
mkdir $(distdir)/sgml
mkdir $(distdir)/tmpl
-cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
-cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
-cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
.PHONY : html sgml templates scan

16
doc/api/gphoto2-api.sgml Normal file
View File

@@ -0,0 +1,16 @@
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!entity widget SYSTEM "sgml/widget.sgml">
]>
<book>
<bookinfo>
<title>GPhoto2 API Reference Manual</title>
</bookinfo>
<chapter id="gphoto2-camera-configuration">
<title>Camera Configuration</title>
&widget;
</chapter>
</book
>

5
doc/api/gphoto2-decl.txt Normal file
View File

@@ -0,0 +1,5 @@
<FUNCTION>
<NAME>gp_widget_new</NAME>
<RETURNS>int</RETURNS>
CameraWidgetType type, const gchar *name
</FUNCTION>

View File

@@ -0,0 +1,4 @@
<SECTION>
<FILE>widget</FILE>
gp_widget_new
</SECTION>