2004-07-23 Joerg Wunsch * doc/api/Makefile.am: rearrange demos into their own group. * doc/examples/demo/demo.dox: (Ditto) * doc/examples/twitest/twitest.dox: (Ditto) * doc/api/doxygen.config.in: include doc/examples in INPUT. * doc/examples/all-demos.dox: [new] Summary page for the demos. Index: doc/api/Makefile.am =================================================================== RCS file: /cvsroot/avr-libc/avr-libc/doc/api/Makefile.am,v retrieving revision 1.38 diff -u -u -r1.38 Makefile.am --- doc/api/Makefile.am 30 Sep 2003 23:05:16 -0000 1.38 +++ doc/api/Makefile.am 23 Jul 2004 21:18:29 -0000 @@ -180,8 +180,8 @@ mv -f tmp.$$ using_tools.tex cd latex_pdf_src && \ sed -e '/{demo.eps}/s/demo.eps/demo.pdf/' \ - demo_project.tex > tmp.$$ && \ - mv -f tmp.$$ demo_project.tex + group__demo__project.tex > tmp.$$ && \ + mv -f tmp.$$ group__demo__project.tex doxygen-pdf.config: doxygen.config sed \ Index: doc/api/doxygen.config.in =================================================================== RCS file: /cvsroot/avr-libc/avr-libc/doc/api/doxygen.config.in,v retrieving revision 1.11 diff -u -u -r1.11 doxygen.config.in --- doc/api/doxygen.config.in 30 Sep 2003 23:05:17 -0000 1.11 +++ doc/api/doxygen.config.in 23 Jul 2004 21:18:31 -0000 @@ -371,6 +371,7 @@ @top_srcdir@/libc \ @top_srcdir@/libm \ @top_srcdir@/doc/api \ + @top_srcdir@/doc/examples \ @top_srcdir@/doc/examples/demo \ @top_srcdir@/doc/examples/twitest Index: doc/examples/demo/demo.dox =================================================================== RCS file: /cvsroot/avr-libc/avr-libc/doc/examples/demo/demo.dox,v retrieving revision 1.8 diff -u -u -r1.8 demo.dox --- doc/examples/demo/demo.dox 30 Sep 2003 23:05:17 -0000 1.8 +++ doc/examples/demo/demo.dox 23 Jul 2004 21:18:32 -0000 @@ -25,7 +25,8 @@ /* $Id: demo.dox,v 1.8 2003/09/30 23:05:17 troth Exp $ */ -/** \page demo_project A simple project +/** \defgroup demo_project A simple project + \ingroup demos At this point, you should have the GNU tools configured, built, and installed on your system. In this chapter, we present a simple example of using the GNU Index: doc/examples/twitest/twitest.dox =================================================================== RCS file: /cvsroot/avr-libc/avr-libc/doc/examples/twitest/twitest.dox,v retrieving revision 1.3 diff -u -u -r1.3 twitest.dox --- doc/examples/twitest/twitest.dox 22 Feb 2004 20:09:29 -0000 1.3 +++ doc/examples/twitest/twitest.dox 23 Jul 2004 21:18:32 -0000 @@ -25,7 +25,8 @@ /* $Id: twitest.dox,v 1.3 2004/02/22 20:09:29 joerg_wunsch Exp $ */ -/** \page twi_demo Example using the two-wire interface (TWI) +/** \defgroup twi_demo Example using the two-wire interface (TWI) + \ingroup demos Some newer devices of the ATmega series contain builtin support for interfacing the microcontroller to a two-wire bus, called TWI. This --- /dev/null Fri Jul 23 23:14:09 2004 +++ doc/examples/all-demos.dox Fri Jul 23 23:14:04 2004 @@ -0,0 +1,47 @@ +/* Copyright (c) 2004, Joerg Wunsch + 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$ */ + +/** \defgroup demos Demo projects + + Various small demo projects are provided to illustrate several + aspects of using the opensource utilities for the AVR controller + series. It should be kept in mind that these demos serve mainly + educational purposes, and are normally not directly suitable for use + in any production environment. Usually, they have been kept as + simple as sufficient to demonstrate one particular feature. + + The \ref demo_project "simple project" is somewhat like the "Hello + world!" application for a microcontroller, about the most simple + project that can be done. It is explained in good detail, to allow + the reader to understand the basic concepts behind using the tools + on an AVR microcontroller. + + The \ref twi_demo project explains the use of the two-wire hardware + interface (also known as "I2C") that is present on many AVR + controllers. + +*/