Commit a8990188 authored by Andreas Marek's avatar Andreas Marek

Also document the C generic definitions

parent 817c4e2c
......@@ -790,7 +790,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = @top_srcdir@/src @top_srcdir@/test @builddir@/elpa @builddir@/config-f90.h
INPUT = @top_srcdir@/elpa/ @top_srcdir@/src @top_srcdir@/test @builddir@/elpa @builddir@/config-f90.h
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
......
#pragma once
/* \brief generic C method for elpa_set
/*! \brief generic C method for elpa_set
*
* \details
* \param handle handle of the ELPA object for which a key/value pair should be set
* \param name the name of the key
* \param value integer/double value to be set for the key
......@@ -17,8 +18,9 @@
)(e, name, value, error)
/* \brief generic C method for elpa_get
/*! \brief generic C method for elpa_get
*
* \details
* \param handle handle of the ELPA object for which a key/value pair should be queried
* \param name the name of the key
* \param value integer/double value to be queried
......@@ -34,8 +36,9 @@
)(e, name, value, error)
/* \brief generic C method for elpa_solve
/*! \brief generic C method for elpa_solve
*
* \details
* \param handle handle of the ELPA object, which defines the problem
* \param a float/double float complex/double complex pointer to matrix a
* \param ev on return: float/double pointer to eigenvalues
......@@ -59,6 +62,7 @@
/* \brief generic C method for elpa_cholesky
*
* \details
* \param handle handle of the ELPA object, which defines the problem
* \param a float/double float complex/double complex pointer to matrix a, for which
* the cholesky factorizaion will be computed
......@@ -80,8 +84,9 @@
)(handle, a, error)
/* \brief generic C method for elpa_invert_triangular
/*! \brief generic C method for elpa_invert_triangular
*
* \details
* \param handle handle of the ELPA object, which defines the problem
* \param a float/double float complex/double complex pointer to matrix a, which
* should be inverted
......@@ -103,8 +108,9 @@
)(handle, a, error)
/* \brief generic C method for elpa_solve_tridi
/*! \brief generic C method for elpa_solve_tridi
*
* \details
* \param handle handle of the ELPA object, which defines the problem
* \param d float/double pointer to the diagonal elements of a matrix a,
* on output: eigenvalues in ascending order
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment