add optional doxygen documentation generation for the genesys backend

merge-requests/1/head
Stphane Voltz 2012-11-02 21:46:44 +01:00
rodzic 2ccb383a58
commit e5b886cb76
6 zmienionych plików z 39 dodań i 14 usunięć

Wyświetl plik

@ -1,5 +1,9 @@
2012-11-02 Stéphane Voltz <stef.dev@free.fr>
* configure configure.in doc/Makefile.am doc/Makefile.in: add optional
doxygen documentation generation for genesys backend.
2012-10-31 Louis Lagendijk <louis.lagendijk at gmail dot com>
* backend/scripts/pixma_gen_options.py
* backend/scripts/pixma_gen_options.py
Updated formatting of produced files to match pixma.c formatting
without need for manual editing
* pixma.[ch] pixma_mp810.c pixma_mp150.c

Wyświetl plik

@ -202,14 +202,24 @@ typedef struct
SANE_Byte value;
} Genesys_Register_Set;
/** @brief Data structure to set up analog frontend.
* The analog frontend converts analog value from image sensor to
* digital value. It has its own control registers which are set up
* with this structure. The values are written using sanei_genesys_fe_write_data.
* The actual register addresses they map to depends on the frontend used.
* @see sanei_genesys_fe_write_data
*/
typedef struct
{
uint8_t fe_id; /**< id of the frontend description */
uint8_t reg[4];
uint8_t sign[3];
uint8_t offset[3];
uint8_t gain[3];
uint8_t reg2[3];
uint8_t fe_id; /**< id of the frontend description */
uint8_t reg[4]; /**< values to set up frontend control register, they
usually map to analog register 0x00 to 0x03 */
uint8_t sign[3]; /**< sets the sign of the digital value */
uint8_t offset[3]; /**< offset correction to apply to signal, most often
maps to frontend register 0x20-0x22 */
uint8_t gain[3]; /**< amplification to apply to signal, most often
maps to frontend register 0x28-0x2a */
uint8_t reg2[3]; /**< extra control registers */
} Genesys_Frontend;
typedef struct
@ -881,10 +891,17 @@ sanei_genesys_calculate_zmode (Genesys_Device * dev,
extern SANE_Status
sanei_genesys_set_buffer_address (Genesys_Device * dev, uint32_t addr);
/** @brief Reads data from frontend register.
* Reads data from the given frontend register. May be used to query
* analog frontend status by reading the right register.
*/
extern SANE_Status
sanei_genesys_fe_read_data (Genesys_Device * dev, uint8_t addr,
uint16_t *data);
/** @brief Write data to frontend register.
* Writes data to analog frontend register at the given address.
* The use and address of registers change from model to model.
*/
extern SANE_Status
sanei_genesys_fe_write_data (Genesys_Device * dev, uint8_t addr,
uint16_t data);

3
configure vendored
Wyświetl plik

@ -18080,7 +18080,7 @@ fi
DISTCLEAN_FILES="*~ .*~ *.log *.bak *.old *.orig *.out *.rej \"\#\"* \".\\#\"*"
ac_config_files="$ac_config_files Makefile lib/Makefile sanei/Makefile frontend/Makefile japi/Makefile backend/Makefile include/Makefile doc/Makefile po/Makefile testsuite/Makefile tools/Makefile doc/doxygen-sanei.conf"
ac_config_files="$ac_config_files Makefile lib/Makefile sanei/Makefile frontend/Makefile japi/Makefile backend/Makefile include/Makefile doc/Makefile po/Makefile testsuite/Makefile tools/Makefile doc/doxygen-sanei.conf doc/doxygen-genesys.conf"
ac_config_files="$ac_config_files tools/sane-config"
@ -19154,6 +19154,7 @@ do
"testsuite/Makefile") CONFIG_FILES="$CONFIG_FILES testsuite/Makefile" ;;
"tools/Makefile") CONFIG_FILES="$CONFIG_FILES tools/Makefile" ;;
"doc/doxygen-sanei.conf") CONFIG_FILES="$CONFIG_FILES doc/doxygen-sanei.conf" ;;
"doc/doxygen-genesys.conf") CONFIG_FILES="$CONFIG_FILES doc/doxygen-genesys.conf" ;;
"tools/sane-config") CONFIG_FILES="$CONFIG_FILES tools/sane-config" ;;
"tools/sane-backends.pc") CONFIG_FILES="$CONFIG_FILES tools/sane-backends.pc" ;;

Wyświetl plik

@ -759,7 +759,7 @@ AC_SUBST(DISTCLEAN_FILES)
AC_CONFIG_FILES([Makefile lib/Makefile sanei/Makefile frontend/Makefile \
japi/Makefile backend/Makefile include/Makefile doc/Makefile \
po/Makefile testsuite/Makefile tools/Makefile doc/doxygen-sanei.conf])
po/Makefile testsuite/Makefile tools/Makefile doc/doxygen-sanei.conf doc/doxygen-genesys.conf])
AC_CONFIG_FILES([tools/sane-config], [chmod a+x tools/sane-config])
AC_CONFIG_FILES([tools/sane-backends.pc])
AC_OUTPUT

Wyświetl plik

@ -307,7 +307,7 @@ distclean-local:
rm -f sane.dvi sane.ps sane-backends.html sane-backends-external.html
rm -f sane-mfgs.html sane-mfgs-external.html
rm -f sane/*.html sane/*.gif
rm -f doxygen-sanei.conf
rm -f doxygen-sanei.conf doxygen-genesys.conf
-rm -rf sane sanei-html
for manpage in $(MANPAGES) ; do \
rm -f $${manpage}.html ; \

Wyświetl plik

@ -37,7 +37,8 @@ host_triplet = @host@
subdir = doc
DIST_COMMON = $(dist_doc_DATA) $(nobase_dist_doc_DATA) \
$(srcdir)/Makefile.am $(srcdir)/Makefile.in \
$(srcdir)/doxygen-sanei.conf.in
$(srcdir)/doxygen-sanei.conf.in \
$(srcdir)/doxygen-genesys.conf.in
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/acinclude.m4 \
$(top_srcdir)/m4/libtool.m4 $(top_srcdir)/m4/byteorder.m4 \
@ -46,7 +47,7 @@ am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs
CONFIG_HEADER = $(top_builddir)/include/sane/config.h
CONFIG_CLEAN_FILES = doxygen-sanei.conf
CONFIG_CLEAN_FILES = doxygen-sanei.conf doxygen-genesys.conf
CONFIG_CLEAN_VPATH_FILES =
SOURCES =
DIST_SOURCES =
@ -461,6 +462,8 @@ $(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps)
$(am__aclocal_m4_deps):
doxygen-sanei.conf: $(top_builddir)/config.status $(srcdir)/doxygen-sanei.conf.in
cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@
doxygen-genesys.conf: $(top_builddir)/config.status $(srcdir)/doxygen-genesys.conf.in
cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@
mostlyclean-libtool:
-rm -f *.lo
@ -905,7 +908,7 @@ distclean-local:
rm -f sane.dvi sane.ps sane-backends.html sane-backends-external.html
rm -f sane-mfgs.html sane-mfgs-external.html
rm -f sane/*.html sane/*.gif
rm -f doxygen-sanei.conf
rm -f doxygen-sanei.conf doxygen-genesys.conf
-rm -rf sane sanei-html
for manpage in $(MANPAGES) ; do \
rm -f $${manpage}.html ; \