2002-07-16 Theodore A. Roth * doc/api/doxygen.config.in: Config tweaks to simplify output and to handle '.dox' files * doc/api/main_page.dox: New file. * include/inttypes.h: Add doxygen comments. * include/avr/signal.h: Add doxygen comments. Index: doc/api/doxygen.config.in =================================================================== RCS file: /cvsroot/avr-libc/avr-libc/doc/api/doxygen.config.in,v retrieving revision 1.1 diff -u -r1.1 doxygen.config.in --- doc/api/doxygen.config.in 16 Jul 2002 20:11:37 -0000 1.1 +++ doc/api/doxygen.config.in 16 Jul 2002 22:53:57 -0000 @@ -322,7 +322,7 @@ # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @top_srcdir@/include @top_srcdir@/libc @top_srcdir@/libm +INPUT = @top_srcdir@/include @top_srcdir@/libc @top_srcdir@/libm @top_srcdir@/doc/api # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -331,7 +331,7 @@ # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp # *.h++ *.idl *.odl -FILE_PATTERNS = *.c *.h +FILE_PATTERNS = *.c *.h *.dox # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. @@ -404,7 +404,7 @@ # If the SOURCE_BROWSER tag is set to YES then a list of source files will # be generated. Documented entities will be cross-referenced with these sources. -SOURCE_BROWSER = YES +SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. @@ -415,13 +415,13 @@ # then for each documented function all documented # functions referencing it will be listed. -REFERENCED_BY_RELATION = YES +REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES (the default) # then for each documented function all documented entities # called/used by that function will be listed. -REFERENCES_RELATION = YES +REFERENCES_RELATION = NO #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index @@ -520,7 +520,7 @@ # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. -DISABLE_INDEX = NO +DISABLE_INDEX = YES # This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. Index: doc/api/main_page.dox =================================================================== RCS file: doc/api/main_page.dox diff -N doc/api/main_page.dox --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ doc/api/main_page.dox 16 Jul 2002 22:53:57 -0000 @@ -0,0 +1,37 @@ +/* Copyright (c) 2002, Theodore Roth + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + POSSIBILITY OF SUCH DAMAGE. */ + +/* $Id$ */ + +/** \mainpage AVR Libc + +The AVR Libc package provides a subset of the standard C library for Atmel AVR +8-bit RISC microcontrollers.......... + +There's a lot of work to be done on this. This file will produce the +index.html (for html output) or the first chapter (in \f$\mbox{\LaTeX}\f$ +output). + +*/ Index: include/inttypes.h =================================================================== RCS file: /cvsroot/avr-libc/avr-libc/include/inttypes.h,v retrieving revision 1.1 diff -u -r1.1 inttypes.h --- include/inttypes.h 5 Jul 2002 20:38:44 -0000 1.1 +++ include/inttypes.h 16 Jul 2002 22:53:57 -0000 @@ -33,8 +33,15 @@ #ifndef __INTTYPES_H_ #define __INTTYPES_H_ -/* Use [u]intN_t if you need exactly N bits. - XXX - doesn't handle the -mint8 option. */ +/** \defgroup inttypes Integer Types + \code #include \endcode + + Use [u]intN_t if you need exactly N bits. + + \note These should probably not be used if avr-gcc's \c -mint8 option is + used. + + @{ */ typedef signed char int8_t; typedef unsigned char uint8_t; @@ -50,5 +57,7 @@ typedef int16_t intptr_t; typedef uint16_t uintptr_t; + +/* @} */ #endif Index: include/avr/signal.h =================================================================== RCS file: /cvsroot/avr-libc/avr-libc/include/avr/signal.h,v retrieving revision 1.1 diff -u -r1.1 signal.h --- include/avr/signal.h 5 Jul 2002 20:38:44 -0000 1.1 +++ include/avr/signal.h 16 Jul 2002 22:53:57 -0000 @@ -26,6 +26,15 @@ #ifndef _AVR_SIGNAL_H_ #define _AVR_SIGNAL_H_ +/** \defgroup signals Signals and Interrupts + \code #include \endcode + + FIXME: discuss the SIGNAL() and INTERRUPT() macros. Rich Neswold's + document has a good discussion of this. */ + +/** \def SIGNAL(signame) + \ingroup signals */ + #ifdef __cplusplus #define SIGNAL(signame) \ extern "C" void signame(void); \ @@ -36,6 +45,9 @@ void signame (void) __attribute__ ((signal)); \ void signame (void) #endif + +/** \def INTERRUPT(signame) + \ingroup signals */ #ifdef __cplusplus #define INTERRUPT(signame) \