autogsdoc - Інтернет у хмарі

ПРОГРАМА:

ІМ'Я

autogsdoc - генератор документації API GNUstep і конвертер XML->HTML

СИНТАКСИС

autogsdoc [-Файли ім'я файлу] [-Створити HTML ТАК|ні] [-Чистий так|НІ] [-Чисті шаблони
так|НІ] [-Ігнорувати залежності так|НІ] [-MakeDependencies так|НІ] [-Показати залежності так|НІ]
[-HeaderDirectory шлях] [-Довідник документації шлях] [-Заявили розташування] [-Проект
назву] [-Стандарти так|НІ] [-DocumentAllInstanceVariables так|НІ]
[-Змінні екземпляра документа ТАК|ні] [-InstanceVariablesAtEnd так|НІ] [-Шаблон констант
ім'я файлу] [-Шаблон функцій ім'я файлу] [-Шаблон макросів ім'я файлу] [-TypedefsTemplate
ім'я файлу] [-Шаблон змінних ім'я файлу] [-Системні проекти рядок] [-LocalProjects рядок]
[-Проекти dictString] [-Детальніше так|НІ] [-Попереджайте так|НІ] [- WordMap dictString] [файли]

ОПИС

Інструмент autogsdoc — це утиліта командного рядка, яка допомагає розробникам створювати посилання
документація для API GNUstep. Це також дозволяє розробникам писати й підтримувати інші
документації в XML і конвертувати її в HTML. Детальніше, autogsdoc:

- Витягувати спеціальні коментарі, що описують загальнодоступні інтерфейси класів, категорій,
протоколи, функції та макроси з вихідного коду Objective C (файли заголовків і
за бажанням вихідні файли) у файли GSDoc XML.

- Перетворюйте файли GSDoc XML, створені з вихідного коду або написані вручну
розробників, у HTML.

- Створюйте індекси на основі наборів файлів GSDoc XML, а також конвертуйте їх у HTML.

Найпоширенішим використанням цього є виконання команди з одним або кількома іменами файлів заголовка as
аргументи ... інструмент автоматично аналізуватиме відповідні вихідні файли
каталог як заголовки (або поточний каталог, або каталог, зазначений за допомогою
DocumentationDirectory за замовчуванням) і створювати файли GSDoc і HTML як вихідні дані. На краще
Результати цього режиму мають бути запущені з каталогу, що містить вихідні файли. (Примітка
що, оскільки C є підмножиною Objective C, цей інструмент може працювати з документуванням функцій і
інші структури C у звичайному джерелі C.)

Файли GSDoc також можуть бути надані безпосередньо додатково або окремо, і будуть перетворені
до HTML. Дивіться HTML-документацію GSdoc або gsdoc(7) сторінка керівництва з інформацією про
Формат GSdoc.

Нарешті, файли HTML можуть бути подані в командному рядку. Перехресні посилання на інші частини
Кодова документація, знайдена в них, буде переписана на основі того, що знайдено в
проект на даний момент.

ДЖЕРЕЛО КОД МАРКУП

Синтаксичний аналізатор вихідного коду автоматично створить документи GSdoc із переліком методів
класів, знайдених у вихідних файлах, і включатиме текст із спеціально відформатованого
коментарі з вихідних файлів.

Будь-який коментар, що починається з косої риски та два зірочки, а не звичайну косу риску та одинарну
asterisk, вважається розміткою GSDoc, яка буде використовуватися як опис класу або методу
слідуючи йому. Цей текст коментаря переформатовано, а потім вставлено у вихідні дані.
Якщо кілька коментарів пов’язано з одним елементом, вони об’єднуються разом за допомогою a
розрив рядка ( ) між кожним, якщо необхідно.

Інструмент можна легко використовувати для документування програм, а також бібліотек, просто надавши його
ім'я вихідного файлу, що містить функцію main() програми - він приймає
спеціальні коментарі з цієї функції та обробляє їх спеціально, вставляючи як a
розділ в кінці першої глави документа (він створює першу главу, якщо
необхідно).

Опції описані в розділі Аргументи та Типово нижче.

EXTRA МАРКУП

Бувають випадки, коли виконується спеціальна додаткова обробка, переважно в
перший коментар, знайдений у вихідному файлі, з якого можуть бути різні фрагменти розмітки GSDoc
витягнути та помістити у відповідні місця у вихідному документі -

