From 8b4283b281a691c7c797ba943abfe1355ca8d162 Mon Sep 17 00:00:00 2001
From: Fan Jiang <prof.fan@foxmail.com>
Date: Wed, 23 Mar 2022 20:54:53 -0400
Subject: [PATCH] Add doxygen for GMM

---
 gtsam/hybrid/GaussianMixture.h | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/gtsam/hybrid/GaussianMixture.h b/gtsam/hybrid/GaussianMixture.h
index 13171ae5d..9879e80bd 100644
--- a/gtsam/hybrid/GaussianMixture.h
+++ b/gtsam/hybrid/GaussianMixture.h
@@ -24,9 +24,8 @@
 #include <gtsam/linear/GaussianConditional.h>
 
 namespace gtsam {
-class GaussianMixture
-    : public HybridFactor,
-      public Conditional<HybridFactor, GaussianMixture> {
+class GaussianMixture : public HybridFactor,
+                        public Conditional<HybridFactor, GaussianMixture> {
  public:
   using This = GaussianMixture;
   using shared_ptr = boost::shared_ptr<GaussianMixture>;
@@ -38,14 +37,22 @@ class GaussianMixture
   Conditionals conditionals_;
 
  public:
+  /**
+   * @brief Construct a new Gaussian Mixture object
+   *
+   * @param continuousFrontals the continuous frontals.
+   * @param continuousParents the continuous parents.
+   * @param discreteParents the discrete parents. Will be placed last.
+   * @param conditionals a decision tree of GaussianConditionals.
+   */
   GaussianMixture(const KeyVector &continuousFrontals,
-                        const KeyVector &continuousParents,
-                        const DiscreteKeys &discreteParents,
-                        const Conditionals &conditionals);
+                  const KeyVector &continuousParents,
+                  const DiscreteKeys &discreteParents,
+                  const Conditionals &conditionals);
 
   using Sum = DecisionTree<Key, GaussianFactorGraph>;
 
-  const Conditionals& conditionals();
+  const Conditionals &conditionals();
 
   /* *******************************************************************************/
   Sum addTo(const Sum &sum) const;