Newsgroup: it.comp.java
Titolo: javadoc

Ho l'estrema urgenza di produrre la documentazione di un programma Java
tramite JavaDoc:
ho il programma Javadoc ma non ho idea di come usarlo: utilizzo Eclipse come
editor e su Google sono riuscito solo a sapere che devo scrivere :
javadoc nomefile.java
ma da qualunque parte io lo scriva non produce nulla....come posso
specificare la destinazione del file HTML che contiene la documentazione?
come faccio a generarla, soprattutto?
Vi ringrazio.
Marco

Ciao, marco!
Il giorno 13/05/2004 alle ore 17:12 hai scritto:
 m> ma da qualunque parte io lo scriva non produce nulla....come posso
 m> specificare la destinazione del file HTML che contiene la
 m> documentazione? come faccio a generarla, soprattutto?
Vai su 
www.javasoft.com
, scrivi javadoc nella casellina in alto a destra e
premi ENTER (o clicki sul pulsantino rosso). Il *PRIMO* risultato e' quello
che cerchi.
Bye
-- 
There is no ignorance; There is knowledge
http://www.maccasoft.com


Ero già andato su questo link del sito della Sun, non mi pare ci sia
spiegato.......cliccando su "esempio" ti dice che dovresti passare alla
versione 1.5 ma non ti spiega come produrre la documentazione.  :-(((

Ciao, marco!
Il giorno 13/05/2004 alle ore 17:37 hai scritto:
 m> Ero già andato su questo link del sito della Sun, non mi pare ci sia
 m> spiegato.......cliccando su "esempio" ti dice che dovresti passare alla
 m> versione 1.5 ma non ti spiega come produrre la documentazione.  :-(((
Mi stai prendendo in giro ?
Bye
-- 
There is no passion; There is serenity
http://www.maccasoft.com

Cerco di aiutarti perchč ritengo che la documentazione della sun sia
eccessivamente 'tortuosa'
rispetto a gli argomenti trattati...
E' molto semplice: quando vuoi documentare una entita' (classe, metodo,
campo), devi commentare
tali entita con commenti del tipo /** COMMENTO */.
Il doppio asterisco all'inizio del commento avvisa javadoc che quel commento
lo deve inserire nella documentazione.
Esempio: hai fatto la tua classe MiaClasse con il tuo metodo mioMetodo() e
li vuoi documentare:
/**Questa č la documentazione della classe MiaClasse*/
public class MiaClasse {
.....
/**Questa č la documentazione del metodo mio medoto.....*/
public void mioMetodo(){...}
...
}


perchè dovrei?

 li vuoi documentare:
[[cut]]
Grazie Valerio, ma il tipo di indentazione lo sapevo, quello che non so fare
è poi METTERE IN PRATICA, ovvero produrre la documentazione con i
comandi.....so commentare il sorgente con i vari tag @param, @author ecc...
ma non so poi come si fa a trasformarli in documentazione.

 ma non so poi come si fa a trasformarli in documentazione.
Domanda: sai dare un comando dalla shell?
(scusa la probabile banalita', non offenderti...ma dai tuoi messaggi non
si capisce se il tuo problema e' il comando javadoc o Eclipse)
-- 
Lucio Benfante
Java User Group Padova: 
http://www.jugpadova.it
Brainbench MVP for Java 1: 
http://www.brainbench.com
MyTranscript: 
http://www.brainbench.com/transcript.jsp?pid=167064

 ha scritto nel messaggio
news:pan.2004.05.13....@mailandnews.com...

No, non mi offendo e sě, so dare un comando da shell...ma il benedetto punto
č: che comando? il semplice javadoc nome.java non produce nessun effetto.

 č: che comando? il semplice javadoc nome.java non produce nessun effetto.
Neanche un messaggio di errore? Io ho appena provato e funziona.
(ovviamente il classpath deve essere a posto)



Ah ecco.....allora č un problema di "percorso"......in effetti il messaggio
di errore che compare dice:
Loading source files for package proviamo.java...
proviamo: warning - No source files for the package proviamo.java
Come hai fatto a specificare il classpath?



O come variabile d'ambiente (CLASSPATH) o da riga di comando, usando
l'opzione -classpath.
Ma hai dato un'occhiata alla documentazione di javadoc?
(Linux/Solaris)
http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/javadoc.html
(Windows)
http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html


 Ma hai dato un'occhiata alla documentazione di javadoc?
Sì !!!! quel benedetto sito che mi avete consigliato l'ho già letto! :-)
scusa Lucio, ma è dalle 14:00 di oggi che cerco su Google Groups e su
internet il modo di fare funzionare 'sta roba.......purtroppo non ci riesco,
non so cosa farci e domani mi scannano se non la completo:-)
Adesso ti spiego in due parole com'è la situazione:
tutto il progetto l'ho salvato in una cartella che si chiama CONJAVADOC
all'interno del disco D:
All'interno della cartella CONJAVADOC c'è anche il package PACK con tutti i
vari *.classs e *.java.
Se io scrivo:
javadoc -sourcepath d:\conjavadoc\pack -classpath d:\conjavadoc -d d:\ pack
mi dà errore dicendo: "no public or protected classses found to document"
eppure ti assicuro che è pieno di classi pubbliche :-)

 > Ma hai dato un'occhiata alla documentazione di javadoc?
[[[[cut]]]
č andato!!!!!!
adesso č tutto a posto :-))) (non trovava il package)
Ciao!

 eppure ti assicuro che č pieno di classi pubbliche :-)
Ciao Mario,
ho visto nell'altro messaggio che hai risolto, ma non hai detto come. :-)
Se a qualcun altro serve, immagino tu abbia scritto:
javadoc -classpath d:\conjavadoc -d d:\ pack
(anche se non e' tanto bello mettere il risultato nella directory radice
del disco D: :-))


 Ciao Mario,
Ops...MARCO...scusa :-)
