Skip to content

Documentation missing for v2+ #1

Open
@doug-textnow

Description

@doug-textnow

The PerimeterX mobile SDK aar in JFrog is obfuscated and there is no accompanying javadoc or sources aar. This makes it difficult to use. In addition, the android sdk integration guide on the web is written for an older version of the SDK.

The code sample in this repo helps some, but still leaves questions. For example, what is the purpose of the boolean 4th parameter in PerimeterX.INSTANCE.start(application, appId, this, true)?

The following would make the SDK more usable:

  1. Exclude the public API from obfuscation/minification. You want to obfuscate in order to annoy the bad-guys who would try to circumvent what PerimeterX does? Cool, apply obfuscation to the internal secret-sauce. But no need to frustrate legitimate customers in the process. The API surface that's designed to be invoked from customer code should retain descriptive parameter names, comments & docs.

  2. Add javadoc aars to the JFrog repository. Being able to hover over a method name in the IDE and see what parameters are required and what the do really lowers the barrier to integration.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions