Migliorata la documentazione per renderla più omogenea con il risultato finale in HTML

This commit is contained in:
Simone Argenziano
2014-01-25 16:44:26 +01:00
parent 6216e5af8c
commit 88942a648c
11 changed files with 200 additions and 178 deletions

View File

@@ -69,7 +69,7 @@ public class Catalogo{
/**
* Questo metodo seleziona in Menu da visualizzare in base al login effettuato dall'utente.
*
* @param userType is the type of user obtained from the main
* @param userType e' il tipo di utente ottenuto dal mail.
* @throws IOException
* @throws ParseException
* @throws ClassNotFoundException
@@ -123,12 +123,12 @@ public class Catalogo{
/**
* Questo metodo aggiunge al cataologo una nuova cena.
*
* @param in_ristorante - Nome ristorante
* @param in_localita - localit<69> del ristorante
* @param in_description - descrizione della cena
* @param in_prezzo - prezzo cena
* @param in_data_scad - data di scadenza della cena
* @param in_cene_da_vend - numero di cene da vendere
* @param in_ristorante Nome ristorante
* @param in_localita localit<69> del ristorante
* @param in_description descrizione della cena
* @param in_prezzo prezzo cena
* @param in_data_scad data di scadenza della cena
* @param in_cene_da_vend numero di cene da vendere
* @throws ParseException
* @throws FileNotFoundException
* @throws ClassNotFoundException
@@ -213,11 +213,11 @@ public class Catalogo{
/**
* Questo metodo aggiunge una nuova prestazione d'opera all'interno del catalogo.
*
* @param in_localita - localit<EFBFBD> dove <EFBFBD> operativa tale prestazione.
* @param in_descrizione - descrizione della prestazione.
* @param in_fornitore - fornitore della prestazione.
* @param in_giudizio - giudizio del fornitore.
* @param in_prezzo - prezzo della prestazione.
* @param in_localita Localita' dove e' operativa tale prestazione.
* @param in_descrizione Descrizione della prestazione.
* @param in_fornitore Fornitore della prestazione.
* @param in_giudizio Giudizio del fornitore.
* @param in_prezzo Prezzo della prestazione.
* @throws ParseException
* @throws FileNotFoundException
* @throws ClassNotFoundException
@@ -296,8 +296,8 @@ public class Catalogo{
/**
* Questo metodo velocizza la stampa dell informazioni scorrenndo l'array.
*
* @param a - ArrayList da scorrere
* @param show_offers - TexaArea dove visualizzare l'arraylist
* @param a ArrayList da scorrere
* @param show_offers TexaArea dove visualizzare l'arraylist
*/
public void print_cat_admin (ArrayList<Utilizzabile> a,JTextArea show_offers){
for(Utilizzabile deal: a)
@@ -345,9 +345,9 @@ public class Catalogo{
/**
* Stampa la lista degli oggetti utilizzabile escludendo le cene con location diversa da quelle dell'utente.
*
* @param a - ArrayList da scorrere
* @param location_user_to_compare - la localit<EFBFBD> dell'utente da confrontare con glia rticoli del catalogo
* @param show_offers - TexArea dove vsualizzare i risultati
* @param a ArrayList da scorrere
* @param location_user_to_compare La localita' dell'utente da confrontare con glia rticoli del catalogo
* @param show_offers TexArea dove vsualizzare i risultati
*/
public void print_cat_user (ArrayList<Utilizzabile> a, String location_user_to_compare, JTextArea show_offers){
for(Utilizzabile deal: a)
@@ -395,8 +395,8 @@ public class Catalogo{
/**
* Questo metodo converte una data in milli secondi.
*
* @param in - data da convertire in millisecondi
* @return - il numero in millisencodi della data passata alla funzione.
* @param in data da convertire in millisecondi
* @return Il numero in millisencodi della data passata alla funzione.
*/
protected long convert_calendar_to_int (GregorianCalendar in){
return in.getTimeInMillis();
@@ -408,7 +408,7 @@ public class Catalogo{
* - L'amministratore avra' la possibilita' di scegliere l'ordinamento in base dalla data di scadenza o ID prodotti.
* - L'utente visualizzera' le offerte attive senza possibilita' di ordinamento.
*
* @param user - username utente
* @param user username utente
* @throws FileNotFoundException
* @throws ClassNotFoundException
* @throws IOException
@@ -888,11 +888,11 @@ public class Catalogo{
/**
* Questo metodo genera una lista di offerte attive comprese tra una data iniziale ed una finale
*
* @param user - utente connesso
* @param show_offers - TextArea dove mostrare i risultati
* @param in_choice
* @param datastart - data di inizio della ricerca
* @param data_end - data finale della ricerca
* @param user Utente connesso
* @param show_offers TextArea dove mostrare i risultati
* @param in_choice scelta
* @param datastart data di inizio della ricerca
* @param data_end data finale della ricerca
* @throws FileNotFoundException
* @throws ClassNotFoundException
* @throws IOException
@@ -1373,10 +1373,10 @@ public class Catalogo{
/**
* Questo metodo visualizza gli articoli senza scadenza che sono offerti da fornitori con un giudizio superiore ad un valore preso come parametro.
*
* @param user - Utente connesso
* @param show_offers - TextArea dove mostrare i risultati
* @param in_choice
* @param votazione - votazione che i prodotti devono rispettare.
* @param user Utente connesso
* @param show_offers TextArea dove mostrare i risultati
* @param in_choice scelta
* @param votazione votazione che i prodotti devono rispettare.
* @throws FileNotFoundException
* @throws ClassNotFoundException
* @throws IOException
@@ -1861,8 +1861,8 @@ public class Catalogo{
/**
* Questo metodo visualizza le offerte scadute del catalogo.
*
* @param user - Utente connesso
* @param in_area - TextArea dove visualizzare i risultati.
* @param user Utente connesso
* @param in_area TextArea dove visualizzare i risultati.
* @throws FileNotFoundException
* @throws ClassNotFoundException
* @throws IOException
@@ -1914,9 +1914,9 @@ public class Catalogo{
}
/**
* Questo metodo permette all'utente di effettuare un acquisto
* Questo metodo permette all'utente di effettuare un acquisto.
*
* @param user - Utente connesso
* @param user Utente connesso
* @throws FileNotFoundException
* @throws ClassNotFoundException
* @throws IOException
@@ -2019,9 +2019,9 @@ public class Catalogo{
/**
* Metodo che permette la ricerca di un prodotto all'interno del catalogo in base all'id.
*
* @param user
* @param in_id - id del prodotto da ricercare
* @return - l'indice all'interno del catalogo.
* @param user Utente
* @param in_id id del prodotto da ricercare
* @return L'indice all'interno del catalogo.
* @throws FileNotFoundException
* @throws ClassNotFoundException
* @throws IOException
@@ -2102,7 +2102,7 @@ public class Catalogo{
/**
* Questo metodo visualizza lo storico degli ordini effettuati dall'utente. rende possibile l'ordinamento in base alla data di scadenza o per prezzo.
*
* @param user
* @param user - Utente
* @throws FileNotFoundException
* @throws ClassNotFoundException
* @throws IOException
@@ -2154,8 +2154,8 @@ public class Catalogo{
/**
* Metodo che si occupa della visualizzazione dello storico dell'utente.
*
* @param in . ArrayList da scorrere.
* @param area_storico - Oggetto JTextArea dove visualizzare i risultati.
* @param in ArrayList da scorrere.
* @param area_storico Oggetto JTextArea dove visualizzare i risultati.
*/
protected void print_storico (ArrayList<StoricoItem> in, JTextArea area_storico){
@@ -2170,9 +2170,9 @@ public class Catalogo{
}
/**
* Questo metodo visualizza una vacanza, descrivendone i suoi dati.
*Questo metodo visualizza una vacanza, descrivendone i suoi dati.
*
* @param dealVacanza - oggetto di tipo Vacanze che rappresenta l'offerta della Vacanza da visualizzare
* @param dealVacanza Oggetto di tipo Vacanze che rappresenta l'offerta della Vacanza da visualizzare
*/
public void visualizzaVacanza(Vacanze dealVacanza, JTextArea show)
{
@@ -2189,9 +2189,9 @@ public class Catalogo{
}
/**
* Questo metodo visualizza un Bene di consumo, descrivendone i suoi dati.
* Questo metodo visualizza un Bene di consumo, descrivendone i suoi dati.
*
* @param dealBene - oggetto di tipo beniDiConsumo che rappresenta l'offerta del bene da visualizzare
* @param dealBene Oggetto di tipo beniDiConsumo che rappresenta l'offerta del bene da visualizzare
*/
public void visualizzaBene(BeniDiConsumo dealBene, JTextArea show)
{
@@ -2210,9 +2210,9 @@ public class Catalogo{
}
/**
*
* Questo metodo visualizza una cena, descrivendone i suoi dati.
* @param dealCena - oggetto di tipo CeneInRistoranti che rappresenta l'offerta della cena da visualizzare
*
* @param dealCena Oggetto di tipo CeneInRistoranti che rappresenta l'offerta della cena da visualizzare
*/
public void visualizzaCena(CeneInRistoranti dealCena, JTextArea show)
{
@@ -2224,7 +2224,7 @@ public class Catalogo{
}
/**
* @return - restituisce il catalogo delle offerte
* @return Restituisce il catalogo delle offerte
*/
public ArrayList<Utilizzabile> getCatalogo() {
@@ -2232,10 +2232,10 @@ public class Catalogo{
}
/**
*
* Questo metodo restituisce tutti gli articoli con scadenza (vacanze, cene ristorante) che hanno scadenza tra una data iniziale e una data finale presi come parametri.
* @param dataStart - data iniziale
* @param dataEnd - data finale
*
* @param dataStart data iniziale
* @param dataEnd data finale
* @return un ArrayList contenente gli articoli compresi tra le due date inserite dall'utente
*/
public ArrayList<Utilizzabile> getDataExpire(GregorianCalendar dataStart, GregorianCalendar dataEnd)
@@ -2268,8 +2268,8 @@ public class Catalogo{
/**
* Questo metodo restituisce tutti gli articoli senza scadenza (beni, prestazioni) che sono offerti da fornitori con un giudizio superiore ad un valore preso come parametro.
*
* @param votazione - <20> la votazione minima che deve avere un fornitore.
* @return arrayDealNotExpire - Ritorna un ArrayList contente tutti gli articoli senza scadenza
* @param votazione E' la votazione minima che deve avere un fornitore.
* @return arrayDealNotExpire Ritorna un ArrayList contente tutti gli articoli senza scadenza
*/
public ArrayList<Utilizzabile> getDealNotExpire(int votazione)
{