makekel-3.0.0 - Інтернет у хмарі

ПРОГРАМА:

ІМ'Я

makekel - створити файл опису для fpdoc.

СИНТАКСИС

makekel [--descr=ім'я файлу] [--disable-arguments] [--disable-errors] [--disable-function-
результати] [--disable-private] [--disable-protected] [--disable-seealso] [--emit-class-
роздільник] [--довідка] [--lang=мова] [--output=ім'я файлу] [--оновлення] --пакет=ім'я
--input=cmdline

Опис

makekel сканує вихідний файл модуля Free Pascal і створює файл опису скелета
для нього. Він генерує вузли для всіх ідентифікаторів, знайдених у розділі інтерфейсу пристрою,
хоча цю поведінку можна налаштувати за допомогою деяких параметрів. Він також може оновити існуючий
XML, а потім видає лише вузли для ідентифікаторів, для яких ще не існує жодного вузла.

Використання

Ви можете викликати makekel з єдиними необхідними аргументами вхід та пакет
аргументи. Він має містити принаймні ім’я файлу одиниці, для якого документація
має бути згенеровано назву пакета, до якого належить блок. Вихід з
makekel перейде до стандартного виведення за замовчуванням.

Опції

makekel має багато опцій, більшість з яких необов'язкові, у більшості випадків використовуватимуться значення за замовчуванням.

--descr=опис файлу
Цей параметр необхідно використовувати разом із оновлення варіант. Він визначає
ім'я файлу опису descfile які необхідно оновити. Зверніть увагу, що файл повинен
містять дійсний XML, або оновлення не вийде. Цей параметр можна вказати більше ніж
один раз

--disable-arguments
Якщо вказано цю опцію, makekel не видаватиме вузли для аргументів
функції та процедури. За замовчуванням для функцій випускаються вузли документації
і процедури також.

--disable-errors
За замовчуванням кожен вузол документації міститиме a Помилки також вузол (крім
ідентифікатори, де це не використовується, наприклад аргументи функції). Якщо цей варіант є
зазначено, ні Помилки буде згенерований вузол.

--disable-function-results
За замовчуванням для функцій a результат буде згенерований вузол для опису результату
функції. Якщо вказано цей параметр, вузол результату функції не буде
генерується.

--disable-private
За замовчуванням вузли документації також генеруються для приватних полів або методів
клас. якщо вказано цей параметр, генерація вузлів для приватних полів або
методи пропущено.

--вимкнено-захищено
За замовчуванням вузли документації також генеруються для захищених полів або методів
класу. якщо вказано цю опцію, генерація вузлів для захищеного
поля або методи пропущено.

--emit-class-separator
Якщо вказано цей параметр, видимий коментар з назвою класу, для якого
документація вузлів буде слідувати, вставляється між вузлами двох класів,
полегшення навігації.

--допомога Надіслати короткий текст довідки та вийти.

--input=cmd
Вхідний (джерельний) файл для обробки. Можна вказати кілька вхідних файлів. The
команда може містити дійсні параметри компілятора, наразі -Фіпат (шлях пошуку) і
-dmacro (визначити макрос) параметри розпізнаються.

--lang=мова
Встановлює мову вихідного файлу. Це в основному встановить рядки, які використовуються для
заголовки в різних частинах файлів документації (за замовчуванням вони в
англійська). На даний момент дійсні варіанти

de Німецький.

fr Французька.

nl Голландська.

--output=ім'я файлу
Цей варіант розповідає makekel куди має йти вихід. Якщо цього варіанта немає
якщо вказано, вихідні дані надсилаються на стандартний вихід (екран).

--package=назва пакета
Цей параметр є обов’язковим. Він визначає назву пакета. Будуть усі вузли
генерується всередині вузла з ім'я атрибут назва пакета.

--оновити
Вмикає режим оновлення. У цьому режимі виводом є файл, який містить лише файл
відсутні вузли для завершення документації вхідних файлів. Існуючі вузли
необхідно вказати разом із Descr аргумент. Зауважте, що вихідний файл може НЕ бути
те саме, що вхідні (описні) вузли; Необхідно вказати окремий файл (або ні
файл, і в цьому випадку вихід переходить до стандартного виводу.

Використовуйте makekel-3.0.0 онлайн за допомогою служб onworks.net