Skip to content

Commit

Permalink
Update naming convention for commands (#106)
Browse files Browse the repository at this point in the history
* Update naming convention for application

* Update gradle file to support javafx swing library

* Update statusbar for application
  • Loading branch information
Zack-Tay authored Mar 21, 2024
1 parent 28ddf76 commit c38d7bf
Show file tree
Hide file tree
Showing 15 changed files with 22 additions and 23 deletions.
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ dependencies {
}

shadowJar {
archiveFileName = 'addressbook.jar'
archiveFileName = 'tahelper.jar'
}

defaultTasks 'clean', 'test'
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
import seedu.address.model.person.Person;

/**
* Deletes a person identified using it's displayed index from the address book.
* Deletes a person identified using it's displayed index from tahelper system.
*/
public class DeleteCommand extends Command {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import seedu.address.model.tag.Tag;

/**
* Edits the details of an existing person in the address book.
* Edits the details of an existing person in tahelper's system
*/
public class EditCommand extends Command {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
*/
public class ExitCommand extends Command {

public static final String COMMAND_WORD = "exit";
public static final String COMMAND_WORD = "/exit";

public static final String MESSAGE_EXIT_ACKNOWLEDGEMENT = "Exiting Address Book as requested ...";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
*/
public class HelpCommand extends Command {

public static final String COMMAND_WORD = "help";
public static final String COMMAND_WORD = "/help";

public static final String MESSAGE_USAGE = COMMAND_WORD + ": Shows program usage instructions.\n"
+ "Example: " + COMMAND_WORD;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import seedu.address.model.Model;

/**
* Lists all modules and their associated tutorial classes in the address book to the user.
* Lists all modules and their associated tutorial classes in TAHelper to the user.
*/
public class ListClassesCommand extends Command {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,11 @@
import seedu.address.model.Model;

/**
* Lists all persons in the address book to the user.
* Lists all persons in TAHelper to the user.
*/
public class ListStudentsCommand extends Command {

public static final String COMMAND_WORD = "/list_students";

public static final String MESSAGE_SUCCESS = "Listed all students";


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@


/**
* Parses input arguments and creates a new {@code RemarkCommand} object
* Parses input arguments and creates a new {@code AddClassCommandParser} object
*/
public class AddClassCommandParser implements Parser<AddClassCommand> {
/**
* Parses the given {@code String} of arguments in the context of the {@code RemarkCommand}
* and returns a {@code RemarkCommand} object for execution.
* Parses the given {@code String} of arguments in the context of the {@code AddClassCommandParser}
* and returns a {@code AddClassCommandParser} object for execution.
* @throws ParseException if the user input does not conform the expected format
*/
public AddClassCommand parse(String args) throws ParseException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@


/**
* Parses input arguments and creates a new {@code RemarkCommand} object
* Parses input arguments and creates a new {@code DeleteClassCommandParser} object
*/
public class DeleteClassCommandParser implements Parser<DeleteClassCommand> {
/**
* Parses the given {@code String} of arguments in the context of the {@code RemarkCommand}
* and returns a {@code RemarkCommand} object for execution.
* Parses the given {@code String} of arguments in the context of the {@code DeleteClassCommandParser}
* and returns a {@code DeleteClassCommandParser} object for execution.
* @throws ParseException if the user input does not conform the expected format
*/
public DeleteClassCommand parse(String args) throws ParseException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@
import seedu.address.model.person.StudentId;

/**
* Parses input arguments and creates a new DeleteCommand object
* Parses input arguments and creates a new DeleteStudentCommand object
*/
public class DeleteStudentCommandParser implements Parser<DeleteStudentCommand> {

/**
* Parses the given {@code String} of arguments in the context of the
* DeleteCommand
* and returns a DeleteCommand object for execution.
* DeleteStudentCommand
* and returns a DeleteStudentCommand object for execution.
*
* @throws ParseException if the user input does not conform the expected format
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/logic/parser/Prefix.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

/**
* A prefix that marks the beginning of an argument in an arguments string.
* E.g. 't/' in 'add James t/ friend'.
* E.g. 'tag/' in '/add_students name/john ...... tag/ friend'.
*/
public class Prefix {
private final String prefix;
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/model/UserPrefs.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
public class UserPrefs implements ReadOnlyUserPrefs {

private GuiSettings guiSettings = new GuiSettings();
private Path addressBookFilePath = Paths.get("data" , "addressbook.json");
private Path addressBookFilePath = Paths.get("data" , "tahelper.json");

/**
* Creates a {@code UserPrefs} with default values.
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/model/person/Email.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import static seedu.address.commons.util.AppUtil.checkArgument;

/**
* Represents a Person's email in the address book.
* Represents a Person's email in TAHelper.
* Guarantees: immutable; is valid as declared in {@link #isValidEmail(String)}
*/
public class Email {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/seedu/address/model/person/Name.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import static seedu.address.commons.util.AppUtil.checkArgument;

/**
* Represents a Person's name in the address book.
* Represents a Person's name in TAHelper.
* Guarantees: immutable; is valid as declared in {@link #isValidName(String)}
*/
public class Name {
Expand All @@ -13,7 +13,7 @@ public class Name {
"Names should only contain alphanumeric characters and spaces, and it should not be blank";

/*
* The first character of the address must not be a whitespace,
* The first character of the name must not be a whitespace,
* otherwise " " (a blank string) becomes a valid input.
*/
public static final String VALIDATION_REGEX = "[\\p{Alnum}][\\p{Alnum} ]*";
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/model/tag/Tag.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import static seedu.address.commons.util.AppUtil.checkArgument;

/**
* Represents a Tag in the address book.
* Represents a Tag in TAHelper.
* Guarantees: immutable; name is valid as declared in {@link #isValidTagName(String)}
*/
public class Tag {
Expand Down

0 comments on commit c38d7bf

Please sign in to comment.