From 9e99bb2c306954a55de54f69ee61aef5396caaa3 Mon Sep 17 00:00:00 2001
From: Jean-Guillaume Fages <jg.fages@cosling.com>
Date: Fri, 4 Aug 2023 23:59:15 +0200
Subject: [PATCH] add javadoc

---
 .../solver/constraints/IIntConstraintFactory.java         | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/solver/src/main/java/org/chocosolver/solver/constraints/IIntConstraintFactory.java b/solver/src/main/java/org/chocosolver/solver/constraints/IIntConstraintFactory.java
index 249422c8f2..b3a4f35446 100644
--- a/solver/src/main/java/org/chocosolver/solver/constraints/IIntConstraintFactory.java
+++ b/solver/src/main/java/org/chocosolver/solver/constraints/IIntConstraintFactory.java
@@ -558,6 +558,14 @@ default Constraint pow(IntVar base, int exponent, IntVar result) {
         }
     }
 
+    /**
+     * <p>Creates a power constraint: X^Y = Z.</p>
+     *
+     * @param base     first variable
+     * @param exponent second variable
+     * @param result   result variable
+     * @implSpec The 'power' propagator does not exist. The general case is handled by a table decomposition.
+     */
     default Constraint pow(IntVar base, IntVar exponent, IntVar result) {
         if (exponent.isInstantiated()) {
             return pow(base, exponent.getValue(), result);