Skip to content

Javadoc in IDE #64

@EdwinVanRooij

Description

@EdwinVanRooij

Problem

When using the option to include our SDK using the .aar file, Android Studio does not show the JavaDoc comments from the source code. This is caused because the source code is not included in the .aar file, just the compiled bytecode.

To verify this, open the .aar file --> sources.jar, notice the .class extension.

Solution

We should include the original source code in the jar -- where the comments are still included -- for the IDE to notice the JavaDoc and provide assistance to the SDK user accordingly.

So far I've researched a lot on Google only to notice there's no simple way to acquire the desired effect when manually including a .aar library. The process of including source code and thus JavaDoc seems way more effective when publishing a .aar file using BinTray and then importing it using a SLoC like implementation 'com.squareup.okhttp3:okhttp:3.10.0'. In the long term, this seems much more desirable as opposed to manually downloading the SDK anyway.

Publishing the SDK to bintray and jCenter could quite likely also fix #9. Both of these issues (this one and #9) are solved by popular solutions such as the Facebook SDK, the Picasso library, and the OkHttp library.

Some attempts to automatically push the SDK to Bintray using Gradle have been performed, but unsuccessfully, see branch feat/android-javadoc-in-aar.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions