Diff of /src/include/function/DPQFunction.h [192840] .. [18a63e] Maximize Restore

  Switch to side-by-side view

--- a/src/include/function/DPQFunction.h
+++ b/src/include/function/DPQFunction.h
@@ -7,19 +7,33 @@
 
     class RScalarDist;
 
+    /**
+     * @short Functions derived from R Scalar distributions
+     *
+     * The DPQFunction class exposes member functions of the class
+     * RScalarDist as BUGS functions so that they can be called by the
+     * user. These are the density (D), cumulative probability (P),
+     * and quantile (Q) functions.
+     *
+     * D-P-Q functions are generated automatically when an
+     * RScalarFunction is inserted into the Module.
+     *
+     * @seealso Module#insert
+     */
     class DPQFunction : public ScalarFunction
     {
 	RScalarDist const *_dist;
     public:
 	DPQFunction(std::string const &name, RScalarDist const *dist);
 	/**
-         * Returns the distribution from which the function derives its
-         * value
+         * Returns the distribution from which the function is derived
          */
 	RScalarDist const *dist() const;
 	/**
-         * Strips off the first argument and then checks that the remaining
-         * arguments are valid parameters for the distribution
+	 * If an RScalarDist has m parameters, then a DPQFunction
+	 * derived from it will have (m+1) arguments. To check the
+	 * validity of the arguments, we strip off the first one and
+	 * then pass the rest to ScalarDist#checkParameterValue
          */
 	bool checkArgs(std::vector<double const *> const &args) const;
     };