From 4449ad4cd13d0395a143c90194ed4bdaa81b03e2 Mon Sep 17 00:00:00 2001
From: Dave Parker <dave.x.parker@gmail.com>
Date: Mon, 7 Dec 2015 20:56:42 +0000
Subject: [PATCH] Further commenting in FilterOperator.

git-svn-id: https://www.prismmodelchecker.org/svn/prism/prism/trunk@11014 bbc10eb1-c90d-0410-af57-cb519fbb1720
---
 prism/src/parser/ast/ExpressionFilter.java | 60 +++++++---------------
 1 file changed, 18 insertions(+), 42 deletions(-)

diff --git a/prism/src/parser/ast/ExpressionFilter.java b/prism/src/parser/ast/ExpressionFilter.java
index f658b636..20fa1155 100644
--- a/prism/src/parser/ast/ExpressionFilter.java
+++ b/prism/src/parser/ast/ExpressionFilter.java
@@ -33,62 +33,38 @@ import prism.PrismLangException;
 
 public class ExpressionFilter extends Expression
 {
+	/**
+	 * Types of filter, for expressions of the form "filter(op, prop, states)",
+	 * with filter states "states" being optional (denoting "true").
+	 */ 
 	public enum FilterOperator {
-		/**
-		 * minimum value of prop over all filter states
-		 */
+		/** Minimum value of prop over all filter states */
 		MIN,
-		/**
-		 * maximum value of prop over all filter states
-		 */
+		/** Maximum value of prop over all filter states */
 		MAX,
-		/**
-		 * true for the filter states that yield the minimum value of prop
-		 */
+		/** True for the filter states that yield the minimum value of prop */
 		ARGMIN,
-		/**
-		 * true for the filter states that yield the maximum value of prop
-		 */
+		/** True for the filter states that yield the maximum value of prop */
 		ARGMAX,
-		/**
-		 * number of filter states for which prop is true
-		 */
+		/** Number of filter states for which prop is true */
 		COUNT,
-		/**
-		 * sum of the value of prop for all filter states
-		 */
+		/** Sum of the value of prop for all filter states */
 		SUM,
-		/**
-		 * average of the value of prop over all filter states
-		 */
+		/** Average of the value of prop over all filter states */
 		AVG,
-		/**
-		 * value of prop for the first (lowest-indexed) filter state
-		 */
+		/** Value of prop for the first (lowest-indexed) filter state */
 		FIRST,
-		/**
-		 * range (interval) of values of prop over all filter states
-		 */
+		/** Range (interval) of values of prop over all filter states */
 		RANGE,
-		/**
-		 * true iff prop is true for all filter states
-		 */
+		/** True iff prop is true for all filter states */
 		FORALL,
-		/**
-		 * true iff prop is true for some filter states
-		 */
+		/** True iff prop is true for some filter states */
 		EXISTS,
-		/**
-		 * print the (non-zero) values to the log
-		 */
+		/** Print the (non-zero) values to the log */
 		PRINT,
-		/**
-		 * print all (including zero) values to the log
-		 */
+		/** Print all (including zero) values to the log */
 		PRINTALL,
-		/**
-		 * value for the single filter state (if there is more than one, this is an error)
-		 */
+		/** Value for the single filter state (if there is more than one, this is an error) */
 		STATE;
 	};