From 54d0ba1876b4a0387a323e628b191a0901bfdfed Mon Sep 17 00:00:00 2001
From: peri4 <peri4ko@yandex.ru>
Date: Thu, 29 Jun 2023 18:37:09 +0300
Subject: [PATCH] literals doc

---
 libs/main/core/piliterals.h | 79 +++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)

diff --git a/libs/main/core/piliterals.h b/libs/main/core/piliterals.h
index 6777f087..2e87d319 100644
--- a/libs/main/core/piliterals.h
+++ b/libs/main/core/piliterals.h
@@ -37,67 +37,146 @@
 #define PILITERALS_H
 
 
+//! \~\brief
+//! \~english Kilobytes, x1000
+//! \~russian Килобайт, x1000
 unsigned long long operator""_KB(long double v) {
 	return v * 1000.;
 }
+
+//! \~\brief
+//! \~english Kilobytes, x1000
+//! \~russian Килобайт, x1000
 unsigned long long operator""_KB(unsigned long long v) {
 	return v * 1000;
 }
+
+//! \~\brief
+//! \~english Kibibytes, x1024 (2^10)
+//! \~russian Кибибайт, x1024 (2^10)
 unsigned long long operator""_KiB(long double v) {
 	return v * 1024.;
 }
+
+//! \~\brief
+//! \~english Kibibytes, x1024 (2^10)
+//! \~russian Кибибайт, x1024 (2^10)
 unsigned long long operator""_KiB(unsigned long long v) {
 	return v * 1024;
 }
 
+
+//! \~\brief
+//! \~english Megabytes, x1000.000
+//! \~russian Мегабайт, x1000.000
 unsigned long long operator""_MB(long double v) {
 	return v * 1000. * 1000.;
 }
+
+//! \~\brief
+//! \~english Megabytes, x1000.000
+//! \~russian Мегабайт, x1000.000
 unsigned long long operator""_MB(unsigned long long v) {
 	return v * 1000 * 1000;
 }
+
+//! \~\brief
+//! \~english Mebibytes, x1.048.576 (2^20)
+//! \~russian Мебибайт, x1.048.576 (2^20)
 unsigned long long operator""_MiB(long double v) {
 	return v * 1024. * 1024.;
 }
+
+//! \~\brief
+//! \~english Mebibytes, x1.048.576 (2^20)
+//! \~russian Мебибайт, x1.048.576 (2^20)
 unsigned long long operator""_MiB(unsigned long long v) {
 	return v * 1024 * 1024;
 }
 
+
+//! \~\brief
+//! \~english Gigabytes, x1000.000.000
+//! \~russian Гигабайт, x1000.000.000
 unsigned long long operator""_GB(long double v) {
 	return v * 1000. * 1000. * 1000.;
 }
+
+//! \~\brief
+//! \~english Gigabytes, x1000.000.000
+//! \~russian Гигабайт, x1000.000.000
 unsigned long long operator""_GB(unsigned long long v) {
 	return v * 1000 * 1000 * 1000;
 }
+
+//! \~\brief
+//! \~english Gibibytes, x1.073.741.824 (2^30)
+//! \~russian Гибибайт, x1.073.741.824 (2^30)
 unsigned long long operator""_GiB(long double v) {
 	return v * 1024. * 1024. * 1024.;
 }
+
+//! \~\brief
+//! \~english Gibibytes, x1.073.741.824 (2^30)
+//! \~russian Гибибайт, x1.073.741.824 (2^30)
 unsigned long long operator""_GiB(unsigned long long v) {
 	return v * 1024 * 1024 * 1024;
 }
 
+
+//! \~\brief
+//! \~english Terabytes, x1000.000.000.000
+//! \~russian Терабайт, x1000.000.000.000
 unsigned long long operator""_TB(long double v) {
 	return v * 1000. * 1000. * 1000. * 1000.;
 }
+
+//! \~\brief
+//! \~english Terabytes, x1000.000.000.000
+//! \~russian Терабайт, x1000.000.000.000
 unsigned long long operator""_TB(unsigned long long v) {
 	return v * 1000 * 1000 * 1000 * 1000;
 }
+
+//! \~\brief
+//! \~english Tebibytes, x1.099.511.627.776 (2^40)
+//! \~russian Тебибайт, x1.099.511.627.776 (2^40)
 unsigned long long operator""_TiB(long double v) {
 	return v * 1024. * 1024. * 1024. * 1024.;
 }
+
+//! \~\brief
+//! \~english Tebibytes, x1.099.511.627.776 (2^40)
+//! \~russian Тебибайт, x1.099.511.627.776 (2^40)
 unsigned long long operator""_TiB(unsigned long long v) {
 	return v * 1024 * 1024 * 1024 * 1024;
 }
 
+
+//! \~\brief
+//! \~english Petabytes, x1000.000.000.000.000
+//! \~russian Петабайт, x1000.000.000.000.000
 unsigned long long operator""_PB(long double v) {
 	return v * 1000. * 1000. * 1000. * 1000. * 1000.;
 }
+
+//! \~\brief
+//! \~english Petabytes, x1000.000.000.000.000
+//! \~russian Петабайт, x1000.000.000.000.000
 unsigned long long operator""_PB(unsigned long long v) {
 	return v * 1000 * 1000 * 1000 * 1000 * 1000;
 }
+
+//! \~\brief
+//! \~english Pebibytes, x1.125.899.906.842.624 (2^50)
+//! \~russian Пебибайт, x1.125.899.906.842.624 (2^50)
 unsigned long long operator""_PiB(long double v) {
 	return v * 1024. * 1024. * 1024. * 1024. * 1024.;
 }
+
+//! \~\brief
+//! \~english Pebibytes, x1.125.899.906.842.624 (2^50)
+//! \~russian Пебибайт, x1.125.899.906.842.624 (2^50)
 unsigned long long operator""_PiB(unsigned long long v) {
 	return v * 1024 * 1024 * 1024 * 1024 * 1024;
 }