Changeset - 637e16e57ce4
[Not reviewed]
default
0 1 0
Nathan Brink (binki) - 15 years ago 2010-10-15 22:58:42
ohnobinki@ohnopublishing.net
Fix my documentation of Section's constructor.
1 file changed with 8 insertions and 5 deletions:
0 comments (0 inline, 0 general)
class.section.php
Show inline comments
 
@@ -17,34 +17,37 @@ class Section
 
  private $bdays;	// Boolean array of meeting days
 

	
 
  /**
 
   * \brief
 
   *   Construct a Section.
 
   *
 
   * \param $letter
 
   *   The identifier (often a letter or numeral) of this section. For
 
   *   CS-262-A, this would be 'a'.
 
   * \param $prof
 
   *   The faculty person(s) who teaches this section.
 
   * \param $time_start
 
   *   The time of day when this section meets.
 
   *   The time of day when this section meets. Formatted as a string,
 
   *   with the 24-hr representation of the hour taking the first two
 
   *   characters and a two-digit representation of minutes taking the
 
   *   next two characters.
 
   * \param $time_end
 
   *   The time of day when this section's meeting is over.
 
   * \param $days
 
   *   A string representing the days that this section meets. The
 
   *   format of this string is an ordered series of numerals less
 
   *   than 5. Each numeral from 0 through 4 represents one of Monday,
 
   *   Tuesday, Wednesday, Thursday, and Friday. For example, '024'
 
   *   would be for a course which meets on Monday, Wednesday, and
 
   *   Friday.
 
   *   than or equal to 5. Each numeral from 1 through 5 represents
 
   *   one of Monday, Tuesday, Wednesday, Thursday, and Friday. For
 
   *   example, '135' would be for a course which meets on Monday,
 
   *   Wednesday, and Friday.
 
   */
 
  function __construct ($letter, $prof, $time_start, $time_end, $days)
 
  {
 
    $this->letter = $letter;
 
    $this->prof = $prof;
 
    $this->start = $time_start;
 
    $this->tend = $time_end;
 
    $this->idays = $days;
 
    $this->bdays = $this->setbdays();
 
  }
 

	
 
  function setbdays()
0 comments (0 inline, 0 general)