Commit bebed543 authored by zhuym1219's avatar zhuym1219
Browse files

update doc according to issues

parent 322aa40e
Loading
Loading
Loading
Loading
+2 −0
Original line number Diff line number Diff line
@@ -7,6 +7,8 @@ public class Course {
        PASS_OF_FAIL, HUNDRED_MARK_SCORE
    }

    //A courseId is valid if it has been added to the system with addCourse()
    // do not check whether it is 'CS307' or '307CS'
    public String id;
    public String name;
    public int credit;
+4 −0
Original line number Diff line number Diff line
@@ -18,6 +18,10 @@ public class CourseSearchEntry {
    /**
     * List all time conflicting courses' full name, sorted alphabetically.
     * Course full name: String.format("%s[%s]", course.name, section.name)
     *
     *  Course conflict is when multiple sections belong to the same course.
     *  Time conflict is when multiple sections have time-overlapping classes.
     *  Note that a section is both course and time conflicting with itself!
     */
    public List<String> conflictCourseNames;
}
+3 −1
Original line number Diff line number Diff line
@@ -12,7 +12,9 @@ import java.util.Objects;
public class CourseSectionClass {
    public int id;// it is the id of course section class
    public Instructor instructor;
    public DayOfWeek dayOfWeek;
    public DayOfWeek dayOfWeek;// We ensure the test semesters begin with Monday.
    // the given elements in weekList are sorted.
    // CourseSectionClasses in same courseSection may have different weeklist.
    public List<Short> weekList;
    //the time quantum of start and end.
    //For example: classStart is 3 while classEnd is 4
+7 −0
Original line number Diff line number Diff line
@@ -2,8 +2,15 @@ package cn.edu.sustech.cs307.dto;

import java.sql.Date;

/**
 * In our benchmark, there won't be overlapped semesters.
 */
public class Semester {
    public int id;
    public String name;
    /**
     * If the end date is before the start date, you need give an illegal Argument Error
     * If the date is ridiculous, such as 1900-1-1 or 3000-1-1, it should not give error.
     */
    public Date begin, end;
}
+6 −0
Original line number Diff line number Diff line
package cn.edu.sustech.cs307.dto;

public abstract class User {

    public int id;
    /**
     * A user's full name is: first_name || ' ' || last_name, if both first name and last name are alphabetical, otherwise first_name || last_name.
     *
     * For example, if a user has first name David and last name Lee then the full name is David Lee; if another user has first name 张 and last name 三, the full name is 张三.
     */
    public String fullName;
}
Loading