Document Codebase

[NZSmartie]

Need to go through all the the public API and ensure it is documented for application consumption. The docs will be updated with each release.

Documentation Progress

• [ ] CoAPNet
  • [x] Coap
  • [x] CoapClient
  • [ ] CoapClientException
  • [ ] CoapEndpoint
  • [ ] CoapEndpointException
  • [ ] CoapException
  • [ ] CoapMessage
  • [x] CoapMessageCode
  • [ ] CoapMessageCodeClass
  • [ ] CoapMessageFormatException
  • [ ] CoapMessageType
  • [ ] CoapOption
  • [ ] CoapOptionException
  • [ ] CoapOptionExtensions
  • [ ] CoapPacket
  • [ ] CoapReceiveResult
  • [ ] CoapRegisteredOptionNumber
  • [ ] CoapResource
  • [ ] CoapResourceMetadata
  • [ ] CoreLinkFormat
  • [ ] ICoapConnectionInformation
  • [ ] ICoapEndpoint
  • [ ] ICoapHandler
  • [ ] ICoapTransport
  • [ ] ICoapTransportFactory
  • [ ] MessageExtensions
  • [ ] Options
    • [x] Accept
    • [x] ContentFormat
    • [x] ContentFormatType
    • [x] ETag
    • [x] Factory
    • [x] IfMatch
    • [x] IfNoneMatch
    • [x] LocationPath
    • [x] LocationQuery
    • [x] MaxAge
    • [ ] ProxyScheme
    • [ ] ProxyUri
    • [x] Size1
    • [ ] UriHost
    • [ ] UriPath
    • [ ] UriPort
    • [ ] UriQuery
  • [ ] OptionType
  • [ ] Utils
    • [ ] AsyncAutoResetEvent
    • [ ] CoapMessageUtility
    • [ ] CoapUri
• [ ] CoAPNet.Server
  • [ ] CoapHandler
  • [ ] CoapLoggingEvents
  • [ ] CoapResourceCoreListing
  • [ ] CoapResourceHandler
  • [ ] CoapServer
• [ ] CoAPNet.Udp
  • [ ] CoapConnectionInformation
  • [ ] CoapUdpEndPoint
  • [ ] CoapUdpLoggingEvents
  • [ ] CoapUdpTransport
  • [ ] CoapUdpTransportFactory