From d21a6a7be917ad02fc610def30f7821b0c8b0482 Mon Sep 17 00:00:00 2001
From: Ray Speth <speth@mit.edu>
Date: Wed, 19 Jun 2013 22:08:50 +0000
Subject: [PATCH] [Doc] Create a group for classes in the "onedim" module

---
 include/cantera/oneD/Domain1D.h    |  1 +
 include/cantera/oneD/Inlet1D.h     |  6 ++++++
 include/cantera/oneD/MultiJac.h    |  1 +
 include/cantera/oneD/MultiNewton.h |  1 +
 include/cantera/oneD/OneDim.h      |  1 +
 include/cantera/oneD/Sim1D.h       |  1 +
 include/cantera/oneD/StFlow.h      |  3 +++
 include/cantera/oneD/refine.h      |  1 +
 include/cantera/onedim.h           | 10 ++++++++++
 9 files changed, 25 insertions(+)

diff --git a/include/cantera/oneD/Domain1D.h b/include/cantera/oneD/Domain1D.h
index 9adb825a3..77e534add 100644
--- a/include/cantera/oneD/Domain1D.h
+++ b/include/cantera/oneD/Domain1D.h
@@ -32,6 +32,7 @@ class OneDim;
 
 /**
  * Base class for one-dimensional domains.
+ * @ingroup onedim
  */
 class Domain1D
 {
diff --git a/include/cantera/oneD/Inlet1D.h b/include/cantera/oneD/Inlet1D.h
index 9bbf950f0..e776ad276 100644
--- a/include/cantera/oneD/Inlet1D.h
+++ b/include/cantera/oneD/Inlet1D.h
@@ -36,6 +36,7 @@ const int RightInlet = -1;
  *
  * The public methods are all virtual, and the base class
  * implementations throw exceptions.
+ * @ingroup onedim
  */
 class Bdry1D : public Domain1D
 {
@@ -115,6 +116,7 @@ private:
 
 /**
  * An inlet.
+ * @ingroup onedim
  */
 class Inlet1D : public Bdry1D
 {
@@ -188,6 +190,7 @@ protected:
 
 /**
  * A terminator that does nothing.
+ * @ingroup onedim
  */
 class Empty1D : public Domain1D
 {
@@ -215,6 +218,7 @@ public:
 /**
  * A symmetry plane. The axial velocity u = 0, and all other
  * components have zero axial gradients.
+ * @ingroup onedim
  */
 class Symm1D : public Bdry1D
 {
@@ -272,6 +276,7 @@ public:
 
 /**
  * An outlet with specified composition.
+ * @ingroup onedim
  */
 class OutletRes1D : public Bdry1D
 {
@@ -360,6 +365,7 @@ public:
 
 /**
  * A reacting surface.
+ * @ingroup onedim
  */
 class ReactingSurf1D : public Bdry1D
 {
diff --git a/include/cantera/oneD/MultiJac.h b/include/cantera/oneD/MultiJac.h
index 5f68cb27f..d0ad579c5 100644
--- a/include/cantera/oneD/MultiJac.h
+++ b/include/cantera/oneD/MultiJac.h
@@ -21,6 +21,7 @@ namespace Cantera
  * defined by a residual function supplied by an instance of class
  * OneDim. The residual function may consist of several linked
  * 1D domains, with different variables in each domain.
+ * @ingroup onedim
  */
 class MultiJac : public BandMatrix
 {
diff --git a/include/cantera/oneD/MultiNewton.h b/include/cantera/oneD/MultiNewton.h
index 8ebfd2496..fc002834f 100644
--- a/include/cantera/oneD/MultiNewton.h
+++ b/include/cantera/oneD/MultiNewton.h
@@ -17,6 +17,7 @@ namespace Cantera
 /**
  * Newton iterator for multi-domain, one-dimensional problems.
  * Used by class OneDim.
+ * @ingroup onedim
  */
 class MultiNewton
 {
diff --git a/include/cantera/oneD/OneDim.h b/include/cantera/oneD/OneDim.h
index 5e191fcbb..e9f8360d6 100644
--- a/include/cantera/oneD/OneDim.h
+++ b/include/cantera/oneD/OneDim.h
@@ -17,6 +17,7 @@ class Func1;
 /**
  * Container class for multiple-domain 1D problems. Each domain is
  * represented by an instance of Domain1D.
+ * @ingroup onedim
  */
 class OneDim
 {
diff --git a/include/cantera/oneD/Sim1D.h b/include/cantera/oneD/Sim1D.h
index c162e9937..d37d69916 100644
--- a/include/cantera/oneD/Sim1D.h
+++ b/include/cantera/oneD/Sim1D.h
@@ -14,6 +14,7 @@ namespace Cantera
 /**
  * One-dimensional simulations. Class Sim1D extends class OneDim by storing
  * the solution vector, and by adding a hybrid Newton/time-stepping solver.
+ * @ingroup onedim
  */
 class Sim1D : public OneDim
 {
diff --git a/include/cantera/oneD/StFlow.h b/include/cantera/oneD/StFlow.h
index 1b1e3f751..4f87326c8 100644
--- a/include/cantera/oneD/StFlow.h
+++ b/include/cantera/oneD/StFlow.h
@@ -36,6 +36,7 @@ const int c_Soret = 2;
 /**
  *  This class represents 1D flow domains that satisfy the one-dimensional
  *  similarity solution for chemically-reacting, axisymmetric, flows.
+ *  @ingroup onedim
  */
 class StFlow : public Domain1D
 {
@@ -501,6 +502,7 @@ private:
 
 /**
  * A class for axisymmetric stagnation flows.
+ * @ingroup onedim
  */
 class AxiStagnFlow : public StFlow
 {
@@ -522,6 +524,7 @@ public:
 
 /**
  * A class for freely-propagating premixed flames.
+ * @ingroup onedim
  */
 class FreeFlame : public StFlow
 {
diff --git a/include/cantera/oneD/refine.h b/include/cantera/oneD/refine.h
index 3310dece2..6dd7d2d73 100644
--- a/include/cantera/oneD/refine.h
+++ b/include/cantera/oneD/refine.h
@@ -9,6 +9,7 @@ namespace Cantera
 class Domain1D;
 
 //! Refine Domain1D grids so that profiles satisfy adaptation tolerances
+//! @ingroup onedim
 class Refiner
 {
 public:
diff --git a/include/cantera/onedim.h b/include/cantera/onedim.h
index d34deb2e7..f24f7c705 100644
--- a/include/cantera/onedim.h
+++ b/include/cantera/onedim.h
@@ -1,3 +1,13 @@
+//! @file onedim.h
+
+/*!
+ * @defgroup onedim One-Dimensional Reacting Flows
+ *
+ * These classes comprise Cantera's ability to solve steady-state one-
+ * dimensional reacting flow problems, such as laminar flames, opposed flow
+ * diffusion flames, and stagnation flow chemical vapor deposition.
+ */
+
 #ifndef CT_INCL_ONEDIM_H
 #define CT_INCL_ONEDIM_H