'API doc updates'

.pubignore

@@ -8,6 +8,5 @@ scratch/
 tool/
 test/
 logo/
-example/
 
 *.log

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.1.3+9
+
+* API doc updates
+
 ## 2.1.3+8
 
 * PTZ

README.md

@@ -51,7 +51,7 @@ To use this package in your code, first add the dependency to your project:
 ```yml
 dependencies:
   ...
-  easy_onvif: ^2.1.3+8
+  easy_onvif: ^2.1.3+9
 ```
 
 If you need additional help getting started with dart, check out these [guides](https://dart.dev/guides).

lib/meta.dart

@@ -6,4 +6,4 @@ library meta;
 import 'dart:convert' show json;
 
 final pubSpec = json.decode(
-    '{"name":"easy_onvif","version":"2.1.3+8","homepage":"https://github.com/faithoflifedev/easy_onvif","environment":{"sdk":">=3.2.0 <4.0.0"},"description":"A pure Dart library designed primarily for command line automation of Onvif compatible devices, but can be used anywhere Dart is used.","dependencies":{"args":"^2.4.2","crypto":"^3.0.3","dio":"^5.4.0","ffi":"^2.1.0","html_unescape":"^2.0.0","intl":"^0.19.0","json_annotation":"^4.8.1","loggy":"^2.0.3","path":"^1.8.3","shelf":"^1.4.1","shelf_router":"^1.1.4","sprintf":"^7.0.0","universal_io":"^2.2.2","uuid":"^4.3.1","xml":"^6.3.0","xml2json":"^6.2.1","yaml":"^3.1.2"},"dev_dependencies":{"build_runner":"^2.4.7","grinder":"^0.9.5","json_serializable":"^6.7.1","lints":"^3.0.0","mustache_template":"^2.0.0","process_run":"^0.13.0","pub_semver":"^2.1.4","publish_tools":"^0.1.0+14","pubspec":"^2.3.0","test":"^1.25.0"},"executables":{"onvif":""},"repository":"https://github.com/faithoflifedev/easy_onvif.git"}');
+    '{"name":"easy_onvif","version":"2.1.3+9","homepage":"https://github.com/faithoflifedev/easy_onvif","environment":{"sdk":">=3.2.0 <4.0.0"},"description":"A pure Dart library designed primarily for command line automation of Onvif compatible devices, but can be used anywhere Dart is used.","dependencies":{"args":"^2.4.2","crypto":"^3.0.3","dio":"^5.4.0","ffi":"^2.1.0","html_unescape":"^2.0.0","intl":"^0.19.0","json_annotation":"^4.8.1","loggy":"^2.0.3","path":"^1.8.3","shelf":"^1.4.1","shelf_router":"^1.1.4","sprintf":"^7.0.0","universal_io":"^2.2.2","uuid":"^4.3.1","xml":"^6.3.0","xml2json":"^6.2.1","yaml":"^3.1.2"},"dev_dependencies":{"build_runner":"^2.4.7","grinder":"^0.9.5","json_serializable":"^6.7.1","lints":"^3.0.0","mustache_template":"^2.0.0","process_run":"^0.13.0","pub_semver":"^2.1.4","publish_tools":"^0.1.0+14","pubspec":"^2.3.0","test":"^1.25.0"},"executables":{"onvif":""},"repository":"https://github.com/faithoflifedev/easy_onvif.git"}');

lib/src/cmd/onvif_probe_command.dart

@@ -23,16 +23,19 @@ class OnvifProbeCommand extends Command {
   }
 }
 
+/// `DevicesController` is a class that is used to define the routes for an API that would allow a client to get device data from the server in cases that the client and server are on separate networks.
+/// [multicastProbe] is a reference to the multicast probe that is used to discover devices.
 class DevicesController {
   final multicastProbe = MulticastProbe();
 
+  /// Initialize the controller by probing for devices.
   DevicesController() {
     _init();
   }
 
   void _init() async => await multicastProbe.probe();
 
-  // Define our getter for our handler
+  // Define our getter for our handler which resolves to a shelf handler that will respond to client requests.
   Handler get handler {
     final router = Router();
 

pubspec.yaml

@@ -1,5 +1,5 @@
 name: easy_onvif
-version: 2.1.3+8
+version: 2.1.3+9
 homepage: https://github.com/faithoflifedev/easy_onvif
 description: A pure Dart library designed primarily for command line automation of Onvif compatible devices, but can be used anywhere Dart is used.
 repository: https://github.com/faithoflifedev/easy_onvif.git