Move unit descriptions to Packing/Descriptions

SunSerega · Apr 1, 2024 · fc825de · fc825de
1 parent 7dc2bb1
commit fc825de
Show file tree

Hide file tree

Showing 29 changed files with 143 additions and 110 deletions.
diff --git a/DataScraping/Reps/OpenCL-Docs b/DataScraping/Reps/OpenCL-Docs
diff --git a/Modules.Packed/Dummy.pas b/Modules.Packed/Dummy.pas
@@ -11,7 +11,7 @@
 // https://github.com/SunSerega/POCGL/blob/master/LICENSE
 //*****************************************************************************************************\\
 
-/// Внутренний модуль POCGL для тестирования кодогенераторов
+///Внутренний модуль POCGL для тестирования кодогенераторов
 unit Dummy;
 
 {$zerobasedstrings}

diff --git a/Modules.Packed/OpenCL.pas b/Modules.Packed/OpenCL.pas
@@ -11,16 +11,14 @@
 // https://github.com/SunSerega/POCGL/blob/master/LICENSE
 //*****************************************************************************************************\\
 
-///
 ///Код переведён отсюда:
-///   https://github.com/KhronosGroup/OpenCL-Docs/tree/master/xml
+///    https://github.com/KhronosGroup/OpenCL-Docs/tree/master/xml
 ///
 ///Спецификации всех версий OpenCL:
-///   https://www.khronos.org/registry/OpenCL/
+///    https://www.khronos.org/registry/OpenCL/
 ///
 ///Если чего-либо не хватает, или найдена ошибка - писать сюда:
-///   https://github.com/SunSerega/POCGL/issues
-///
+///    https://github.com/SunSerega/POCGL/issues
 unit OpenCL;
 
 {$zerobasedstrings}

diff --git a/Modules.Packed/OpenCLABC.pas b/Modules.Packed/OpenCLABC.pas
@@ -11,17 +11,15 @@
 // https://github.com/SunSerega/POCGL/blob/master/LICENSE
 //*****************************************************************************************************\\
 
-///
 ///Высокоуровневая оболочка модуля OpenCL
-///   OpenCL и OpenCLABC можно использовать одновременно
-///   Но контактировать они практически не будут
+///    OpenCL и OpenCLABC можно использовать одновременно
+///    Но это полезно только если в OpenCLABC вам чего-либо не хватает
 ///
 ///Если не хватает типа/метода или найдена ошибка - писать сюда:
-///   https://github.com/SunSerega/POCGL/issues
+///    https://github.com/SunSerega/POCGL/issues
 ///
 ///Справка данного модуля находится в папке примеров
-///   По-умолчанию, её можно найти в "C:\PABCWork.NET\Samples\OpenGL и OpenCL"
-///
+///    По-умолчанию, её можно найти в "C:\PABCWork.NET\Samples\StandardUnits\OpenGL и OpenCL"
 unit OpenCLABC;
 
 {$region DEBUG}{$ifdef DEBUG}

diff --git a/Modules.Packed/OpenGL.pas b/Modules.Packed/OpenGL.pas
@@ -11,16 +11,14 @@
 // https://github.com/SunSerega/POCGL/blob/master/LICENSE
 //*****************************************************************************************************\\
 
-///
 ///Код переведён отсюда:
-///   https://github.com/KhronosGroup/OpenGL-Registry/tree/master/xml
+///    https://github.com/KhronosGroup/OpenGL-Registry/tree/master/xml
 ///
 ///Спецификации всех версий OpenGL:
-///   https://www.khronos.org/registry/OpenGL/specs/gl/
+///    https://www.khronos.org/registry/OpenGL/specs/gl/
 ///
 ///Если чего-либо не хватает, или найдена ошибка - писать сюда:
-///   https://github.com/SunSerega/POCGL/issues
-///
+///    https://github.com/SunSerega/POCGL/issues
 unit OpenGL;
 
 {$zerobasedstrings}

diff --git a/Modules.Packed/OpenGLABC.pas b/Modules.Packed/OpenGLABC.pas
@@ -11,10 +11,8 @@
 // https://github.com/SunSerega/POCGL/blob/master/LICENSE
 //*****************************************************************************************************\\
 