Autogsdoc Джерело:
У будь-якому рядку, де Autogsdoc Джерело: знайдено, залишок рядка приймається як a
Використовувати назву вихідного файлу замість того, щоб робити припущення, що кожен файл .h
processed використовує файл .m з такою ж назвою. Ви можете надати декілька Autogsdoc Джерело:
рядки, де заголовний файл оголошує елементи, визначені в кількох вихідних файлах.
Якщо ім’я файлу є абсолютним, воно використовується так само, як надано. Якщо, з іншого боку, це a
відносного шляху, програмне забезпечення спочатку шукає вихідний файл відносно розташування
файлу заголовка, а якщо там не знайдено, відносно поточного каталогу в якому
autogsdoc запущено, і, нарешті, відносно каталогу, визначеного файлом
Каталог документів за замовчуванням.


Анотація змісту документа ... розміщена в заголовку виходу GSdoc.


Опис автора коду - може бути повторений для вирішення випадку, коли a
документ має кількох авторів. Розміщується в голові виходу GSdoc. Як допоміжний засіб для
читабельність джерела, виконується деяка спеціальна додаткова обробка, пов'язана з
автор документа - будь-який рядок форми «Автор: ім'я ' або 'Від:
ім'я ", або "Автор: ім'я" або "За: ім'я" буде розпізнано і
перетворений на ан автор елемент, можливо, що містить an e-mail елемент.


Розміщується у виводі GSDoc безпосередньо перед кінцем тіла документа - призначений
використовуватися для додатків, покажчика тощо.


Розміщується безпосередньо перед будь-якою створеною документацією класу ... призначеної для використання
щоб надати загальний опис того, як працює код, який документується. Будь-який
документація для функції main() програми вставлена ​​у вигляді розділу в кінці
цієї глави.


Авторські права на зміст документа ... розміщені в головній частині виходу GSdoc.
Для зручності читання джерела є спеціальна додаткова обробка
виконано - будь-який рядок у формі "Текст авторського права (C)" буде розпізнано та перетворено
до скопіювати елемент.


Дата перегляду документа ... розміщена в головній частині виходу GSdoc. Якщо
це опущено, інструмент спробує створити значення з тегу дати RCS (якщо
доступно).


Вставлено в документ на початку тіла ... призначеного для забезпечення
вступні або змістові сторінки тощо.


Заголовок документа ... розміщується в заголовку виводу GSdoc. Якщо це пропущено
інструмент створить власну (ймовірно погану) назву - тому ви повинні включити це
розмітка вручну.


Ідентифікатор версії документа ... розміщений у заголовку виводу GSdoc. Якщо
це опущено, інструмент спробує створити значення з тегу RCS Revision (if
доступно).

NB Щойно описана розмітка може використовуватися в документації класу, категорії або протоколу
... якщо так, він витягується та обертається навколо решти документації для класу
як глава класу. Решта документації класу зазвичай вставляється в
кінець глави, але замість цього може бути замінений на псевдо-
елемент всередині елемент.

МЕТОД МАРКУП

У коментарях, які використовуються для надання тексту для опису методу, є така розмітка
вилучено з тексту та оброблено спеціально -


Метод позначений як призначений ініціализатор для класу.


Метод позначений як такий, який підкласи повинні перевизначати (наприклад, абстрактний
метод).


Метод позначено як такий, який мають підкласи $NOT замінити.


Розмітка знімається з опису і розміщується після це у виводі GSdoc -
так що метод описується як відповідний (або невідповідний) зазначеному
стандарти

АВТОМАТИЗОВАНА МАРКУП

Як правило, текст у коментарях переформатовано, щоб стандартизувати та мати гарний відступ...
переформатування є НЕ виконується над будь-яким текстом всередині an елемент. Коли текст є
переформатований, він розбивається на розділені пробілами «слова», які потім піддаються
трохи додаткової обробки...

Деякі добре відомі константи, такі як ТАК, НІ та нуль, укладені в ...
розмітка.

Назви аргументів методів в описах методів вкладені в ...
</ var> розмітка.

Назви методів (починаються з плюса або мінуса) вкладені ...
розмітка. Наприклад, "-init" (без лапок) буде загорнуто в посилання GSDoc
елемент, щоб вказати на метод init поточного класу або, якщо тільки один відомий клас
мав метод ініціалізації, він посилався б на метод цього класу. Зверніть увагу на той факт, що
Ім'я методу має бути оточене пробілом для розпізнавання (хоча кома,
крапка або крапка з комою в кінці специфікатора буде діяти як пробіл).

