search

FIRST-Tech-Challenge / SkyStone

FTC SDK
https://www.firstinspires.org/robotics/ftc/what-is-first-tech-challenge
274 stars 1.04k forks source link

5.5 is missing Javadoc #259

Closed alan412 closed 3 years ago

alan412 commented 3 years ago

The 5.5 release candidate does not have Javadoc under doc/

Windwoes commented 3 years ago

v5.5 now pulls javadoc, AARs, and source JARs from bintray.

alan412 commented 3 years ago

It did not pull javadoc when I built using Android Studio 4.0.1 on a mac. I did a find . -name 'javadoc' from the root to make sure it didn't go someplace else.

On Wed, Aug 26, 2020 at 8:40 AM FROGbots-4634 notifications@github.com wrote:

v5.5 now pulls javadoc, AARs, and source JARs from bintray.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/FIRST-Tech-Challenge/SkyStone/issues/259#issuecomment-680854001, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAF3Y7YWDDCIKU45E4QKA6TSCT7C3ANCNFSM4QLYRK6Q .

Windwoes commented 3 years ago

Well, at least on my computer, Android Studio knows where to find the JavaDoc:

Screenshot from 2020-08-26 11-01-58

cmacfarl commented 3 years ago

The javadoc jar is going to be in your gradle cache. Which on windows is /.gradle/caches/modules-2/files-2.1/org.firstinspires.ftc

However, upon closer inspection it looks like gradle may not have packaged the javadocs in the jars properly. Will investigate.

The decision to move to packaging the javadoc as an artifact instead of raw files within the docs directory is intentional. This decision may be revisited prior to the release of v6.0.

cmacfarl commented 3 years ago

To help clarify where @FROGbots-4634 got that view, within AS switch your project pane view to 'Project' and then you can right click on the library in question and select 'Library Properties'

alan412 commented 3 years ago

I can see them in my Library Properties. the reason my "find" didn't find them is because they aren't in my project directory but in my gradle cache.

How do I get students to look at the JavaDoc from within AndroidStudio? (ie, the equivalent of before looking at index.html to be able to look through it)

One other advantage of the javadoc html in the repo is it makes it very easy to see API changes between versions.

On Wed, Aug 26, 2020 at 11:10 AM Craig MacFarlane notifications@github.com wrote:

To help clarify where @FROGbots-4634 https://github.com/FROGbots-4634 got that view, within AS switch your project pane view to 'Project' and then you can right click on the library in question and select 'Library Properties'

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/FIRST-Tech-Challenge/SkyStone/issues/259#issuecomment-680940655, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAF3Y747OCQVTMW335UAOADSCUQUTANCNFSM4QLYRK6Q .

cmacfarl commented 3 years ago

Also now pushed to GitHub Pages. https://first-tech-challenge.github.io/SkyStone/