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

@@ -12,9 +12,9 @@ import java.util.Scanner;
*/
public class Access {
/**
* Questo metodo avvia la procedura di login o di registrazione dell'utente in base alla scelta fatta nel menu.
* Questo metodo avvia la procedura di login o di registrazione dell'utente in base alla scelta fatta nel menu.
*
* @param set_user_logged_here - dove memorizzare il nome dell'utente loggato o registrato
* @param set_user_logged_here dove memorizzare il nome dell'utente loggato o registrato
* @return false se Amministratore, true se Utente
*/
public static boolean get_access (LoggedUser set_user_logged_here, String in_name,String in_password,String in_location,boolean in_action) throws FileNotFoundException,IOException,ClassNotFoundException{
@@ -27,8 +27,9 @@ public class Access {
/**
* Metodo che si occupa di definire l'utente loggato (Amministratore o utente)
* @param set_user_logged_here - nome dell'utente loggato o registrato
* @return - Se avviene una registrazione viene restituito il valore true, poiche solo gli utenti possono registrarsi. Se viene effettuato un login, viene restituito il tipo di utente appena loggato.
*
* @param set_user_logged_here nome dell'utente loggato o registrato
* @return Se avviene una registrazione viene restituito il valore true, poiche solo gli utenti possono registrarsi. Se viene effettuato un login, viene restituito il tipo di utente appena loggato.
* @throws FileNotFoundException
* @throws IOException
* @throws ClassNotFoundException
@@ -50,8 +51,8 @@ public class Access {
/**
* Metodo che si occupa di finalizzare la registrazione dell'utente salvandolo sul disco.
*
* @param set_user_logged_here - nome dell'utente loggato o registrato
* @return - true poiche' e' possibile la registrazione solo degli utenti.
* @param set_user_logged_here nome dell'utente loggato o registrato
* @return true poiche' e' possibile la registrazione solo degli utenti.
* @throws FileNotFoundException
* @throws IOException
* @throws ClassNotFoundException
@@ -70,8 +71,8 @@ public class Access {
/**
* Questo metodo si occupa della ricerca dei dati dell'utente all'interno del "database".
*
* @param in_name - username dell'utente
* @param in_password - password dell'utente
* @param in_name username dell'utente
* @param in_password password dell'utente
* @return true se la ricerca ha avuto esito, false altrimenti
*/
public static boolean search_username (String in_name, String in_password) throws FileNotFoundException,IOException,ClassNotFoundException{
@@ -121,8 +122,8 @@ public class Access {
/**
* Metodo che si occupa di restituite la tipologia dell'account dell'utente connesso
*
* @param in_name - username utente
* @return tipo di account (admin o Client)
* @param in_name username utente
* @return Tipo di account (admin o Client)
*/
protected static boolean getAccountType(String in_name) throws FileNotFoundException,IOException,ClassNotFoundException{
@@ -146,8 +147,8 @@ public class Access {
/**
* Questo metodo si occupa di salvare i dati su disco dell'utente.
*
* @param in_nome - username utente
* @param in_password - password utente
* @param in_nome username utente
* @param in_password password utente
*/
protected static void store_data (String in_nome, String in_password, String in_location) throws FileNotFoundException,IOException,ClassNotFoundException{
@@ -176,7 +177,7 @@ public class Access {
/**
* Questo metodo si occupa di prelevare i dati dell'utente dal disco.
*
* @param in_nome - username utente
* @param in_nome username utente
* @return un Entry contenente tutti i dati dell'utente
* @throws FileNotFoundException
* @throws IOException
@@ -200,8 +201,8 @@ public class Access {
/**
* Questo metodo scrive su disco le modifiche apportate agli attributi di un utente. (Ad esempio bilancio incrementato)
*
* @param in_nome - username utente
* @param new_entry - Oggetto di tipo Entry
* @param in_nome Username utente
* @param new_entry Oggetto di tipo Entry
* @throws FileNotFoundException
* @throws IOException
* @throws ClassNotFoundException