openmpi/src/mpi/README.dox

/*
 * $HEADER$
 */

/**

@page page_mpi The src/mpi directory

@section page_mpi_introduction Introduction

This is the introduction.
This is the introduction.
This is the introduction.
This is the introduction.
This is the introduction.
This is the introduction.
This is the introduction.

*/
- Fix broken $HEADER$ lines - Add $HEADER$ lines to files that didn't have them - Add placeholder LICENSE file This commit was SVN r3654. 2004-11-22 00:37:56 +00:00			`/*`
			`* $HEADER$`
			`*/`

Changing Doxyfile so that doxygen will scan files matching the pattern *.dox. Also adding files src/README.dox indicating how to add documentation to the "main page", and src/mpi/README.dox as an example of adding a page of supplementary information. Don't know if there is a "standard" way of doing this, but it seems to work, and saves us having to stuff too much detail into real source files. This commit was SVN r964. 2004-03-26 02:25:41 +00:00			`/**`

			`@page page_mpi The src/mpi directory`

			`@section page_mpi_introduction Introduction`

			`This is the introduction.`
			`This is the introduction.`
			`This is the introduction.`
			`This is the introduction.`
			`This is the introduction.`
			`This is the introduction.`
			`This is the introduction.`

			`*/`