Специфікатори методів, включаючи імена класів (починаючи і закінчуючи квадратними дужками)
укладені в ... розмітка. наприклад, '[NSObject-init]', створить a
посилання на метод ініціалізації NSObject (або власне клас, або будь-який його
категорії), тоді як '[(NSCopying)-copyWithZone:]' створює посилання на метод у
протокол NSCCopy. Зверніть увагу, що між квадратними дужками не повинно бути пробілів
в цих специфікаторах. Назви протоколів укладаються в круглі дужки, а не в символі
звичайні кутові дужки, оскільки GSDoc є мовою XML, а XML обробляє кут
дужки спеціально.

Назви функцій (закінчуються на "()"), крім "main()", вкладені в ...
розмітка. Наприклад, "NSLogv()" (без лапок) буде загорнуто в GSDoc
посилальний елемент, який вказує на документацію функції NSLog. Зверніть увагу на факт
що ім’я функції має бути оточене пробілом (хоча комою, крапкою або
крапка з комою в кінці специфікатора також буде діяти як термінатор пробілу).

АРГУМЕНТИ І ЗА УМОВНЯМИ

Інструмент приймає певні параметри користувача за замовчуванням (які, звісно, ​​можна надати як командний рядок
аргументи, додаючи '-' перед ім'ям за замовчуванням і надаючи значення після цього, як у
-Очистити ТАК):

Очистити
Якщо це логічне значення встановлено на ТАК, то замість створення документації,
інструмент видаляє всі файли GSDoc, згенеровані в проекті, і всі згенеровані файли html
з них (а також будь-які, які будуть створені з перерахованих файлів GSDoc
явно), і нарешті видаляє файл індексу проекту. Єдиний виняток з цього
це файли шаблону GSDoc (тобто ті, які вказані за допомогою "-ConstantsTemplate ...",
Аргументи "-FunctionsTemplate ..." тощо) не видаляються, якщо CleanTemplates
прапор встановлений.

CleanTemplates
Цей прапорець визначає, чи потрібно видаляти файли шаблону GSDoc разом з іншими
файлів, коли вказано параметр Очистити. За замовчуванням вони не видаляються
... оскільки ці шаблони, можливо, були створені вручну та просто вставляли дані
в них.

Шаблон констант
Вкажіть ім'я шаблонного документа, в який подається документація про константи
слід вставляти з усіх файлів у проекті. Це корисно, якщо константи в
вихідний код розкиданий по багатьох файлах, і вам потрібно згрупувати їх в один
місце. Ви несете відповідальність за те, щоб основний шаблон документа (в який
індивідуальна постійна документація) містить всю іншу інформацію про вас
хочете, але для зручності autogsdoc створить простий шаблон (який ви можете
потім редагувати) для вас, якщо файл не існує. Введення відбувається негайно
перед назад елемент (або, якщо він не існує, безпосередньо перед кінцем
тіло елемент) у шаблоні.

Задекларовано
Укажіть, де заголовки мають бути задокументовані як знайдені. Вироблена справжня назва
в документації формується шляхом додавання останнього компонента до імені файлу заголовка
до значення цього за замовчуванням. Якщо це значення за замовчуванням не вказано, повне ім’я
заголовного файлу (як зазначено в командному рядку), зі значенням HeaderDirectory за замовчуванням
на початку, використовується. Типовим використанням цього може бути '"-Оголошений фундамент"', коли
створення документації для базової бібліотеки GNUstep. Це призведе до того, що
документація про те, що NSString оголошено в "Foundation/NSString.h"

DocumentAllInstanceVariables
Цей прапор дозволяє створювати документацію для всіх змінних екземпляра. зазвичай,
будуть задокументовані лише ті, які явно оголошені «загальнодоступними» або «захищеними».

DocumentInstanceVariables
Цей прапорець дозволяє повністю вимкнути документацію, наприклад змінні.
Зазвичай, явно оголошені 'public' або 'protected' змінні екземпляра будуть
документально.

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

Каталог документів
Може використовуватися для вказівки каталогу, в який має бути розміщена створена документація.
Якщо це не встановлено, вихідні дані розміщуються в поточному каталозі. Цей каталог також є
використовується як останній засіб для пошуку вихідних файлів (а не заголовків), і, що більш важливо, це
використовується як перший та тільки вдатися до пошуку будь-яких файлів .gsdoc, які передаються
командний рядок. Будь-яка інформація про шлях до цих файлів є віддалений і вони є
шукали в «DocumentationDirectory» (хоча вони, можливо, і не були
автоматично генерується).

Файли
Вказує ім’я файлу, що містить список імен файлів, як масив списку властивостей
(ім'я1, ім'я2,...) формат. Якщо це є, імена файлів у списку аргументів програми
ігноруються, а імена в цьому файлі використовуються як список імен для обробки.

