merged AI doc, some new pages

libs/main/units/piunits_prefix.h

@@ -1,9 +1,8 @@
-/*! \file piunits_prefix.h
- * \ingroup Core
- * \~\brief
- * \~english Unit prefixes
- * \~russian Префиксы единиц измерения
- */
+//! \~\file piunits_prefix.h
+//! \~\ingroup Units
+//! \~\brief
+//! \~english Unit prefixes
+//! \~russian Префиксы единиц измерения
 /*
     PIP - Platform Independent Primitives
     Unit prefix
@@ -28,43 +27,61 @@
 
 #include "pistring.h"
 
+//! \~\ingroup Units
+//! \~\brief
+//! \~english Namespace containing unit prefix helpers.
+//! \~russian Пространство имен со вспомогательными средствами префиксов единиц.
 namespace PIUnits {
 
+//! \~\ingroup Units
+//! \~\brief
+//! \~english Helpers for localized prefix names, symbols, and multipliers.
+//! \~russian Вспомогательные методы для локализованных имен, обозначений и множителей префиксов.
 class PIP_EXPORT Prefix {
 	friend class Value;
 
 public:
+	//! \~english Supported SI prefixes.
+	//! \~russian Поддерживаемые префиксы СИ.
 	enum {
-		None,
+		None /** \~english No prefix \~russian Без префикса */,
 
-		Deca = 0x100, // da	10^1 	10
-		Hecto,        // h 	10^2 	100
-		Kilo,         // k 	10^3 	1000
-		Mega,         // M 	10^6 	1000000
-		Giga,         // G 	10^9 	1000000000
-		Tera,         // T 	10^12 	1000000000000
-		Peta,         // P 	10^15 	1000000000000000
-		Exa,          // E 	10^18 	1000000000000000000
-		Zetta,        // Z 	10^21 	1000000000000000000000
-		Yotta,        // Y 	10^24 	1000000000000000000000000
-		Ronna,        // R 	10^27 	1000000000000000000000000000
-		Quetta,       // Q 	10^30 	1000000000000000000000000000000
+		Deca = 0x100 /** \~english Deca prefix, 10^1 \~russian Префикс дека, 10^1 */,
+		Hecto /** \~english Hecto prefix, 10^2 \~russian Префикс гекто, 10^2 */,
+		Kilo /** \~english Kilo prefix, 10^3 \~russian Префикс кило, 10^3 */,
+		Mega /** \~english Mega prefix, 10^6 \~russian Префикс мега, 10^6 */,
+		Giga /** \~english Giga prefix, 10^9 \~russian Префикс гига, 10^9 */,
+		Tera /** \~english Tera prefix, 10^12 \~russian Префикс тера, 10^12 */,
+		Peta /** \~english Peta prefix, 10^15 \~russian Префикс пета, 10^15 */,
+		Exa /** \~english Exa prefix, 10^18 \~russian Префикс экса, 10^18 */,
+		Zetta /** \~english Zetta prefix, 10^21 \~russian Префикс зетта, 10^21 */,
+		Yotta /** \~english Yotta prefix, 10^24 \~russian Префикс йотта, 10^24 */,
+		Ronna /** \~english Ronna prefix, 10^27 \~russian Префикс ронна, 10^27 */,
+		Quetta /** \~english Quetta prefix, 10^30 \~russian Префикс кветта, 10^30 */,
 
-		Deci = 0x200, // d 	10^−1 	0.1
-		Centi,        // c 	10^−2 	0.01
-		Milli,        // m 	10^−3 	0.001
-		Micro,        // μ 	10^−6 	0.000001
-		Nano,         // n 	10^−9 	0.000000001
-		Pico,         // p 	10^−12 	0.000000000001
-		Femto,        // f 	10^−15 	0.000000000000001
-		Atto,         // a 	10^−18 	0.000000000000000001
-		Zepto,        // z 	10^−21 	0.000000000000000000001
-		Yocto,        // y 	10^−24 	0.000000000000000000000001
-		Ronto,        // r 	10^−27 	0.000000000000000000000000001
+		Deci = 0x200 /** \~english Deci prefix, 10^-1 \~russian Префикс деци, 10^-1 */,
+		Centi /** \~english Centi prefix, 10^-2 \~russian Префикс санти, 10^-2 */,
+		Milli /** \~english Milli prefix, 10^-3 \~russian Префикс милли, 10^-3 */,
+		Micro /** \~english Micro prefix, 10^-6 \~russian Префикс микро, 10^-6 */,
+		Nano /** \~english Nano prefix, 10^-9 \~russian Префикс нано, 10^-9 */,
+		Pico /** \~english Pico prefix, 10^-12 \~russian Префикс пико, 10^-12 */,
+		Femto /** \~english Femto prefix, 10^-15 \~russian Префикс фемто, 10^-15 */,
+		Atto /** \~english Atto prefix, 10^-18 \~russian Префикс атто, 10^-18 */,
+		Zepto /** \~english Zepto prefix, 10^-21 \~russian Префикс зепто, 10^-21 */,
+		Yocto /** \~english Yocto prefix, 10^-24 \~russian Префикс йокто, 10^-24 */,
+		Ronto /** \~english Ronto prefix, 10^-27 \~russian Префикс ронто, 10^-27 */,
 	};
 
+	//! \~english Returns localized full name of prefix "prefix".
+	//! \~russian Возвращает локализованное полное имя префикса "prefix".
 	static PIString name(int prefix);
+
+	//! \~english Returns localized short symbol of prefix "prefix".
+	//! \~russian Возвращает локализованное короткое обозначение префикса "prefix".
 	static PIString prefix(int prefix);
+
+	//! \~english Returns numeric multiplier for prefix "prefix".
+	//! \~russian Возвращает числовой множитель префикса "prefix".
 	static double multiplier(int prefix);
 
 private: