openmpi/src/README.dox

/** @mainpage

@section mainpage_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.

@section main_install Installation
 
This is the installation section.
This is the installation section.
This is the installation section.
This is the installation section.
This is the installation section.
This is the installation section.
This is the installation section.

*/
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 05:25:41 +03:00			`/** @mainpage`

			`@section mainpage_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.`

			`@section main_install Installation`

			`This is the installation section.`
			`This is the installation section.`
			`This is the installation section.`
			`This is the installation section.`
			`This is the installation section.`
			`This is the installation section.`
			`This is the installation section.`

			`*/`