SlatePermutate Changeset - 6235e830db2d · protofusion repositories

Changeset - 6235e830db2d

Parent rev.

Child rev.

[Not reviewed]

default

0 5 0

Nathan Brink (binki) - 14 years ago 2011-04-16 00:04:29
ohnobinki@ohnopublishing.net

Doxygenize some of the documentation.

5 files changed with 30 insertions and 28 deletions:

inc/class.course.inc

inc/class.page.php

inc/class.schedule.php

inc/class.section.php

inc/class.semester.inc

0 comments (0 inline, 0 general)

inc/class.course.inc

➞

Show inline comments

@@ @@ -15,20 +15,23 @@ @@
  * GNU Affero General Public License for more details.
+ *
  * You should have received a copy of the GNU Affero General Public License
  * along with SlatePermutate.  If not, see <http://www.gnu.org/licenses/>.
  */
 /**
  * \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
   private $title;       // String
   private $sections;	// Array of sections
   private $nsections;	// int

inc/class.page.php

➞

Show inline comments

@@ @@ -52,19 +52,20 @@ set_include_path(get_include_path() . PA @@
 $config_inc = dirname(__FILE__) . DIRECTORY_SEPARATOR . 'config.inc';
 if (file_exists($config_inc)) {
   require_once($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
+{
   /* Site-wide configuration options */
   private $base_title = 'SlatePermutate - Find the schedule that works for you!';
   private $doctype = 'html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"';

inc/class.schedule.php

➞

Show inline comments

@@ @@ -15,32 +15,32 @@ @@
  * GNU Affero General Public License for more details.
+ *
  * You should have received a copy of the GNU Affero General Public License
  * along with SlatePermutate.  If not, see <http://www.gnu.org/licenses/>.
  */
 //**************************************************
 // 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';
 include_once $incdir . 'class.page.php';
 require_once $incdir . 'school.inc';
 /*
  * Load a Classes -> Course converter class for the sake of the
  * Schedule::__wakeup() magic function.
  */
 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
+{
   /*
    * Variables for upgrading from saved schedules created when there
    * was a class called Classes.
    */

inc/class.section.php

➞

Show inline comments

@@ @@ -15,20 +15,18 @@ @@
  * GNU Affero General Public License for more details.
+ *
  * You should have received a copy of the GNU Affero General Public License
  * along with SlatePermutate.  If not, see <http://www.gnu.org/licenses/>.
  */
 //--------------------------------------------------
 // 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
+{
   private $letter;	// Section letter
   private $prof;	// Professor, preserved for Section::__wakeup()

inc/class.semester.inc

➞

Show inline comments

@@ @@ -21,13 +21,13 @@ @@
 $inc_dir = dirname(__FILE__) . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'inc' . DIRECTORY_SEPARATOR;
 require_once($inc_dir . 'class.course.inc');
 require_once($inc_dir . 'class.section.php');
 /**
  * \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
+{
   /**
    * \brief

0 comments (0 inline, 0 general)