XML-справка нативного расширения

Справка расширения объединяет зарегистрированную структуру API и написанные вами объяснения. Генератор получает класс и константы, но не придумывает назначение, единицы и ограничения.

Экспортируйте структуру

Расширение должно загружаться при старте проекта. Для примера нужны DocsNativeProbe, ProductVersion=10000 и EntityPathVariant=22. Загрузка внутри _Ready() слишком поздняя для --doctool, который не запускает обычный игровой уровень.

Задайте $Editor путём к установленному редактору, $Project — каталогу проекта, $Output — отдельному существующему каталогу документации:

& $Editor --headless --path "$Project" --doctool "$Output" --reckfellextension-docs --quit

Результат для расширений находится в $Output/doc_classes/. Проверка получила DocsNativeProbe.xml с родителем Entity и двумя константами. Не выбирайте случайный каталог чужой документации: инструмент загружает/объединяет имеющиеся XML и пересоздаёт вывод. Это экспорт справки, не исходников движка.

Добавьте полезный текст

Заполните краткое описание, назначение класса, описания констант, методов, параметров и возвратов. Укажите единицы, условия отказа и воспроизводимый пример. Имена и типы оставьте совпадающими с регистрацией.

Для передачи описаний редактору C ABI предоставляет editor_help_load_xml_from_utf8_chars и вариант с длиной. Получите функцию через get_proc, передайте корректный UTF-8 XML; просто положить XML рядом с DLL недостаточно. Редакторский интерфейс справки не означает наличие такого окна в экспортированной игре.

После изменения регистрации сравните XML с реально загруженным классом. Отдельно откройте справку редактора и проверьте текст и ссылки: корректный XML-файл не доказывает правильное отображение.

Выполнены экспорт и разбор XML с проверкой имени, родителя и значений констант. Отображение справки в редакторе, локализация собственного XML и поставка с экспортом игры не проверялись.