Функції Шаблон
Вкажіть ім'я шаблонного документа, до якого функціонує документація про
слід вставляти з усіх файлів у проекті. Це корисно, якщо джерело функції
код розкиданий по багатьох файлах, і вам потрібно згрупувати його в одному місці. Ти є
відповідає за те, щоб основний шаблон документа (до якого особи
документація функції вставлена) містить всю іншу інформацію, яку ви бажаєте, але
для зручності autogsdoc згенерує простий шаблон (який потім ви можете редагувати)
для вас, якщо файл не існує. Вставка відбувається безпосередньо перед назад
елемент (або, якщо він не існує, безпосередньо перед кінцем тіло елемент) в
шаблон.

Згенерувати HTML
Може використовуватися, щоб указати, чи потрібно генерувати вихідний HTML. За замовчуванням – ТАК.

HeaderDirectory
Може використовуватися для визначення каталогу, у якому буде здійснюватися пошук заголовних файлів. При постачанні,
це значення додається до відносних імен заголовків, інакше до відносних імен заголовків
інтерпретуються відносно поточного каталогу. Заголовні файли вказано як абсолютні
на шляхи не впливає це умовчання.

IgnoreDependencies
Логічне значення, яке може використовуватися для визначення того, що програма повинна ігнорувати файл
час модифікації та відновлення файлів у будь-якому випадку. Надається для використання разом з
система «make», яка, як очікується, сама керуватиме перевіркою залежностей.

Локальні проекти
Це значення використовується для контролю автоматичного включення локальних зовнішніх проектів до
система індексації для генерації перехресних посилань у кінцевому документі. Якщо
встановлено значення «Немає», тоді посилання на локальні проекти не виконуються, інакше «Локальний»
У каталозі документації GNUstep здійснюється рекурсивний пошук файлів із '.igsdoc'
розширення, і використовується інформація про індексацію з цих файлів. Цінність цього
рядок також використовується для створення імен файлів у перехресному посиланні ... якщо це файл
порожній рядок, шлях для використання передбачається як файл у тому самому каталозі, де
Знайдено файл igsdoc, інакше він використовується як префікс до імені в індексі. NB.
Будуть місцеві проекти з такою ж назвою, що й проект, який зараз документується НЕ
бути включені цим механізмом. Якщо ви хочете включити такі проекти, ви повинні це зробити
явно використовуючи -Проекти ...

Макроси шаблон
Вкажіть ім’я шаблонного документа, в який має бути документація про макроси
вставлятися з усіх файлів у проекті. Це корисно, якщо код макросу розсіяний
навколо багатьох файлів, і вам потрібно згрупувати їх в одне місце. Ви відповідаєте за
забезпечення того, щоб основний шаблон документа (в який внесена окрема макродокументація
вставлено) містить всю іншу необхідну інформацію, але для зручності
autogsdoc згенерує для вас простий шаблон (який ви зможете відредагувати).
файл не існує. Вставка відбувається безпосередньо перед назад елемент (або якщо
що не існує, безпосередньо перед кінцем тіло
елемент) у шаблоні.

MakeDependencies
Ім’я файлу, яке буде використовуватися для виведення інформації про залежності для make. Це займе
форма переліку всіх заголовних і вихідних файлів, відомих для проекту як залежності від
назву проекту (див. «Проект»).

Проекти
Може використовуватися для вказівки назви цього проекту ... визначає назву індексу
довідковий файл, створений як частина документації для надання інформації, що дозволяє
інші проекти для перехресних посилань на елементи цього проекту.

Завдання
Це значення може бути надано як словник, що містить шляхи до igsdoc
індексні/довідкові файли, які використовуються зовнішніми проектами, а також значення, які будуть використані для відображення
імена файлів, знайдені в індексах. Наприклад, якщо файл індексу проекту (igsdoc).
каже, що клас 'Foo' знайдено у файлі 'Foo' і шлях, пов'язаний з
цей індекс проекту – '/usr/share/doc/proj', тоді згенерований вихідний HTML може посилатися
клас знаходиться в '/usr/share/doc/prj/Foo.html' . Зверніть увагу, що словник може бути
наведено в командному рядку за допомогою стандартного формату PropertyList (не XML
форматі OS X), використовуючи крапку з комою як роздільники рядків і укладаючи її в одинарний
цитати.

Показати залежності
Логічне значення, яке може використовуватися, щоб указати, що програма повинна реєструвати, які файли
відновлюються через їхню залежність від інших файлів.

