Описание тега headerdoc
HeaderDoc - генератор документации, разработанный и поддерживаемый Apple Inc.
1
ответ
Использование HeaderDoc с файлами.hpp вместо файлов.h
Я хочу документировать свой интерфейс. Интерфейс написан на C++ и находится в файлах.hpp. Тем не мение, headerdoc2html похоже, не знает о файлах.hpp; он ожидает.h файлы. $ headerdoc2html include / *. hpp Режим вывода HTML. Файл include/serializer.hp…
11 фев '12 в 12:01
1
ответ
Как добавить многострочный комментарий в HeaderDoc
Это мой код /** * In touchesBegan: it is considered if it was succesfull click. Automatically changes on/off images */ @interface WOC_OnOffImageButton : SKSpriteNode И когда я делаю Alt-нажмите на WOC_OnOffImageButton во всплывающем окне внутри Desc…
27 июл '14 в 08:16
1
ответ
Заголовок с протоколами делегатов - Swift и xcode 7.2
Я определил протокол и добавил документацию HeaderDoc к методу в этом протоколе. Он отображается правильно, когда я Option+ Нажмите на метод: Тем не менее, когда я Option+ щелкните реализацию внутри контроллера, который реализует этот протокол, доку…
03 фев '16 в 00:24
1
ответ
В чем преимущество использования @discussion в комментариях?
Я вижу @discussion в некоторых примерах кодов. Мой вопрос: в чем преимущество использования этого ключевого слова? Я предполагаю, что это создаст лучшую документацию. Я попытался выполнить поиск в Google и Stackru, но вместо того, чтобы использовать…
06 фев '12 в 19:30
1
ответ
Как мне избежать комментариев в Свифтском документе?
У меня есть следующий комментарий документа в Swift: /** - Trace - ↓ - Debug - ↓ - Information - ↓ - Warning - ↓ - Error */ Строка с надписью "Warning" не отображается в Xcode, потому что "- warning" - это ключево…
18 окт '16 в 22:26
2
ответа
Синтаксис комментариев документации XCode
Мне было интересно, если кто-то может объяснить, что / если есть какая-то разница между синтаксисом следующих двух комментариев в XCode. /** * comments */ /*! * comments */ Кажется, что оба позволяют Xcode отображать ваши комментарии как документаци…
04 дек '14 в 12:02
1
ответ
Как правильно документировать NSNotifications с headerdoc?
Документация для UIApplication содержит раздел Notification, в котором перечислены все связанные NSNotification s. К сожалению, файлы заголовка, доступные в XCode, не содержат соответствующие комментарии. Руководство пользователя HeaderDoc показывае…
15 фев '14 в 14:15
1
ответ
Скрипт для автоматической генерации вывода html из комментариев headerdoc из Xcode
Я использую headerDocs для документирования моего проекта Xcode. И я успешно задокументировал свой проект. но я хочу знать script за automatically generate html output из комментариев headerdoc изнутри Xcode, К информации, которую я знаю, чтобы запу…
21 янв '16 в 11:40
0
ответов
Заголовок, Objective-C, анонимный тип, ОШИБКА
Я должен сгенерировать документ для проекта Xcode Objective-C. У меня ошибка anonymous type, Я думаю, что headerdoc не нравится раздел @interface. Может кто-нибудь решить это? Мои извинения за некоторые грамматические ошибки, у меня есть проект Xcod…
14 апр '15 в 15:50
1
ответ
Документирование кода в Xcode 8
Я видел, что руководство пользователя Apple HeaderDoc было помечено как "Документ в отставке" с этим примечанием: Важный: этот документ может не представлять лучшие методы для текущей разработки. Ссылки на загрузки и другие ресурсы могут быть недейс…
26 сен '16 в 09:58
0
ответов
Objective-C - заголовок документа, а не файл кода?
Я хотел бы начать правильно документировать свой код, но не уверен, где лучше всего поместить его для чтения HeaderDoc. Я прочитал следующую фразу в документации HeaderDoc, которая заставляет меня думать, что предполагаемое местоположение (с точки з…
16 май '11 в 03:13
1
ответ
Генерировать заголовок без тега body
Мы используем headerdoc для создания html-файлов для нашей документации, которые будут отображаться как части нашего веб-фреймворка. Мы хотели бы знать, есть ли способ предотвратить теги head, html и body из html-файлов, которые генерирует заголовоч…
18 сен '14 в 04:03
1
ответ
Doxygen/headerdoc поддерживает swift 4.0?
В настоящее время мы планируем создавать документы, используя комментарии. Так что у любого есть идея, как этого добиться. Поскольку я проверил большую часть поста, что Doxygen/headerdoc не поддерживает Swift.
27 фев '18 в 12:30
0
ответов
Использование headerdoc2html в сочетании с комментариями документации, созданной XCode
У меня есть класс с комментариями к документации, которые автоматически генерируются Xcode в проекте Objective-C, например: /// Login the user /// @param email The user-provided email address /// @param password The user-provided password /// @param…
05 ноя '17 в 10:45
2
ответа
Смотрите мой собственный HeaderDoc в Xcode
Я много пишу на C#, и в Visual Studio я вижу свою документацию, когда появляется автозаполнение для описания функции и ее параметров. Доступна ли та же самая функциональность в XCode, используя мои описания HeaderDoc? Если это помогает актуальности …
23 май '11 в 22:19
0
ответов
Добавьте ссылку на другой метод в разделе @see в headerdoc.
Я пытаюсь добавить ссылку на метод UIKit в моей собственной документации. Согласно этой документации, я должен добавить @see пометить с //apple_ref/ ссылка на сайт. Вот моя документация: /** * Creates and add constraints to the receiver * * @return …
22 янв '15 в 09:53
0
ответов
Использование @link с Xcode 6
Я использую HeaderDoc для документирования своего кода и хотел бы сослаться на другие методы в документации. Я не пытаюсь сгенерировать HTML (по крайней мере, на данный момент), но я хочу, чтобы он появился на правой панели XCode. Ниже приведена док…
07 июл '15 в 23:40
3
ответа
Генераторы документации Objective-C: HeaderDoc против Doxygen против AppleDoc
Мне нужно реализовать решение для создания документации для моего рабочего места и сузить его до трех, упомянутых в названии. Мне удалось найти очень мало информации о формализованных сравнениях между этими решениями, и я надеюсь, что те из вас, кто…
11 апр '12 в 15:52
1
ответ
Как сделать отступ в документации в appledoc/HeaderDoc (для документации по блокам, которые принимают аргументы)
Я создал метод, который имеет блок в качестве параметра. Блок принимает некоторые аргументы, поэтому я хотел бы сделать отступ в документации, как это делает Apple в своих методах, имеющих похожий формат... Простой пример того, как это будет выгляде…
13 фев '15 в 19:24
3
ответа
Создание документов Apple для проекта XCODE
Я пытаюсь сгенерировать документы Apple для одного из моих проектов. Я использую следующие команды для генерации документов... headerdoc2html -o OutPutDirectory InputDirectory Я получаю следующее сообщение... Processing /Users/Ankit/Documents/Projec…
05 авг '13 в 10:59