Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Oleksii Turkot
CrystFEL
Commits
cf481c5e
Commit
cf481c5e
authored
Mar 26, 2011
by
Thomas White
Committed by
Thomas White
Feb 22, 2012
Browse files
Add documentation via gtk-doc
parent
03acd738
Changes
20
Expand all
Hide whitespace changes
Inline
Side-by-side
.gitignore
View file @
cf481c5e
...
...
@@ -24,3 +24,26 @@ src/sum_stack
src/geomatic
src/.dirstamp
*~
doc/reference/.args
doc/reference/.hierarchy
doc/reference/.interfaces
doc/reference/.prerequisites
doc/reference/.signals
doc/reference/CrystFEL-decl-list.txt
doc/reference/CrystFEL-decl.txt
doc/reference/CrystFEL-overrides.txt
doc/reference/CrystFEL-undeclared.txt
doc/reference/CrystFEL-undocumented.txt
doc/reference/CrystFEL-unused.txt
doc/reference/CrystFEL.args
doc/reference/CrystFEL.hierarchy
doc/reference/CrystFEL.interfaces
doc/reference/CrystFEL.prerequisites
doc/reference/CrystFEL.signals
doc/reference/html-build.stamp
doc/reference/html.stamp
doc/reference/html/
doc/reference/scan-build.stamp
doc/reference/sgml-build.stamp
doc/reference/sgml.stamp
doc/reference/xml/
Makefile.am
View file @
cf481c5e
EXTRA_DIST
=
configure m4/gnulib-cache.m4
SUBDIRS
=
lib
SUBDIRS
=
lib
doc/reference
ACLOCAL_AMFLAGS
=
-I
m4
bin_PROGRAMS
=
src/pattern_sim src/process_hkl src/get_hkl src/indexamajig
\
...
...
@@ -172,3 +172,6 @@ EXTRA_DIST += scripts/check-near-bragg scripts/double-hit scripts/random-image \
scripts/cell-please scripts/check-hkl-completeness.gp
\
scripts/check-hkl-quality.gp scripts/compare-hkl.gp
\
scripts/check-peak-detection
DISTCHECK_CONFIGURE_FLAGS
=
--enable-gtk-doc
Makefile.in
View file @
cf481c5e
...
...
@@ -59,7 +59,7 @@ ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps
=
$(top_srcdir)
/m4/00gnulib.m4
\
$(top_srcdir)
/m4/extensions.m4
\
$(top_srcdir)
/m4/gnulib-common.m4
\
$(top_srcdir)
/m4/gnulib-comp.m4
\
$(top_srcdir)
/m4/gnulib-comp.m4
$(top_srcdir)
/m4/gtk-doc.m4
\
$(top_srcdir)
/m4/include_next.m4
\
$(top_srcdir)
/m4/lib-ignore.m4
$(top_srcdir)
/m4/memchr.m4
\
$(top_srcdir)
/m4/mmap-anon.m4
$(top_srcdir)
/m4/onceonly.m4
\
...
...
@@ -421,6 +421,9 @@ GNULIB_STRVERSCMP = @GNULIB_STRVERSCMP@
GREP
=
@GREP@
GSL_CFLAGS
=
@GSL_CFLAGS@
GSL_LIBS
=
@GSL_LIBS@
GTKDOC_CHECK
=
@GTKDOC_CHECK@
GTKDOC_MKPDF
=
@GTKDOC_MKPDF@
GTKDOC_REBASE
=
@GTKDOC_REBASE@
GTK_CFLAGS
=
@GTK_CFLAGS@
GTK_LIBS
=
@GTK_LIBS@
HAVE_DECL_MEMMEM
=
@HAVE_DECL_MEMMEM@
...
...
@@ -443,6 +446,7 @@ HAVE_STRPBRK = @HAVE_STRPBRK@
HAVE_STRSEP
=
@HAVE_STRSEP@
HAVE_STRVERSCMP
=
@HAVE_STRVERSCMP@
HAVE_WCHAR_T
=
@HAVE_WCHAR_T@
HTML_DIR
=
@HTML_DIR@
IGNORE_UNUSED_LIBRARIES_CFLAGS
=
@IGNORE_UNUSED_LIBRARIES_CFLAGS@
INCLUDE_NEXT
=
@INCLUDE_NEXT@
INCLUDE_NEXT_AS_FIRST_DIRECTIVE
=
@INCLUDE_NEXT_AS_FIRST_DIRECTIVE@
...
...
@@ -581,7 +585,7 @@ EXTRA_DIST = configure m4/gnulib-cache.m4 src/cell.h src/hdf5-file.h \
scripts/observed-peak-rate scripts/cell-please
\
scripts/check-hkl-completeness.gp scripts/check-hkl-quality.gp
\
scripts/compare-hkl.gp scripts/check-peak-detection
SUBDIRS
=
lib
SUBDIRS
=
lib
doc/reference
ACLOCAL_AMFLAGS
=
-I
m4
AM_CFLAGS
=
-Wall
AM_CPPFLAGS
=
-DDATADIR
=
\"
"
$(datadir)
"
\"
-I
$(top_builddir)
/lib
-I
$(top_srcdir)
/lib
...
...
@@ -685,6 +689,7 @@ script_DATA = scripts/check-near-bragg scripts/double-hit \
scripts/check-hkl-completeness.gp scripts/check-hkl-quality.gp
\
scripts/compare-hkl.gp scripts/check-peak-detection
DISTCHECK_CONFIGURE_FLAGS
=
--enable-gtk-doc
all
:
config.h
$(MAKE)
$(AM_MAKEFLAGS)
all-recursive
...
...
aclocal.m4
View file @
cf481c5e
...
...
@@ -1382,6 +1382,7 @@ m4_include([m4/00gnulib.m4])
m4_include([m4/extensions.m4])
m4_include([m4/gnulib-common.m4])
m4_include([m4/gnulib-comp.m4])
m4_include([m4/gtk-doc.m4])
m4_include([m4/include_next.m4])
m4_include([m4/lib-ignore.m4])
m4_include([m4/memchr.m4])
...
...
autogen.sh
View file @
cf481c5e
...
...
@@ -4,3 +4,4 @@ aclocal -I m4
autoconf
autoheader
automake
-ac
gtkdocize
--copy
||
exit
1
configure
View file @
cf481c5e
...
...
@@ -602,6 +602,20 @@ gl_LIBOBJS
am__EXEEXT_FALSE
am__EXEEXT_TRUE
LTLIBOBJS
GTK_DOC_USE_REBASE_FALSE
GTK_DOC_USE_REBASE_TRUE
GTK_DOC_USE_LIBTOOL_FALSE
GTK_DOC_USE_LIBTOOL_TRUE
GTK_DOC_BUILD_PDF_FALSE
GTK_DOC_BUILD_PDF_TRUE
GTK_DOC_BUILD_HTML_FALSE
GTK_DOC_BUILD_HTML_TRUE
ENABLE_GTK_DOC_FALSE
ENABLE_GTK_DOC_TRUE
HTML_DIR
GTKDOC_MKPDF
GTKDOC_REBASE
GTKDOC_CHECK
BUILD_CUBEIT_FALSE
BUILD_CUBEIT_TRUE
BUILD_HDFSEE_FALSE
...
...
@@ -817,6 +831,10 @@ enable_tiff
with_libtiff
enable_cairo
enable_gdk_pixbuf
with_html_dir
enable_gtk_doc
enable_gtk_doc_html
enable_gtk_doc_pdf
'
ac_precious_vars
=
'build_alias
host_alias
...
...
@@ -1471,6 +1489,9 @@ Optional Features:
--disable-tiff Disable the use of libTIFF
--disable-cairo Disable the use of Cairo
--disable-gdk-pixbuf Disable the use of gtk-pixbuf
--enable-gtk-doc use gtk-doc to build documentation [[default=no]]
--enable-gtk-doc-html build documentation in html format [[default=yes]]
--enable-gtk-doc-pdf build documentation in pdf format [[default=no]]
Optional Packages:
--with-PACKAGE[=ARG] use PACKAGE [ARG=yes]
...
...
@@ -1480,6 +1501,7 @@ Optional Packages:
pkg-config)
--with-opencl Use OpenCL
--with-libtiff specify location of libTIFF library
--with-html-dir=PATH path to installed docs
Some influential environment variables:
CC C compiler command
...
...
@@ -7557,7 +7579,237 @@ LIBS="$LIBS $LIBTIFF_LIBS $libPNG_LIBS $Cairo_LIBS $GDK_pixbuf_LIBS"
LIBS
=
"
$LIBS
$GDK_pixbuf_2_LIBS
$LDFLAGS
"
ac_config_files
=
"
$ac_config_files
Makefile lib/Makefile"
# Extract the first word of "gtkdoc-check", so it can be a program name with args.
set
dummy gtkdoc-check
;
ac_word
=
$2
{
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
: checking for
$ac_word
"
>
&5
$as_echo_n
"checking for
$ac_word
... "
>
&6
;
}
if
test
"
${
ac_cv_path_GTKDOC_CHECK
+set
}
"
=
set
;
then
:
$as_echo_n
"(cached) "
>
&6
else
case
$GTKDOC_CHECK
in
[
\\
/]
*
|
?:[
\\
/]
*
)
ac_cv_path_GTKDOC_CHECK
=
"
$GTKDOC_CHECK
"
# Let the user override the test with a path.
;;
*
)
as_save_IFS
=
$IFS
;
IFS
=
$PATH_SEPARATOR
for
as_dir
in
$PATH
do
IFS
=
$as_save_IFS
test
-z
"
$as_dir
"
&&
as_dir
=
.
for
ac_exec_ext
in
''
$ac_executable_extensions
;
do
if
{
test
-f
"
$as_dir
/
$ac_word$ac_exec_ext
"
&&
$as_test_x
"
$as_dir
/
$ac_word$ac_exec_ext
"
;
}
;
then
ac_cv_path_GTKDOC_CHECK
=
"
$as_dir
/
$ac_word$ac_exec_ext
"
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
: found
$as_dir
/
$ac_word$ac_exec_ext
"
>
&5
break
2
fi
done
done
IFS
=
$as_save_IFS
;;
esac
fi
GTKDOC_CHECK
=
$ac_cv_path_GTKDOC_CHECK
if
test
-n
"
$GTKDOC_CHECK
"
;
then
{
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
: result:
$GTKDOC_CHECK
"
>
&5
$as_echo
"
$GTKDOC_CHECK
"
>
&6
;
}
else
{
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
: result: no"
>
&5
$as_echo
"no"
>
&6
;
}
fi
for
ac_prog
in
gtkdoc-rebase
do
# Extract the first word of "$ac_prog", so it can be a program name with args.
set
dummy
$ac_prog
;
ac_word
=
$2
{
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
: checking for
$ac_word
"
>
&5
$as_echo_n
"checking for
$ac_word
... "
>
&6
;
}
if
test
"
${
ac_cv_path_GTKDOC_REBASE
+set
}
"
=
set
;
then
:
$as_echo_n
"(cached) "
>
&6
else
case
$GTKDOC_REBASE
in
[
\\
/]
*
|
?:[
\\
/]
*
)
ac_cv_path_GTKDOC_REBASE
=
"
$GTKDOC_REBASE
"
# Let the user override the test with a path.
;;
*
)
as_save_IFS
=
$IFS
;
IFS
=
$PATH_SEPARATOR
for
as_dir
in
$PATH
do
IFS
=
$as_save_IFS
test
-z
"
$as_dir
"
&&
as_dir
=
.
for
ac_exec_ext
in
''
$ac_executable_extensions
;
do
if
{
test
-f
"
$as_dir
/
$ac_word$ac_exec_ext
"
&&
$as_test_x
"
$as_dir
/
$ac_word$ac_exec_ext
"
;
}
;
then
ac_cv_path_GTKDOC_REBASE
=
"
$as_dir
/
$ac_word$ac_exec_ext
"
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
: found
$as_dir
/
$ac_word$ac_exec_ext
"
>
&5
break
2
fi
done
done
IFS
=
$as_save_IFS
;;
esac
fi
GTKDOC_REBASE
=
$ac_cv_path_GTKDOC_REBASE
if
test
-n
"
$GTKDOC_REBASE
"
;
then
{
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
: result:
$GTKDOC_REBASE
"
>
&5
$as_echo
"
$GTKDOC_REBASE
"
>
&6
;
}
else
{
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
: result: no"
>
&5
$as_echo
"no"
>
&6
;
}
fi
test
-n
"
$GTKDOC_REBASE
"
&&
break
done
test
-n
"
$GTKDOC_REBASE
"
||
GTKDOC_REBASE
=
"true"
# Extract the first word of "gtkdoc-mkpdf", so it can be a program name with args.
set
dummy gtkdoc-mkpdf
;
ac_word
=
$2
{
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
: checking for
$ac_word
"
>
&5
$as_echo_n
"checking for
$ac_word
... "
>
&6
;
}
if
test
"
${
ac_cv_path_GTKDOC_MKPDF
+set
}
"
=
set
;
then
:
$as_echo_n
"(cached) "
>
&6
else
case
$GTKDOC_MKPDF
in
[
\\
/]
*
|
?:[
\\
/]
*
)
ac_cv_path_GTKDOC_MKPDF
=
"
$GTKDOC_MKPDF
"
# Let the user override the test with a path.
;;
*
)
as_save_IFS
=
$IFS
;
IFS
=
$PATH_SEPARATOR
for
as_dir
in
$PATH
do
IFS
=
$as_save_IFS
test
-z
"
$as_dir
"
&&
as_dir
=
.
for
ac_exec_ext
in
''
$ac_executable_extensions
;
do
if
{
test
-f
"
$as_dir
/
$ac_word$ac_exec_ext
"
&&
$as_test_x
"
$as_dir
/
$ac_word$ac_exec_ext
"
;
}
;
then
ac_cv_path_GTKDOC_MKPDF
=
"
$as_dir
/
$ac_word$ac_exec_ext
"
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
: found
$as_dir
/
$ac_word$ac_exec_ext
"
>
&5
break
2
fi
done
done
IFS
=
$as_save_IFS
;;
esac
fi
GTKDOC_MKPDF
=
$ac_cv_path_GTKDOC_MKPDF
if
test
-n
"
$GTKDOC_MKPDF
"
;
then
{
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
: result:
$GTKDOC_MKPDF
"
>
&5
$as_echo
"
$GTKDOC_MKPDF
"
>
&6
;
}
else
{
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
: result: no"
>
&5
$as_echo
"no"
>
&6
;
}
fi
# Check whether --with-html-dir was given.
if
test
"
${
with_html_dir
+set
}
"
=
set
;
then
:
withval
=
$with_html_dir
;
else
with_html_dir
=
'${datadir}/gtk-doc/html'
fi
HTML_DIR
=
"
$with_html_dir
"
# Check whether --enable-gtk-doc was given.
if
test
"
${
enable_gtk_doc
+set
}
"
=
set
;
then
:
enableval
=
$enable_gtk_doc
;
else
enable_gtk_doc
=
no
fi
if
test
x
$enable_gtk_doc
=
xyes
;
then
if
test
-n
"
$PKG_CONFIG
"
&&
\
{
{
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
:
\$
PKG_CONFIG --exists --print-errors
\"
gtk-doc >= 1.14
\"
"
;
}
>
&5
(
$PKG_CONFIG
--exists
--print-errors
"gtk-doc >= 1.14"
)
2>&5
ac_status
=
$?
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
:
\$
? =
$ac_status
"
>
&5
test
$ac_status
=
0
;
}
;
then
:
else
as_fn_error
$?
"You need to have gtk-doc >= 1.14 installed to build
$PACKAGE_NAME
"
"
$LINENO
"
5
fi
fi
{
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
: checking whether to build gtk-doc documentation"
>
&5
$as_echo_n
"checking whether to build gtk-doc documentation... "
>
&6
;
}
{
$as_echo
"
$as_me
:
${
as_lineno
-
$LINENO
}
: result:
$enable_gtk_doc
"
>
&5
$as_echo
"
$enable_gtk_doc
"
>
&6
;
}
# Check whether --enable-gtk-doc-html was given.
if
test
"
${
enable_gtk_doc_html
+set
}
"
=
set
;
then
:
enableval
=
$enable_gtk_doc_html
;
else
enable_gtk_doc_html
=
yes
fi
# Check whether --enable-gtk-doc-pdf was given.
if
test
"
${
enable_gtk_doc_pdf
+set
}
"
=
set
;
then
:
enableval
=
$enable_gtk_doc_pdf
;
else
enable_gtk_doc_pdf
=
no
fi
if
test
-z
"
$GTKDOC_MKPDF
"
;
then
enable_gtk_doc_pdf
=
no
fi
if
test
x
$enable_gtk_doc
=
xyes
;
then
ENABLE_GTK_DOC_TRUE
=
ENABLE_GTK_DOC_FALSE
=
'#'
else
ENABLE_GTK_DOC_TRUE
=
'#'
ENABLE_GTK_DOC_FALSE
=
fi
if
test
x
$enable_gtk_doc_html
=
xyes
;
then
GTK_DOC_BUILD_HTML_TRUE
=
GTK_DOC_BUILD_HTML_FALSE
=
'#'
else
GTK_DOC_BUILD_HTML_TRUE
=
'#'
GTK_DOC_BUILD_HTML_FALSE
=
fi
if
test
x
$enable_gtk_doc_pdf
=
xyes
;
then
GTK_DOC_BUILD_PDF_TRUE
=
GTK_DOC_BUILD_PDF_FALSE
=
'#'
else
GTK_DOC_BUILD_PDF_TRUE
=
'#'
GTK_DOC_BUILD_PDF_FALSE
=
fi
if
test
-n
"
$LIBTOOL
"
;
then
GTK_DOC_USE_LIBTOOL_TRUE
=
GTK_DOC_USE_LIBTOOL_FALSE
=
'#'
else
GTK_DOC_USE_LIBTOOL_TRUE
=
'#'
GTK_DOC_USE_LIBTOOL_FALSE
=
fi
if
test
-n
"
$GTKDOC_REBASE
"
;
then
GTK_DOC_USE_REBASE_TRUE
=
GTK_DOC_USE_REBASE_FALSE
=
'#'
else
GTK_DOC_USE_REBASE_TRUE
=
'#'
GTK_DOC_USE_REBASE_FALSE
=
fi
ac_config_files
=
"
$ac_config_files
Makefile lib/Makefile doc/reference/Makefile"
cat
>
confcache
<<
\
_ACEOF
# This file is a shell script that caches the results of configure
...
...
@@ -7721,6 +7973,26 @@ if test -z "${BUILD_CUBEIT_TRUE}" && test -z "${BUILD_CUBEIT_FALSE}"; then
as_fn_error
$?
"conditional
\"
BUILD_CUBEIT
\"
was never defined.
Usually this means the macro was only invoked conditionally."
"
$LINENO
"
5
fi
if
test
-z
"
${
ENABLE_GTK_DOC_TRUE
}
"
&&
test
-z
"
${
ENABLE_GTK_DOC_FALSE
}
"
;
then
as_fn_error
$?
"conditional
\"
ENABLE_GTK_DOC
\"
was never defined.
Usually this means the macro was only invoked conditionally."
"
$LINENO
"
5
fi
if
test
-z
"
${
GTK_DOC_BUILD_HTML_TRUE
}
"
&&
test
-z
"
${
GTK_DOC_BUILD_HTML_FALSE
}
"
;
then
as_fn_error
$?
"conditional
\"
GTK_DOC_BUILD_HTML
\"
was never defined.
Usually this means the macro was only invoked conditionally."
"
$LINENO
"
5
fi
if
test
-z
"
${
GTK_DOC_BUILD_PDF_TRUE
}
"
&&
test
-z
"
${
GTK_DOC_BUILD_PDF_FALSE
}
"
;
then
as_fn_error
$?
"conditional
\"
GTK_DOC_BUILD_PDF
\"
was never defined.
Usually this means the macro was only invoked conditionally."
"
$LINENO
"
5
fi
if
test
-z
"
${
GTK_DOC_USE_LIBTOOL_TRUE
}
"
&&
test
-z
"
${
GTK_DOC_USE_LIBTOOL_FALSE
}
"
;
then
as_fn_error
$?
"conditional
\"
GTK_DOC_USE_LIBTOOL
\"
was never defined.
Usually this means the macro was only invoked conditionally."
"
$LINENO
"
5
fi
if
test
-z
"
${
GTK_DOC_USE_REBASE_TRUE
}
"
&&
test
-z
"
${
GTK_DOC_USE_REBASE_FALSE
}
"
;
then
as_fn_error
$?
"conditional
\"
GTK_DOC_USE_REBASE
\"
was never defined.
Usually this means the macro was only invoked conditionally."
"
$LINENO
"
5
fi
:
${
CONFIG_STATUS
=./config.status
}
ac_write_fail
=
0
...
...
@@ -8322,6 +8594,7 @@ do
"depfiles") CONFIG_COMMANDS="
$CONFIG_COMMANDS
depfiles" ;;
"Makefile") CONFIG_FILES="
$CONFIG_FILES
Makefile" ;;
"lib/Makefile") CONFIG_FILES="
$CONFIG_FILES
lib/Makefile" ;;
"doc/reference/Makefile") CONFIG_FILES="
$CONFIG_FILES
doc/reference/Makefile" ;;
*) as_fn_error
$?
"invalid argument:
\`
$ac_config_target
'" "
$LINENO
" 5;;
esac
...
...
configure.ac
View file @
cf481c5e
...
...
@@ -241,5 +241,9 @@ LIBS="$LIBS $LIBTIFF_LIBS $libPNG_LIBS $Cairo_LIBS $GDK_pixbuf_LIBS"
LIBS="$LIBS $GDK_pixbuf_2_LIBS $LDFLAGS"
AC_CONFIG_FILES(Makefile lib/Makefile)
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
AC_CONFIG_MACRO_DIR(m4)
AC_CONFIG_FILES(Makefile lib/Makefile doc/reference/Makefile)
AC_OUTPUT
doc/reference/CrystFEL-docs.sgml
0 → 100644
View file @
cf481c5e
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"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'">
]>
<book
id=
"index"
>
<bookinfo>
<title>
CrystFEL Reference Manual
</title>
<releaseinfo>
For CrystFEL 0.2.0.
</releaseinfo>
This is the internal documentation for CrystFEL. Unless you are looking at
the code, writing new programs or fixing bugs, you should not need to read
this.
</bookinfo>
<chapter>
<title>
Images
</title>
<xi:include
href=
"xml/image.xml"
/>
</chapter>
<chapter>
<title>
Handling reflection data
</title>
<xi:include
href=
"xml/reflist.xml"
/>
<xi:include
href=
"xml/reflitemlist.xml"
/>
</chapter>
<chapter>
<title>
Miscellaneous
</title>
<xi:include
href=
"xml/quaternion.xml"
/>
<xi:include
href=
"xml/utils.xml"
/>
</chapter>
<index
id=
"api-index-full"
>
<title>
API Index
</title>
<xi:include
href=
"xml/api-index-full.xml"
><xi:fallback
/></xi:include>
</index>
</book>
doc/reference/CrystFEL-sections.txt
0 → 100644
View file @
cf481c5e
<SECTION>
<FILE>reflist</FILE>
RefList
Reflection
<SUBSECTION>
reflist_new
reflist_free
<SUBSECTION>
find_refl
next_found_refl
optimise_reflist
<SUBSECTION>
get_excitation_error
get_detector_pos
get_indices
get_partiality
get_intensity
get_partial
</SECTION>
<SECTION>
<FILE>reflitemlist</FILE>
ReflItemList
<SUBSECTION>
new_items
</SECTION>
<SECTION>
<FILE>utils</FILE>
show_matrix_eqn
</SECTION>
<SECTION>
<FILE>quaternion</FILE>
quaternion
</SECTION>
<SECTION>
<FILE>image</FILE>
image
</SECTION>
doc/reference/Makefile.am
0 → 100644
View file @
cf481c5e
## Process this file with automake to produce Makefile.in
# We require automake 1.6 at least.
AUTOMAKE_OPTIONS
=
1.6
# This is a blank Makefile.am for using gtk-doc.
# Copy this to your project's API docs directory and modify the variables to
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
# of using the various options.
# The name of the module, e.g. 'glib'.
DOC_MODULE
=
CrystFEL
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
#DOC_MODULE_VERSION=2
# The top-level SGML file. You can change this if you want to.
DOC_MAIN_SGML_FILE
=
$(DOC_MODULE)
-docs
.sgml
# Directories containing the source code, relative to $(srcdir).
# gtk-doc will search all .c and .h files beneath these paths
# for inline comments documenting functions and macros.
# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk
DOC_SOURCE_DIR
=
../../src
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
SCANGOBJ_OPTIONS
=
# Extra options to supply to gtkdoc-scan.
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
SCAN_OPTIONS
=
# Extra options to supply to gtkdoc-mkdb.
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
MKDB_OPTIONS
=
--sgml-mode
--output-format
=
xml
# Extra options to supply to gtkdoc-mktmpl
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
MKTMPL_OPTIONS
=
# Extra options to supply to gtkdoc-mkhtml
MKHTML_OPTIONS
=
# Extra options to supply to gtkdoc-fixref. Not normally needed.
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
FIXXREF_OPTIONS
=
# Used for dependencies. The docs will be rebuilt if any of these change.
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
HFILE_GLOB
=
$(top_srcdir)
/src/
*
.h
CFILE_GLOB
=
$(top_srcdir)
/src/
*
.c
# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
EXTRA_HFILES
=
# Header files to ignore when scanning. Use base file name, no paths
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES
=
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
HTML_IMAGES
=
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
content_files
=
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
expand_content_files
=
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
# signals and properties.
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
GTKDOC_CFLAGS
=
GTKDOC_LIBS
=
# This includes the standard gtk-doc make rules, copied by gtkdocize.
include
$(top_srcdir)/gtk-doc.make
# Other files to distribute
# e.g. EXTRA_DIST += version.xml.in
EXTRA_DIST
+=
# Files not to distribute
# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
#DISTCLEANFILES +=
# Comment this out if you want your docs-status tested during 'make check'
if
ENABLE_GTK_DOC
TESTS_ENVIRONMENT
=
cd
$(srcsrc)
&&
TESTS
=
$(GTKDOC_CHECK)
endif
-include
$(top_srcdir)/git.mk
doc/reference/Makefile.in
0 → 100644
View file @
cf481c5e
This diff is collapsed.
Click to expand it.
gtk-doc.make
0 → 100644
View file @
cf481c5e
# -*- mode: makefile -*-
####################################
# Everything below here is generic #
####################################
if
GTK_DOC_USE_LIBTOOL
GTKDOC_CC
=
$(LIBTOOL)
--tag
=
CC
--mode
=
compile
$(CC)
$(INCLUDES)
$(AM_CPPFLAGS)
$(CPPFLAGS)
$(AM_CFLAGS)
$(CFLAGS)
GTKDOC_LD
=
$(LIBTOOL)
--tag
=
CC
--mode
=
link
$(CC)
$(AM_CFLAGS)
$(CFLAGS)
$(AM_LDFLAGS)
$(LDFLAGS)
GTKDOC_RUN
=
$(LIBTOOL)
--mode
=
execute
else
GTKDOC_CC
=
$(CC)
$(INCLUDES)
$(AM_CPPFLAGS)
$(CPPFLAGS)
$(AM_CFLAGS)
$(CFLAGS)
GTKDOC_LD
=
$(CC)
$(AM_CFLAGS)
$(CFLAGS)
$(AM_LDFLAGS)
$(LDFLAGS)
GTKDOC_RUN
=