Mercurial > bmsapp / changeset

--- a/src/analog/functions.h	Thu Jun 30 14:44:46 2022 +0200
+++ b/src/analog/functions.h	Thu Jun 30 21:01:50 2022 +0200
@@ -42,24 +42,24 @@
 
 
 /**
-* Szablonowa funkcja do wyznaczania skali w zadanym przedziale o wyznaczonej ilości punktów skali.
-* Na podstawie wartości minimalnej oraz maksymalnej, jaką chcemy osiągnać ustawia
-* wartości m_min oraz m_max w taki sposób cały przedział skali (m_max-m_min) był podzielny
-* przez ilość punktów skali a odległość pomiędzy punktami skali była wartoscią która jest
-* wieloktornością liczby 5. Dodatkowo isnieje możliwość przesunięcia skali w lewo lub prawo by
-* rozpoczynała się jak najbliżej wartości minimalnej lub kończyła jak najbliżej wartości
-* maksymalnej.
-*
-* @param m_minimum - wartość minilana na skali jaka ma być widoczna
-* @param m_maximum - wartość maksymalna na skali jaka ma być widoczna
-* @param m_min     - wyliczona wartość początkowa skali
-* @param m_max     - wyliczona wartość końcowa skali
-* @param stesp     - ilość węzłów jaką ma mieć skala
-* @param left      - czy skala ma być wyrównana do lewej czy do prawej (domyślnie do prawej).
-* @return Funkcja zwraca wartość true jeżeli wartości m_min oraz m_max w wyniku zmiany zakresu
-* zmieniły swoją wartość.  Na podstawie tej wartości wiadomo czy należy np. przerysować skalę
-* - podając wcześniej poprzednie wartości zakresu skali.
-*/
+ * Template function for determining the scale in a given interval with a designated number of scale points.
+ * On the basis of the minimum and maximum value that we want to achieve, sets the values of m_min and m_max
+ * in such a way that the entire scale range (m_max-m_min) was divisible by the number of scale points and
+ * the distance between the scale points was the value which is a multiplication of number 5.
+ * Additionally, it is possible to shift the scale left or right so that it starts as close to the minimum
+ * value or ends as close to the maximum value.
+ *
+ * @param m_minimum - minimum value on the scale to be visible
+ * @param m_maximum - maximum value on the scale to be visible
+ * @param m_min     - the computed starting value of the scale
+ * @param m_max     - the computed end value of the scale
+ * @param stesp     - number of nodes to have in the scale
+ * @param left      - whether the scale should be left or right aligned (default is right).
+ * @return          - The function returns the value true if the values of m_min and m_max
+ *                    changed their value as a result of changing the range.
+ *                    Based on this value, it is known whether it is necessary, for example,
+ *                    to redraw the scale - giving previously previous values of the scale range
+ */
 
 template <typename T>
 bool range(T m_minimum,T m_maximum, T & m_min, T & m_max,unsigned int steps, bool left = false,double inc = 5.0)