From 5305f6f81ba739bebe86fe810b480e891b0989fb Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Sun, 24 Aug 2014 18:47:52 -0500 Subject: [PATCH] Add documentation to the manifold module. In particular, give an example of why it matters and a few code snippets and pictures that show how it works. --- doc/doxygen/headers/manifold.h | 192 +++++++++++++++++- doc/doxygen/images/hypershell-all-3.png | Bin 0 -> 15618 bytes doc/doxygen/images/hypershell-all.png | Bin 0 -> 23984 bytes .../images/hypershell-boundary-only-3.png | Bin 0 -> 17431 bytes .../images/hypershell-boundary-only-4.png | Bin 0 -> 18134 bytes .../images/hypershell-boundary-only.png | Bin 0 -> 24795 bytes doc/doxygen/images/hypershell-nothing.png | Bin 0 -> 22298 bytes 7 files changed, 182 insertions(+), 10 deletions(-) create mode 100644 doc/doxygen/images/hypershell-all-3.png create mode 100644 doc/doxygen/images/hypershell-all.png create mode 100644 doc/doxygen/images/hypershell-boundary-only-3.png create mode 100644 doc/doxygen/images/hypershell-boundary-only-4.png create mode 100644 doc/doxygen/images/hypershell-boundary-only.png create mode 100644 doc/doxygen/images/hypershell-nothing.png diff --git a/doc/doxygen/headers/manifold.h b/doc/doxygen/headers/manifold.h index cd7ac68106..84cfbe3b01 100644 --- a/doc/doxygen/headers/manifold.h +++ b/doc/doxygen/headers/manifold.h @@ -18,6 +18,8 @@ /** * @defgroup manifold Manifold description for triangulations * + *

Overview

+ * * The classes in this module are concerned with the description of the * manifold in which the domain that a Triangulation describes lives. This * manifold description is necessary in two contexts: @@ -25,12 +27,13 @@ *