tunnelkit/.jazzy.yaml

clean:
module: "TunnelKit"
author: "Davide De Rosa"
author_url: "https://github.com/passepartoutvpn/tunnelkit"

theme: fullwidth

custom_categories:
    - name: Core
      children:
        - BidirectionalState
        - ConfigurationError
        - DNSProtocol
        - DNSResolver
        - DNSRecord
        - EndpointProtocol
        - IOInterface
        - IPv4Settings
        - IPv6Settings
        - LinkInterface
        - Proxy
        - Session
        - SocketType
        - TunnelInterface
        - IPHeader
    - name: AppExtension
      children:
        - GenericSocket
        - GenericSocketDelegate
        - InterfaceObserver
        - Keychain
        - KeychainError
        - LinkProducer
        - MemoryDestination
        - NETCPSocket
        - NETunnelInterface
        - NEUDPSocket
    - name: Manager
      children:
        - VPN
        - VPNConfiguration
        - VPNProvider
        - VPNProviderIPC
        - VPNStatus
        - NetworkExtensionLocator
        - NetworkExtensionNativeLocator
        - NetworkExtensionTunnelLocator
        - NetworkExtensionVPNConfiguration
        - NetworkExtensionVPNProvider
        - MockVPNProvider
    - name: Protocols/Native
      children:
        - NativeProvider
    - name: Protocols/OpenVPN
      children:
        - OpenVPN
        - OpenVPNError
        - OpenVPNProvider
        - OpenVPNSession
        - OpenVPNSessionDelegate
        - OpenVPNTunnelProvider
Initial commit 2018-08-23 08:19:25 +00:00			`clean:`
Rebrand library metadata - Podspec - jazzy YAML 2018-08-23 10:06:47 +00:00			`module: "TunnelKit"`
			`author: "Davide De Rosa"`
Update jazzy categories 2019-05-19 10:11:26 +00:00			`author_url: "https://github.com/passepartoutvpn/tunnelkit"`
Initial commit 2018-08-23 08:19:25 +00:00
			`theme: fullwidth`

			`custom_categories:`
			`- name: Core`
			`children:`
Move in/out states to a generic struct 2018-09-09 12:55:14 +00:00			`- BidirectionalState`
Rename OptionsError to ConfigurationError 2019-04-04 10:49:21 +00:00			`- ConfigurationError`
Add DNSProtocol 2021-01-22 09:18:31 +00:00			`- DNSProtocol`
Update jazzy YAML 2019-05-23 19:54:34 +00:00			`- DNSResolver`
Add missing entities from docs 2020-06-13 15:15:27 +00:00			`- DNSRecord`
Update jazzy categories 2019-05-19 10:11:26 +00:00			`- EndpointProtocol`
			`- IOInterface`
Clean up some documentation metadata - Reorder fields in SessionProxy.Configuration* - Add new classes to .yml 2018-09-09 00:43:59 +00:00			`- IPv4Settings`
			`- IPv6Settings`
Update jazzy categories 2019-05-19 10:11:26 +00:00			`- LinkInterface`
			`- Proxy`
Take Session protocol out of OpenVPNSession Fix some doc. 2019-05-19 12:39:51 +00:00			`- Session`
Add jazzy doc to ConfigurationParser 2018-11-10 10:24:23 +00:00			`- SocketType`
Take Session protocol out of OpenVPNSession Fix some doc. 2019-05-19 12:39:51 +00:00			`- TunnelInterface`
Add missing entities from docs 2020-06-13 15:15:27 +00:00			`- IPHeader`
Update jazzy YAML 2019-05-23 19:54:34 +00:00			`- name: AppExtension`
			`children:`
			`- GenericSocket`
			`- GenericSocketDelegate`
			`- InterfaceObserver`
			`- Keychain`
			`- KeychainError`
			`- LinkProducer`
			`- MemoryDestination`
			`- NETCPSocket`
			`- NETunnelInterface`
			`- NEUDPSocket`
Document Manager subspec Refactor notifications to newer Swift convention. 2020-06-13 13:30:48 +00:00			`- name: Manager`
			`children:`
			`- VPN`
			`- VPNConfiguration`
Complete jazzy documentation 2021-08-26 17:58:39 +00:00			`- VPNProvider`
			`- VPNProviderIPC`
Document Manager subspec Refactor notifications to newer Swift convention. 2020-06-13 13:30:48 +00:00			`- VPNStatus`
Complete jazzy documentation 2021-08-26 17:58:39 +00:00			`- NetworkExtensionLocator`
			`- NetworkExtensionNativeLocator`
			`- NetworkExtensionTunnelLocator`
			`- NetworkExtensionVPNConfiguration`
			`- NetworkExtensionVPNProvider`
			`- MockVPNProvider`
Support native IKE providers (IPSec/IKEv2) 2021-06-28 08:31:41 +00:00			`- name: Protocols/Native`
			`children:`
			`- NativeProvider`
Update jazzy YAML 2019-05-23 19:54:34 +00:00			`- name: Protocols/OpenVPN`
Update jazzy categories 2019-05-19 10:11:26 +00:00			`children:`
Wrap OpenVPN entities in pseudonamespace Temporarily exclude AppExtension and tests. 2019-05-19 12:04:41 +00:00			`- OpenVPN`
Prefix top-level entities with OpenVPN* 2019-05-19 12:19:23 +00:00			`- OpenVPNError`
Fix context of StandardVPNProvider Not generic, rather an OpenVPN implementation. - Move to OpenVPN subspec - Rename to OpenVPNProvider - Depend OpenVPN on Manager 2020-11-14 17:08:09 +00:00			`- OpenVPNProvider`
Prefix top-level entities with OpenVPN* 2019-05-19 12:19:23 +00:00			`- OpenVPNSession`
			`- OpenVPNSessionDelegate`
Rename provider class to OpenVPNTunnelProvider 2019-05-23 19:59:15 +00:00			`- OpenVPNTunnelProvider`