Changeset 68

Timestamp:

16/04/07 15:54:44 (6 years ago)

Author:

guyru

Message:

more documantation to the code

File:

• trunk/OpenYahtzee/src/MainFrame.cpp (modified) (23 diffs)

trunk/OpenYahtzee/src/MainFrame.cpp

@@ -350 +350 @@
  * of a technical problem relating to the case an high-score was made and then
  * the user undo the last move and rescore another high-score and so on.
- * @param event 
+ * \param event 
  */
 void MainFrame::OnUndo(wxCommandEvent& event)
@@ -389 +389 @@
         m_numofplaysleft++;
 }
-///This function enables the undo button and stores the last move
+
+/**
+ * This function enables the undo button and stores the last move
+ * \param id 
+ */
 inline void MainFrame::EnableUndo(int id)
 {
@@ -398 +402 @@
 }
 
+/**
+ * Shows the high-score dialog. Connected to the Game->"Show High Score" menu item.
+ * \param event 
+ */
 void MainFrame::OnShowHighscore(wxCommandEvent& event)
 {
@@ -404 +412 @@
 }
 
+/**
+ * Shows the settings dialog. This event-handler is connected to Game->Settings
+ * menu item.
+ * \param event 
+ */
 void MainFrame::OnSettings( wxCommandEvent& event)
 {
@@ -447 +460 @@
 }
 
+/**
+ * Event handler for the Roll button. It checks the settings if it should
+ * animate the dice and then rolls them accordingly. It also checks for the
+ * status of the "keep" checkboxes.
+ * \param event 
+ */
 void MainFrame::OnRollButton (wxCommandEvent& event)
 {
@@ -498 +517 @@
 }
 
+/**
+ * This is the event-handler for all of the scoring buttons of the upper section.
+ *
+ * It gets the id of the button that called the event handler by comparing it 
+ * to the id of the aces button it figures what button was pressed, And updates
+ * the suiting score textbox (again by comparing the id to the one of the aces
+ * checbox).
+ * \param event 
+ */
 void MainFrame::OnUpperButtons (wxCommandEvent& event)
 {
@@ -515 +543 @@
 }
 
+/**
+ * Event handler for the "3 of a kind" score button.
+ * \param event 
+ */
 void MainFrame::On3ofakindButton(wxCommandEvent& event)
 {
@@ -542 +574 @@
 }
 
+/**
+ * Event handler for the "4 of a kind" score button.
+ * \param event 
+ */
 void MainFrame::On4ofakindButton(wxCommandEvent& event)
 {
@@ -569 +605 @@
 }
 
+/**
+ * Event handler for the full-house score button.
+ * \param event 
+ */
 void MainFrame::OnFullHouseButton(wxCommandEvent& event)
 {
@@ -594 +634 @@
 }
 
+/**
+ * Event handler for the small-sequence score button.
+ * \param event 
+ */
 void MainFrame::OnSmallSequenceButton(wxCommandEvent& event)
 {
@@ -616 +660 @@
 }
 
+/**
+ * Event handler for the large-sequence score button.
+ * \param event 
+ */
 void MainFrame::OnLargeSequenceButton(wxCommandEvent& event)
 {
@@ -637 +685 @@
 }
 
+/**
+ * Event handler for the yahtzee score button.
+ * \param event 
+ */
 void MainFrame::OnYahtzeeButton(wxCommandEvent& event)
 {
@@ -653 +705 @@
 }
 
+/**
+ * Evnet handler for the chance score button.
+ * \param event 
+ */
 void MainFrame::OnChanceButton (wxCommandEvent& event)
 {
@@ -672 +728 @@
 }
 
+/**
+ * Event handler for mouse clicks on the dice.
+ *
+ * When clicking on the dice this event-handler ticks the appropriate "keep" checkbox.
+ * \param event 
+ */
 void MainFrame::OnDiceClick (wxCommandEvent& event)
 {
@@ -684 +746 @@
 //********************************************
 
+/**
+ * This function clears the dice hash.
+ *
+ * The dice hash is just an array that holds how many dices have each value.
+ */
 void MainFrame::ClearDiceHash()
 {
@@ -690 +757 @@
 }
 
+/**
+ * This function handles everything related to reseting the dice rolls after scoring.
+ */
 void MainFrame::ResetRolls()
 {
@@ -701 +771 @@
 }
 
+/**
+ * This function checks for a Yahtzee Bonus situation and if one exists it scores accordingly.
+ */
 void MainFrame::YahtzeeBonus()
 {
@@ -719 +792 @@
 }
 
+/**
+ * This function checks whether we have a Yahtzee Joker situation.
+ * \return true if there is Yahtzee Joker, false otherwise.
+ */
 bool MainFrame::YahtzeeJoker()
 {
@@ -727 +804 @@
 }
 
+/**
+ * This function handles the end of game.
+ *
+ * When a game ends it calculates the total score and submit it to the high
+ * score list.
+ */
 void MainFrame::EndofGame()
 {
@@ -779 +862 @@
 }
 
+/**
+ * This function checks if a given score qualifies for the high score list and
+ * adds it to the list if it does.
+ * @param score The score submitted to the high score list.
+ */
 void MainFrame::HighScoreHandler(int score)
 {
@@ -811 +899 @@
 
 ///this function handles all the post scoring stuff such as disabling the right button.
+/**
+ * This function is always called after scoring and it handles all the post-score
+ * stuff such as reseting the dice rolls, enabling the undo button, calculating
+ * the sub-total scores and ending the game if necessary.
+ * \param id 
+ */
 void MainFrame::PostScore(int id)
 {
@@ -825 +919 @@
 }
 
+/**
+ * This function calculates the sub-total scores and should be called after
+ * every score. It does so only if this feature is requested in the settings
+ * dialog.
+ */
 void MainFrame::CalculateSubTotal()
 {
@@ -854 +953 @@
 }
 
+/**
+ * This function launches the default browser and directs it to a given url.
+ *
+ * This function extends the wxWidgets default function for this job by checking manually for
+ * different browsers if the wxWidgets' function doesn't find one. This is usually necessary 
+ * under linux when epiphany isn't installed for some unknown reason.
+ * @param link The url that the browser will go to when it stats.
+ */
 void MainFrame::LaunchBrowser (wxString link){
         if (!wxLaunchDefaultBrowser(link)){