diff --git a/inc/class.course.inc b/inc/class.course.inc --- a/inc/class.course.inc +++ b/inc/class.course.inc @@ -18,14 +18,17 @@ * along with SlatePermutate. If not, see . */ -/** - * \file - * This file represents a course (formerly class). It stores - * the section associated with the course. - */ - include_once 'class.section.php'; +/** + * \brief + * Represents a Course containing multiple Sections. + * + * A course is associated with a certain subject material. For each + * course, a student has to choose a particular Section to + * take. Courses are not associated with professors or meeting times, + * those are in the realm of the Section and SectionMeeting. + */ class Course implements IteratorAggregate { private $name; // String diff --git a/inc/class.page.php b/inc/class.page.php --- a/inc/class.page.php +++ b/inc/class.page.php @@ -55,13 +55,14 @@ if (file_exists($config_inc)) { } -//************************************************** -// class.page.php Author: Ethan Zonca -// -// Provides an interface for generating a styled -// XHTML page, supporting modular script inclusion -// and other various features -//************************************************** +/** + * \brief + * Produces XHTML output for the user and helps with other browser + * interaction. + * + * Supports styled XHTML pages, modular script inclusion, and other + * various features. + */ class page { diff --git a/inc/class.schedule.php b/inc/class.schedule.php --- a/inc/class.schedule.php +++ b/inc/class.schedule.php @@ -18,14 +18,6 @@ * along with SlatePermutate. If not, see . */ -//************************************************** -// class.schedule.php Author: Nathan Gelderloos -// -// Represents a schedule of a week. Stores the -// classes that are part of that week and calculates -// all the possible permutations. -//************************************************** - $incdir = dirname(__FILE__) . DIRECTORY_SEPARATOR; include_once $incdir . 'class.course.inc'; include_once $incdir . 'class.section.php'; @@ -38,6 +30,14 @@ require_once $incdir . 'school.inc'; */ require_once $incdir . 'class.classes_convert.inc'; +/** + * \brief + * Finds possible Section combinations for a user's given Courses + * and stores and displays the results. + * + * Represents a schedule of a week. Stores the classes that are part + * of that week and calculates all the possible permutations. + */ class Schedule { /* diff --git a/inc/class.section.php b/inc/class.section.php --- a/inc/class.section.php +++ b/inc/class.section.php @@ -18,14 +18,12 @@ * along with SlatePermutate. If not, see . */ -//-------------------------------------------------- -// class.section.php Author:Nathan Gelderloos -// -// Represents a section of a class. -//-------------------------------------------------- - require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . 'class.section_meeting.inc'; +/** + * \brief + * Represent a Section associated with a Course. + */ class Section { diff --git a/inc/class.semester.inc b/inc/class.semester.inc --- a/inc/class.semester.inc +++ b/inc/class.semester.inc @@ -24,7 +24,7 @@ require_once($inc_dir . 'class.section.p /** * \brief - * Identifies a school semester and acts as a container for courses + * Identifies a school semester and acts as a container for Course s * offered in a semester. */ class Semester