From 19c0037a315b4e2cefc7f04e7c1eafc0b503afca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89milie=20Feral?= Date: Tue, 13 Aug 2019 17:31:49 +0200 Subject: [PATCH] [poincare] Add comments on Expression methods --- poincare/include/poincare/expression.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/poincare/include/poincare/expression.h b/poincare/include/poincare/expression.h index b54b0065a..6c55dcdc0 100644 --- a/poincare/include/poincare/expression.h +++ b/poincare/include/poincare/expression.h @@ -321,12 +321,14 @@ protected: * The given Expression should already be reduced and the return Expression * is reduced (only a numeral factor was potentially made positive, and if it * was -1, it was removed from the multiplication). + * Warning: this must be called on reduced expressions */ Expression makePositiveAnyNegativeNumeralFactor(ExpressionNode::ReductionContext reductionContext); Expression denominator(Context * context, Preferences::ComplexFormat complexFormat, Preferences::AngleUnit angleUnit) const { return node()->denominator(context, complexFormat, angleUnit); } Expression shallowReduce(ExpressionNode::ReductionContext reductionContext) { return node()->shallowReduce(reductionContext); } Expression shallowBeautify(ExpressionNode::ReductionContext reductionContext) { return node()->shallowBeautify(reductionContext); } Expression deepBeautify(ExpressionNode::ReductionContext reductionContext); + // WARNING: this must be called on reduced expressions Expression setSign(ExpressionNode::Sign s, ExpressionNode::ReductionContext reductionContext); private: