Chi programma con le librerie Qt conosce il fantastico tool Assistant, che permette di visualizzare in un’applicazione dedicata, tutta la documentazione di tali librerie. Quindi, anziché usare le scomode pagine html, si può usare Assistant.
Questo però vale solo per le Qt… ma non è vero! Un certo Hugo Parente Lima ha pensato di creare uno script per generare la documentazione Java da dare in input ad Assistant.
Il programma che consente di poter generare la suddetta documentazione si chiama Javadoc4Assistant. Vediamo quindi come utilizzare questo tool.
Prima di tutto, bisogna aver installate le Qt, quindi o le installate dal vostro gestore di pacchetti, o le scaricate dal sito della Trolltech.
A questo punto, passiamo allo scaricamento della documentazione java. La doc è scaricabile seguendo le facili indicazioni presenti in questa pagina. Voi dovete scaricare Java SE 6 Documentation.
Una volta scaricate, dovete estrarre il pacchetto zip con questo comando:
$ unzip jdk-6-doc.zip
Dopo alcuni istanti, avrete una directory “docs” contenente tutta la documentazione java. Con questo comando, la spostiamo in una zona meno ingombrante:
# mv docs /opt
Adesso è arrivato il momento di scaricare il magico tool. Per scaricare il pacchetto, cliccate qui.
Ora bisogna estrarre il tar.bz2 con questo comando:
$ tar xvjf javadoc4assistant-0.7.tar.bz2
Entriamo all’interno con:
$ cd javadoc4assistant-0.7/
e iniziamo il processo di generazione della doc. Prima di avviare il processo, bisogna assicurarci di aver installato xsltproc. Se non è installato, lanciamo:
# apt-get install xsltproc
E’ arrivato finalmente il momento di avviare il lungo processo… lungo veramente, comporterà oltre 20 min!
$ ./javadoc4assistant /opt/docs/api java
* Concating indexes...
[========================================] 100% index-27.html
* Applying XSLT... this can take some minutes (about 15-30 to the JDK documentation).
Dopo quei 20-25 min di ruzzolamento, verrà creato un file “java” sui 5.2 MB di dimensione.
Adesso, spostiamo quel file java nella directory della documentazione java (non è obbligatorio, ma lo facciamo per semplicità):
# cp java /opt/docs
Fatto questo, creiamoci uno script per poter avviare Assistant con la documentazione Java:
# vim /usr/bin/jassistant
e all’interno ci mettiamo questa riga:
assistant -profile /opt/docs/java
Dopodiché diamo i permessi di esecuzione al file appena creato con:
# chmod a+x /usr/bin/jassistant
Ora non ci manca che eseguire il comando:
$ jassistant
Ecco uno screen preso dal mio PC
