Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to obtain Play! framework's Javadocs?

I'm about to start a new project and we've decided to use Play!. I've configured my IDE (Eclipse Luna) but, unfortunately, there isn't any sign of the documentation when I hover any function, class or so on.

Looking over the Internet I've came up with Play's github repo (https://github.com/playframework/playframework) and they've a documentation folder (https://github.com/playframework/playframework/tree/master/documentation).

So, how can I generate a Javadoc based on their Github documentation folder?

PS: I'm using the latest Play version, i.e. 2.3.6 where play command is replaced by activator.

like image 621
russellhoff Avatar asked Dec 09 '22 05:12

russellhoff


2 Answers

You have to pass the complete argument within quotation to the activator command. Here is what worked for me:

.\activator "eclipse with-source=true"

I guess activator otherwhise recognizes eclipse and with-source=true as two seperate commands, rather than one command with an argument.

like image 90
Florian Schlosser Avatar answered Dec 11 '22 10:12

Florian Schlosser


The docs are not clear, which is why you and I got this annoying error.

  1. cd into your web application folder
  2. $ ./activator
  3. [your project] $ eclipse with-source=true

Calling ./activator eclipse works, but ./activator eclipse with-source=true does not as it is (implied?) that it's running from within the activator shell.

Hope that helps. :)

like image 20
Joseph Lust Avatar answered Dec 11 '22 10:12

Joseph Lust