workspace-ONE-SDK-integration-samples icon indicating copy to clipboard operation
workspace-ONE-SDK-integration-samples copied to clipboard

Android SDK is completely undocumented

Open distinctdan opened this issue 11 months ago • 0 comments

Describe the bug

There needs to be documentation for the Android AirWatch SDK. Right now, there a bunch of examples of basic use cases, but they're all different, and there isn't any documentation on the actual SDK itself. This makes the SDK very difficult to use. I've had to resort to using the autocomplete in Android Studio to see what methods are available, and poking through the decompiled source of the SDK to discover what's there. I'm listing this issue as a bug because developer documentation is the bare minimum I would expect from a package, and not having it is a big problem. I know a decent amount of the SDK code has comments, a framework like Swagger could be used to autogenerate a docs site.

Documentation should be hosted on github or a standalone site and should include:

  • A list of all public classes, with an explanation of what each class does and recommended use cases.
  • Method documentation for each class
  • Property documention for each class

As an example, I'm looking for a docs site similar to https://developer.android.com/reference/android/util/Log. We need developer documentation like this to make the SDK usable.

Reproduction steps

No documentation site exists

Expected behavior

There needs to be a docs site.

Additional context

No response

distinctdan avatar Sep 18 '23 21:09 distinctdan