From 3f3cb83046807ea55de229fe112682816b69cddf Mon Sep 17 00:00:00 2001 From: Henning Geinitz Date: Thu, 24 Jan 2002 20:32:38 +0000 Subject: [PATCH] Added note about doxygen configuration for sanei. Henning Meier-Geinitz --- doc/backend-writing.txt | 8 ++++++-- doc/sane.man | 9 +++++---- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/doc/backend-writing.txt b/doc/backend-writing.txt index 02430a6f1..bfc0e2fa1 100644 --- a/doc/backend-writing.txt +++ b/doc/backend-writing.txt @@ -1,4 +1,4 @@ -2002-01-10 +2002-01-24 Here are a few rules and tips that should help writing a SANE-conformant backend and including it into the SANE package: @@ -112,7 +112,11 @@ PROGRAMMING * Please use sanei functions whenever possible (e.g. sanei_config_read()). This makes porting to other os/platforms much - easier. + easier. Most of these functions are documented in their respective + header files in include/sane/sanei_*.h. For some of them there is also + documentation in doxygen format: http://sanei.meier-geinitz.de/. These + HTML pages can be generated by calling "doxygen sanei-doxygen.conf" in + the doc/ directory. * Do make sure that your code is byte-order independent. This is particularly important for networking-related code and when dealing diff --git a/doc/sane.man b/doc/sane.man index f069b2b31..5d9e9b0f6 100644 --- a/doc/sane.man +++ b/doc/sane.man @@ -1,4 +1,4 @@ -.TH sane 7 "12 Jan 2002" +.TH sane 7 "24 Jan 2002" .IX sane .SH NAME @@ -43,9 +43,10 @@ website: http://www.mostang.com/sane/html/ (HTML), or http://www.mostang.com/sane/sane.ps (Postscript). .P There is some more information for programmers in -@DOCDIR@/backend-writing.txt. Before a new backend or frontend project is -started, have a look at @DOCDIR@/PROJECTS for projects that are planned or not -yet included into the SANE distribution. +@DOCDIR@/backend-writing.txt. Some of the internal SANE routines (sanei) are +documented using doxygen: http://sanei.meier-geinitz.de/ . Before a new +backend or frontend project is started, have a look at @DOCDIR@/PROJECTS for +projects that are planned or not yet included into the SANE distribution. .P Your help is always appreciated. Look at @DOCDIR@/TODO for things that should be done. Not only programmers are needed, but also reading and fixing the