From 92f18f58f5fa5e9fbb8d62ad26c5c6c6dd197acd Mon Sep 17 00:00:00 2001
From: Houtan Bastani <houtan@dynare.org>
Date: Wed, 21 Aug 2019 18:03:51 +0200
Subject: [PATCH] macro processor: comment If class

---
 src/macro/Directives.hh | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/macro/Directives.hh b/src/macro/Directives.hh
index 57981aa9..1c1409e5 100644
--- a/src/macro/Directives.hh
+++ b/src/macro/Directives.hh
@@ -173,6 +173,14 @@ namespace macro
   class If : public Directive
   {
   protected:
+    /* Every if statement and the associated body to execute are stored in a
+     * pair<ExpressionPtr, vector<DirectivePtr>>, where the ExpressionPtr is the condition
+     * and vector<DirectivePtr> is the series of statements to execute if the condition evaluates
+     * to true.
+     * The `if` statement is the first element in the vector
+     * If there exist any `elseif` statements, they follow
+     * If there is an `else` statement it is the last element in the vector. Its condition is true.
+     */
     const vector<pair<ExpressionPtr, vector<DirectivePtr>>> expr_and_body;
   public:
     If(vector<pair<ExpressionPtr, vector<DirectivePtr>>> expr_and_body_arg,