Я делаю документацию для проекта SDK. В настоящее время я делаю это с помощью DocC.
Мой вопрос в том, что я начинающий iOS-разработчик. Я не уверен, правильно ли я делаю документацию. Когда я создаю документацию, она показывает Обзор, темы и внутри тем есть разделы, такие как Bluetooth, основные расширения bluetooth и т.д. Я просто пишу коды и пояснения к ним:
Пример:
/// Возможные состояния менеджера Core Bluetooth.
public enum CBManagerState: Int, Sendable {
/// Состояние, указывающее на то, что Bluetooth в данный момент выключен.
case poweredOff = 4
/// Состояние, указывающее на то, что Bluetooth включен и доступен для использования.
case poweredOn = 5
/// Состояние, указывающее на то, что соединение с системной службой было временно потеряно.
///
/// Это состояние указывает на то, что Bluetooth пытается восстановить соединение. После восстановления соединения Core Bluetooth обновляет значение состояния.
case resetting = 1
/// Состояние, указывающее на то, что приложение не авторизовано для использования роли Bluetooth low energy.
case unauthorized = 3
/// Состояние менеджера неизвестно.
///
/// Это временное состояние. После инициализации или сброса Core Bluetooth обновляет значение состояния.
case unknown = 0
/// Состояние, указывающее на то, что это устройство не поддерживает роль центрального или клиентского Bluetooth low energy.
case unsupported = 2
}
Это правильная документация для проекта SDK? Или мне просто открыть word и написать там функции и пояснения к ним, например:
Methods:
- scanForDevice(timeout: “”)
- Запускает сканирование bluetooth с фильтром сканирования и настройками сканирования, созданными атрибутами этого класса.
- Сканирование Bluetooth отменяется по достижении заданного таймаута.
- Приложения должны использовать эту функцию только в тех случаях, когда не требуется автоматическое подключение и авторизация в функции connect().
Если вы можете помочь мне, я буду благодарен, потому что я потерялся в этой теме.
Кстати, это мой первый раз, когда я делаю документацию для проекта SDK.