-///
 ///Модуль, зарезервированный для высокоуровневой оболочки модуля OpenGL
 ///Все текущие элементы модуля являются временными
-///
 unit OpenGLABC;
 
 uses System;

diff --git a/Modules/Dummy.pas b/Modules/Dummy.pas
@@ -1,7 +1,6 @@
 
 {%../../Common/LicenseHeader.txt%}
 
-/// Внутренний модуль POCGL для тестирования кодогенераторов
 unit Dummy;
 
 {$zerobasedstrings}

diff --git a/Modules/OpenCL.pas b/Modules/OpenCL.pas
@@ -1,16 +1,6 @@
 
 {%../../Common/LicenseHeader.txt%}
 
-///
-///Код переведён отсюда:
-///   https://github.com/KhronosGroup/OpenCL-Docs/tree/master/xml
-///
-///Спецификации всех версий OpenCL:
-///   https://www.khronos.org/registry/OpenCL/
-///
-///Если чего-либо не хватает, или найдена ошибка - писать сюда:
-///   https://github.com/SunSerega/POCGL/issues
-///
 unit OpenCL;
 
 {$zerobasedstrings}

diff --git a/Modules/OpenCLABC.pas b/Modules/OpenCLABC.pas
@@ -1,17 +1,6 @@
 
 {%../../Common/LicenseHeader.txt%}
 
-///
-///Высокоуровневая оболочка модуля OpenCL
-///   OpenCL и OpenCLABC можно использовать одновременно
-///   Но контактировать они практически не будут
-///
-///Если не хватает типа/метода или найдена ошибка - писать сюда:
-///   https://github.com/SunSerega/POCGL/issues
-///
-///Справка данного модуля находится в папке примеров
-///   По-умолчанию, её можно найти в "C:\PABCWork.NET\Samples\OpenGL и OpenCL"
-///
 unit OpenCLABC;
 
 {$region DEBUG}{$ifdef DEBUG}

diff --git a/Modules/OpenGL.pas b/Modules/OpenGL.pas
@@ -1,16 +1,6 @@
 
 {%../../Common/LicenseHeader.txt%}
 
-///
-///Код переведён отсюда:
-///   https://github.com/KhronosGroup/OpenGL-Registry/tree/master/xml
-///
-///Спецификации всех версий OpenGL:
-///   https://www.khronos.org/registry/OpenGL/specs/gl/
-///
-///Если чего-либо не хватает, или найдена ошибка - писать сюда:
-///   https://github.com/SunSerega/POCGL/issues
-///
 unit OpenGL;
 
 {$zerobasedstrings}

diff --git a/Modules/OpenGLABC.pas b/Modules/OpenGLABC.pas
@@ -1,10 +1,6 @@
 
 {%../../Common/LicenseHeader.txt%}
 
-///
-///Модуль, зарезервированный для высокоуровневой оболочки модуля OpenGL
-///Все текущие элементы модуля являются временными
-///
 unit OpenGLABC;
 
 uses System;

diff --git a/Packing/Descriptions/DescriptionsData.pas b/Packing/Descriptions/DescriptionsData.pas
@@ -19,6 +19,16 @@ interface
 
   end;
 
+  CommentableUnit = sealed class(CommentableBase)
+
+    public constructor(name: string) := inherited;
+
+    public property FullName: string read self.Name; override;
+
+    public static function Parse(l: string): CommentableUnit;
+
+  end;
+
   CommentableType = sealed class(CommentableBase)
     private re_def: string;
     private is_sealed, is_interface: boolean;