Стандарти
Логічне значення, яке використовується для визначення того, чи повинна програма вставляти інформацію про
дотримання стандартів в документації. Це слід використовувати тільки тоді, коли
документування самих бібліотек та інструментів GNUstep, оскільки передбачається, що код
документований є частиною GNUstep і, можливо, відповідає стандарту OpenStep
або реалізує методи, сумісні з MacOS-X.

SystemProjects
Це значення використовується для контролю автоматичного включення зовнішніх проектів системи
система індексації для генерації перехресних посилань у кінцевому документі. Якщо
встановлено на «Немає», тоді посилання на системний проект не виконуються, інакше «Система»
У каталозі документації GNUstep здійснюється рекурсивний пошук файлів із '.igsdoc'
розширення, і використовується інформація про індексацію з цих файлів. Цінність цього
рядок також використовується для створення імен файлів у перехресному посиланні ... якщо це файл
порожній рядок, шлях для використання передбачається як файл у тому самому каталозі, де
Знайдено файл igsdoc, інакше він використовується як префікс до імені в індексі. NB.
Системні проекти з такою ж назвою, що й проект, який зараз документується, будуть НЕ
бути включені цим механізмом. Якщо ви хочете включити такі проекти, ви повинні це зробити
явно використовуючи -Проекти ...

TypedefsTemplate
Вкажіть ім’я шаблонного документа, до якого має бути документація про typedefs
вставлятися з усіх файлів у проекті. Це корисно, якщо є вихідний код typedef
розкидані навколо багатьох файлів, і вам потрібно згрупувати їх в одному місці. Ти є
відповідає за те, щоб основний шаблон документа (до якого особи
вставлена ​​документація typedef) містить всю іншу необхідну інформацію, але як
зручний autogsdoc згенерує простий шаблон (який потім ви можете редагувати).
ви, якщо файл не існує. Вставка відбувається безпосередньо перед назад
елемент (або, якщо він не існує, безпосередньо перед кінцем тіло елемент) в
шаблон.

Up Рядок, що використовується для надання імені, яке буде використовуватися в посиланні "вгору" зі згенерованого GSDoc
документи. Зазвичай це має бути ім’я файлу, який містить індекс файлу
зміст проекту. Якщо цей рядок відсутній або для нього встановлено порожній рядок, "вгору" немає
посилання буде надано в документах.

Шаблон змінних
Вкажіть ім'я шаблонного документа, в який міститься документація про змінні
слід вставляти з усіх файлів у проекті. Це корисно, якщо джерело змінне
код розкиданий по багатьох файлах, і вам потрібно згрупувати його в одному місці. Ти є
відповідає за те, щоб основний шаблон документа (до якого особи
змінна документація вставлена) містить всю іншу інформацію, яку ви хочете, але
для зручності autogsdoc згенерує простий шаблон (який потім ви можете редагувати)
для вас, якщо файл не існує. Вставка відбувається безпосередньо перед назад
елемент (або, якщо він не існує, безпосередньо перед кінцем тіло елемент) в
шаблон.

Verbose
Логічне значення, яке використовується для визначення того, чи потрібно виводити детальний налагодження/попередження
виробляється.

Попереджати
Логічне значення, яке використовується для визначення того, чи потрібно виводити стандартне попередження (наприклад, звіт про
недокументовані методи).

WordMap
Це значення є словником, який використовується для зіставлення ідентифікаторів/ключових слів, знайдених у вихідних файлах
іншими словами. Як правило, вам не доведеться це використовувати, але іноді це корисно
щоб уникнути заплутування аналізатора використанням макросів препроцесора C. Ти можеш
ефективно перевизначити макрос на щось менш заплутане. Значення, яке ви відображаєте
ідентифікатор має бути одним із - Інший ідентифікатор, Порожній рядок - значення
ігнорується, дві косі риски ('//') - решта рядка ігнорується. Зверніть увагу, що словник
можна вказати в командному рядку за допомогою стандартного формату PropertyList (не файлу
XML формат OS X), використовуючи крапку з комою як роздільники рядків і укладаючи його в одинарний
цитати.

МІЖДОКУМЕНТ ПОСИЛАННЯ

Значення за замовчуванням «Вгору» використовується для вказівки імені документа, який слід використовувати як
посилання "вгору" для будь-яких інших використаних документів. Це ім’я не повинно включати шлях або розширення.
Як правило, документ, на який посилається цей стандарт, має бути відредагованим вручну документом GSdoc
який повинен мати задню частину, що містить індекс проекту. наприклад


<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.3//EN"
"http://www.gnustep.org/gsdoc-1_0_3.xml">


Довідка про мій проект




Довідка про мій проект

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