@@ -256,6 +266,14 @@ function GetArgs(l: string; ind1: integer; start_sym, end_sym: char): array of s
 
 {$region Member parser's}
 
+static function CommentableUnit.Parse(l: string): CommentableUnit;
+const unit_keyword = 'unit';
+begin
+  if not l.StartsWith(unit_keyword) then exit;
+  if not l.EndsWith(';') then raise new System.FormatException(l);
+  Result := new CommentableUnit(l.Substring(unit_keyword.Length)[:^1].Trim);
+end;
+
 static function CommentableType.Parse(l: string): CommentableType;
 const separator = ' = ';
 const type_keywords: array of string = ('record', 'class', 'interface');
@@ -442,9 +460,13 @@ function SkipCodeBlock(l: string; enmr: IEnumerator<string>): boolean;
     var l := enmr.Current;
 
     if not start_checking then
+    begin
+      if CommentableUnit.Parse(l) is CommentableUnit(var u) then
+        yield u else
       if 'interface' in l then
-        start_checking := true else
-        continue;
+        start_checking := true;
+      continue;
+    end;
 
     if not end_checking and ('implementation' in l) then end_checking := true;
     if end_checking then continue;

diff --git a/Packing/Descriptions/Dummy.predoc b/Packing/Descriptions/Dummy.predoc
@@ -11,7 +11,6 @@
 // https://github.com/SunSerega/POCGL/blob/master/LICENSE
 //*****************************************************************************************************\\
 
-/// Внутренний модуль POCGL для тестирования кодогенераторов
 unit Dummy;
 
 {$zerobasedstrings}

diff --git a/Packing/Descriptions/Dummy.used.log b/Packing/Descriptions/Dummy.used.log
@@ -1,4 +1,7 @@
-# DummyLoader
+# Dummy
+Внутренний модуль POCGL для тестирования кодогенераторов
+
+# DummyLoader
 Абстрактное понятие загрузчика адресов функций api
 
 # DummyLoader.GetProcAddress(string)

diff --git a/Packing/Descriptions/Dummy/0.dat → Packing/Descriptions/Dummy/.dat b/Packing/Descriptions/Dummy/0.dat → Packing/Descriptions/Dummy/.dat
@@ -1,6 +1,11 @@
 
 
 
+# Dummy
+Внутренний модуль POCGL для тестирования кодогенераторов
+
+
+
 # EnumBase
 Базовый тип перечислений
 

diff --git a/Packing/Descriptions/OpenCL.predoc b/Packing/Descriptions/OpenCL.predoc
@@ -11,16 +11,6 @@
 // https://github.com/SunSerega/POCGL/blob/master/LICENSE
 //*****************************************************************************************************\\
 
-///
-///Код переведён отсюда:
-///   https://github.com/KhronosGroup/OpenCL-Docs/tree/master/xml
-///
-///Спецификации всех версий OpenCL:
-///   https://www.khronos.org/registry/OpenCL/
-///
-///Если чего-либо не хватает, или найдена ошибка - писать сюда:
-///   https://github.com/SunSerega/POCGL/issues
-///
 unit OpenCL;
 
 {$zerobasedstrings}

diff --git a/Packing/Descriptions/OpenCL.used.log b/Packing/Descriptions/OpenCL.used.log
@@ -30,6 +30,16 @@
 # va_surface_id
 
 
+# OpenCL
+Код переведён отсюда:
+    https://github.com/KhronosGroup/OpenCL-Docs/tree/master/xml
+
+Спецификации всех версий OpenCL:
+    https://www.khronos.org/registry/OpenCL/
+
+Если чего-либо не хватает, или найдена ошибка - писать сюда:
+    https://github.com/SunSerega/POCGL/issues
+
 # OpenCLException
 Исключение, которое кидает clErrorCode.RaiseIfError
 

diff --git a/Packing/Descriptions/OpenCL/.dat b/Packing/Descriptions/OpenCL/.dat
@@ -0,0 +1,26 @@
+
+
+
+# OpenCL
+
+Код переведён отсюда:
+    https://github.com/KhronosGroup/OpenCL-Docs/tree/master/xml
+
+Спецификации всех версий OpenCL:
+    https://www.khronos.org/registry/OpenCL/
+
+Если чего-либо не хватает, или найдена ошибка - писать сюда:
+    https://github.com/SunSerega/POCGL/issues
+
+
+
+# OpenCLException
+Исключение, которое кидает clErrorCode.RaiseIfError
+
+# OpenCLException.Code
+Код ошибки
+
+# OpenCLException.(clErrorCode, string)
+# OpenCLException.(clErrorCode)
+
+
diff --git a/Packing/Descriptions/OpenCL/0.dat b/Packing/Descriptions/OpenCL/0.dat
diff --git a/Packing/Descriptions/OpenCLABC.predoc b/Packing/Descriptions/OpenCLABC.predoc
@@ -11,17 +11,6 @@
 // https://github.com/SunSerega/POCGL/blob/master/LICENSE
 //*****************************************************************************************************\\
 
-///
-///Высокоуровневая оболочка модуля OpenCL
-///   OpenCL и OpenCLABC можно использовать одновременно
-///   Но контактировать они практически не будут
-///
-///Если не хватает типа/метода или найдена ошибка - писать сюда:
-///   https://github.com/SunSerega/POCGL/issues
-///
-///Справка данного модуля находится в папке примеров
-///   По-умолчанию, её можно найти в "C:\PABCWork.NET\Samples\OpenGL и OpenCL"
-///
 unit OpenCLABC;
 
 {$region DEBUG}{$ifdef DEBUG}

diff --git a/Packing/Descriptions/OpenCLABC.used.log b/Packing/Descriptions/OpenCLABC.used.log
@@ -1074,6 +1074,17 @@ mem_offset указывает отступ от начала области па
 # NativeValue<T>.Value
 Возвращает или задаёт значение, сохранённое неуправляемой памяти
 
+# OpenCLABC
+Высокоуровневая оболочка модуля OpenCL
+    OpenCL и OpenCLABC можно использовать одновременно
+    Но это полезно только если в OpenCLABC вам чего-либо не хватает
+
+Если не хватает типа/метода или найдена ошибка - писать сюда:
+    https://github.com/SunSerega/POCGL/issues
+
+Справка данного модуля находится в папке примеров
+    По-умолчанию, её можно найти в "C:\PABCWork.NET\Samples\StandardUnits\OpenGL и OpenCL"
+
 # OpenCLABCInternalException
 Исключение, кидаемое при неожиданном поведении внутренностей OpenCLABC
 Если это исключение было кинуто - пишите в issue

diff --git a/Packing/Descriptions/OpenCLABC/.dat b/Packing/Descriptions/OpenCLABC/.dat
@@ -0,0 +1,15 @@
+# OpenCLABC
+
+
+
+Высокоуровневая оболочка модуля OpenCL
+    OpenCL и OpenCLABC можно использовать одновременно
+    Но это полезно только если в OpenCLABC вам чего-либо не хватает
+
+Если не хватает типа/метода или найдена ошибка - писать сюда:
+    https://github.com/SunSerega/POCGL/issues
+
+Справка данного модуля находится в папке примеров
+    По-умолчанию, её можно найти в "C:\\PABCWork.NET\\Samples\\StandardUnits\\OpenGL и OpenCL"
+
+
diff --git a/Packing/Descriptions/OpenGL.predoc b/Packing/Descriptions/OpenGL.predoc
@@ -11,16 +11,6 @@
 // https://github.com/SunSerega/POCGL/blob/master/LICENSE
 //*****************************************************************************************************\\
 
-///
-///Код переведён отсюда:
-///   https://github.com/KhronosGroup/OpenGL-Registry/tree/master/xml
-///
-///Спецификации всех версий OpenGL:
-///   https://www.khronos.org/registry/OpenGL/specs/gl/
-///
-///Если чего-либо не хватает, или найдена ошибка - писать сюда:
-///   https://github.com/SunSerega/POCGL/issues
-///
 unit OpenGL;
 
 {$zerobasedstrings}

diff --git a/Packing/Descriptions/OpenGL.used.log b/Packing/Descriptions/OpenGL.used.log
@@ -75,6 +75,16 @@
 # IGLPlatformLoader.GetProcAddress(string)
 Этот метод вызывается для каждой динамически загружаемой функции
 
+# OpenGL
+Код переведён отсюда:
+    https://github.com/KhronosGroup/OpenGL-Registry/tree/master/xml
+
+Спецификации всех версий OpenGL:
+    https://www.khronos.org/registry/OpenGL/specs/gl/
+
+Если чего-либо не хватает, или найдена ошибка - писать сюда:
+    https://github.com/SunSerega/POCGL/issues
+
 # OpenGLException
 Исключение, которое кидает glErrorCode.RaiseIfError