From 0c46153be3e4dcef5f58f62b9854681ea746b9e6 Mon Sep 17 00:00:00 2001 From: Valentino Orlandi Date: Mon, 28 Nov 2022 00:12:54 +0100 Subject: [PATCH] Updated documentation files --- docs/html/annotated.html | 91 +++---- docs/html/classCrissCross.html | 6 +- docs/html/classFood-members.html | 96 +++++++ docs/html/classFood.html | 158 +++++++++++ docs/html/classSnake-members.html | 23 +- docs/html/classSnake.html | 206 ++------------ docs/html/classSnake.png | Bin 390 -> 596 bytes docs/html/classSnakeGame-members.html | 99 +++++++ docs/html/classSnakeGame.html | 251 ++++++++++++++++++ docs/html/classSnakeGame.png | Bin 0 -> 471 bytes docs/html/classes.html | 6 +- .../dir_3a0bb91303b349fae8fa9b3a632cefff.html | 8 + ...dir_4216b1c8c447536616ff22cc879c2748.html} | 15 +- .../dir_9435ca5cf080eab6f8746f45b27d7231.html | 87 ++++++ docs/html/functions_b.html | 1 + docs/html/functions_c.html | 3 +- docs/html/functions_d.html | 4 +- docs/html/functions_enum.html | 2 +- docs/html/functions_eval.html | 7 +- docs/html/functions_f.html | 1 + docs/html/functions_func_c.html | 2 +- docs/html/functions_func_d.html | 1 + docs/html/functions_func_g.html | 1 + docs/html/functions_func_i.html | 3 +- docs/html/functions_func_k.html | 2 +- docs/html/functions_func_m.html | 1 + docs/html/functions_func_o.html | 1 - docs/html/functions_func_p.html | 4 +- docs/html/functions_func_s.html | 4 +- docs/html/functions_func_u.html | 4 +- docs/html/functions_func_x.html | 85 ++++++ docs/html/functions_func_y.html | 85 ++++++ docs/html/functions_g.html | 2 + docs/html/functions_h.html | 1 + docs/html/functions_i.html | 6 +- docs/html/functions_k.html | 4 +- docs/html/functions_l.html | 1 - docs/html/functions_m.html | 4 +- docs/html/functions_o.html | 1 - docs/html/functions_p.html | 6 +- docs/html/functions_r.html | 1 - docs/html/functions_s.html | 6 +- docs/html/functions_u.html | 5 +- docs/html/functions_vars.html | 19 +- docs/html/functions_x.html | 3 +- docs/html/functions_y.html | 4 +- docs/html/hierarchy.html | 8 +- docs/html/menudata.js | 4 +- docs/html/search/all_1.js | 17 +- docs/html/search/all_10.js | 7 +- docs/html/search/all_11.js | 75 +++--- docs/html/search/all_13.js | 21 +- docs/html/search/all_16.js | 3 +- docs/html/search/all_17.js | 3 +- docs/html/search/all_2.js | 41 +-- docs/html/search/all_3.js | 20 +- docs/html/search/all_5.js | 5 +- docs/html/search/all_6.js | 110 ++++---- docs/html/search/all_7.js | 3 +- docs/html/search/all_8.js | 12 +- docs/html/search/all_a.js | 4 +- docs/html/search/all_b.js | 25 +- docs/html/search/all_c.js | 6 +- docs/html/search/all_e.js | 7 +- docs/html/search/all_f.js | 6 +- docs/html/search/classes_0.js | 2 +- docs/html/search/classes_3.js | 2 +- docs/html/search/classes_a.js | 7 +- docs/html/search/enums_0.js | 2 +- docs/html/search/enumvalues_1.js | 3 +- docs/html/search/enumvalues_2.js | 2 +- docs/html/search/enumvalues_3.js | 2 +- docs/html/search/enumvalues_4.js | 2 +- docs/html/search/enumvalues_5.js | 2 +- docs/html/search/functions_11.js | 30 +-- docs/html/search/functions_13.js | 8 +- docs/html/search/functions_16.js | 4 + docs/html/search/functions_17.js | 4 + docs/html/search/functions_2.js | 2 +- docs/html/search/functions_3.js | 13 +- docs/html/search/functions_6.js | 3 +- docs/html/search/functions_8.js | 33 ++- docs/html/search/functions_a.js | 2 +- docs/html/search/functions_c.js | 3 +- docs/html/search/functions_e.js | 7 +- docs/html/search/functions_f.js | 4 +- docs/html/search/searchdata.js | 6 +- docs/html/search/variables_10.js | 2 +- docs/html/search/variables_2.js | 2 +- docs/html/search/variables_4.js | 3 +- docs/html/search/variables_6.js | 5 +- docs/html/search/variables_7.js | 2 +- docs/html/search/variables_9.js | 3 +- docs/html/search/variables_b.js | 2 +- docs/html/search/variables_c.js | 2 +- docs/html/search/variables_f.js | 2 +- ...mbers.html => structBodyPart-members.html} | 20 +- ...e_1_1BodyPart.html => structBodyPart.html} | 62 +++-- docs/html/structSnake_1_1Food.html | 136 ---------- 99 files changed, 1331 insertions(+), 750 deletions(-) create mode 100644 docs/html/classFood-members.html create mode 100644 docs/html/classFood.html create mode 100644 docs/html/classSnakeGame-members.html create mode 100644 docs/html/classSnakeGame.html create mode 100644 docs/html/classSnakeGame.png rename docs/html/{structSnake_1_1Food-members.html => dir_4216b1c8c447536616ff22cc879c2748.html} (66%) create mode 100644 docs/html/dir_9435ca5cf080eab6f8746f45b27d7231.html create mode 100644 docs/html/functions_func_x.html create mode 100644 docs/html/functions_func_y.html create mode 100644 docs/html/search/functions_16.js create mode 100644 docs/html/search/functions_17.js rename docs/html/{structSnake_1_1BodyPart-members.html => structBodyPart-members.html} (60%) rename docs/html/{structSnake_1_1BodyPart.html => structBodyPart.html} (63%) delete mode 100644 docs/html/structSnake_1_1Food.html diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 871c8f45..3a86d470 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -76,51 +76,52 @@ $(function() {
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 CBWlistExceptionBWlistException
 CCheckSecCheckSec
 CColorSecColorSec
 CCraphelpCraphelp
 CCrapinfoCrapinfo
 CCraplogCraplog
 CBWlistStructure to hold the items of a blacklist/warnlist
 CLogFileStructure which holds informations about a log file
 CLogNameWeb Server specific file names criterions
 CCrapnoteCrapnote
 CCrapupCrapup
 CCrapviewCrapview
 CCrissCrossCrissCross
 CDateTimeExceptionDateTimeException
 CDateTimeOpsDateTimeOps
 CDbQuery
 CDialogBoolDialogBool
 CDialogDiaDialogDia
 CDialogMsgDialogMsg
 CDialogSecDialogSec
 CDonutBreakdownDonutBreakdon
 CFormatOpsFormatOps
 CLogsFormatStructure which holds informations about a log format
 CGameSecGameSec
 CGenericExceptionGenericException
 CGZutilsGZUtils
 CHashOpsHashOps
 CIOutilsIOUtils
 CLogFormatExceptionLogFormatException
 CLogOpsLogOps
 CLogParserExceptionLogParserException
 CMainSliceRepresents a slice
 CMainWindowMainWindow
 CRichTextRichText
 CSHA256
 CSnakeSnake
 CBodyPartInstance of a part of the body of the snake
 CFoodInstance of the egg which will be eat by the snake
 CStoreOpsStoreOps
 CStringOpsStringOps
 CStyleSecStyleSec
 CTextBrowserTextBrowser
 CTRTR
 CVecOpsVecOps
 CWebServerExceptionWebServerException
 CBodyPartInstance of a part of the body of the snake
 CBWlistExceptionBWlistException
 CCheckSecCheckSec
 CColorSecColorSec
 CCraphelpCraphelp
 CCrapinfoCrapinfo
 CCraplogCraplog
 CBWlistStructure to hold the items of a blacklist/warnlist
 CLogFileStructure which holds informations about a log file
 CLogNameWeb Server specific file names criterions
 CCrapnoteCrapnote
 CCrapupCrapup
 CCrapviewCrapview
 CCrissCrossCrissCross
 CDateTimeExceptionDateTimeException
 CDateTimeOpsDateTimeOps
 CDbQuery
 CDialogBoolDialogBool
 CDialogDiaDialogDia
 CDialogMsgDialogMsg
 CDialogSecDialogSec
 CDonutBreakdownDonutBreakdon
 CFood
 CFormatOpsFormatOps
 CLogsFormatStructure which holds informations about a log format
 CGameSecGameSec
 CGenericExceptionGenericException
 CGZutilsGZUtils
 CHashOpsHashOps
 CIOutilsIOUtils
 CLogFormatExceptionLogFormatException
 CLogOpsLogOps
 CLogParserExceptionLogParserException
 CMainSliceRepresents a slice
 CMainWindowMainWindow
 CRichTextRichText
 CSHA256
 CSnake
 CSnakeGameSnake
 CStoreOpsStoreOps
 CStringOpsStringOps
 CStyleSecStyleSec
 CTextBrowserTextBrowser
 CTRTR
 CVecOpsVecOps
 CWebServerExceptionWebServerException
diff --git a/docs/html/classCrissCross.html b/docs/html/classCrissCross.html index b3e2cef0..b8bffe30 100644 --- a/docs/html/classCrissCross.html +++ b/docs/html/classCrissCross.html @@ -81,7 +81,7 @@ $(function() {

CrissCross. More...

-

#include <crisscross.h>

+

#include <game.h>

Inheritance diagram for CrissCross:
@@ -192,8 +192,8 @@ void AI_playTurn ()

The documentation for this class was generated from the following files: diff --git a/docs/html/classFood-members.html b/docs/html/classFood-members.html new file mode 100644 index 00000000..fd44f97b --- /dev/null +++ b/docs/html/classFood-members.html @@ -0,0 +1,96 @@ + + + + + + + +LogDoctor: Member List + + + + + + + + + +
+
+ + + + + + + +
+
LogDoctor 2.00 +
+
Parse Apache2/Nginx/IIS logs and create statistics
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+
Food Member List
+
+
+ +

This is the complete list of members for Food, including all inherited members.

+ + + + + + + + + + + +
img_ratFoodprivate
inTile(const unsigned int &x, const unsigned int &y)Food
movableFoodprivate
move(Snake &snake)Food
spawn(Snake &snake, Snake &snake_)Food
update(const unsigned int &new_x, const unsigned int &new_y)Food
xFoodprivate
X()Food
yFoodprivate
Y()Food
+ + + + diff --git a/docs/html/classFood.html b/docs/html/classFood.html new file mode 100644 index 00000000..5c8e7018 --- /dev/null +++ b/docs/html/classFood.html @@ -0,0 +1,158 @@ + + + + + + + +LogDoctor: Food Class Reference + + + + + + + + + +
+
+ + + + + + + +
+
LogDoctor 2.00 +
+
Parse Apache2/Nginx/IIS logs and create statistics
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+ +
Food Class Reference
+
+
+ + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+const unsigned int & X ()
 Returns the position on the X-axis.
 
const unsigned int & Y ()
 Returns the position on the Y-axis. More...
 
+const bool inTile (const unsigned int &x, const unsigned int &y)
 Checks whether is there a part of the snake in the given position.
 
+void spawn (Snake &snake, Snake &snake_)
 Spawns the egg/rat in a new position.
 
+void move (Snake &snake)
 Moves the rat.
 
+void update (const unsigned int &new_x, const unsigned int &new_y)
 Updates the position and direction of the entity.
 
+ + + + + + + + + + + + + +

+Private Attributes

+QPixmap img_rat = QPixmap(":/games/games/snake/rat.png")
 Whether the food is a rat or an egg.
 
+bool movable
 The position on the X-axis.
 
+unsigned int x
 The position on the Y-axis.
 
+unsigned int y
 The image which graphically represents the food.
 
+

Member Function Documentation

+ +

◆ Y()

+ +
+
+ + + + + + + +
const unsigned int & Food::Y ()
+
+ +

Returns the position on the Y-axis.

+

Returns the image

+ +
+
+
The documentation for this class was generated from the following files: +
+ + + + diff --git a/docs/html/classSnake-members.html b/docs/html/classSnake-members.html index e8f54d39..b9214218 100644 --- a/docs/html/classSnake-members.html +++ b/docs/html/classSnake-members.html @@ -77,24 +77,11 @@ $(function() {

This is the complete list of members for Snake, including all inherited members.

- - - - - - - - - - - - - - - - - - + + + + +
checkCollision()Snakeprivate
Direction enum nameSnakeprivate
DOWN enum valueSnakeprivate
increaseGameScore()Snakeprivate
increaseSnakeBody(const bool &initial=false)Snakeprivate
key_eventsSnakeprivate
keyPressEvent(QKeyEvent *event) overrideSnakeprivate
LEFT enum valueSnakeprivate
MAX_SNAKE_LENGTHSnakeprivate
on_button_Play_clicked()Snakeprivateslot
processGameLogic()Snakeprivateslot
processNextKeyEvent()Snakeprivate
RIGHT enum valueSnakeprivate
snakeSnakeprivate
snakeInTile(const unsigned int &x, const unsigned int &y)Snakeprivate
spawnFood()Snakeprivate
UP enum valueSnakeprivate
updateSnakePosition(const bool &dry=false)Snakeprivate
direction()Snake
grow(const bool &is_borning)Snakeprivate
inTile(const unsigned int &x, const unsigned int &y, const bool &avoid_tail=true)Snake
setDirection(const Direction new_direction)Snake
update(QGraphicsScene *field_scene=nullptr, const bool &dry=false, const bool &is_borning=false)Snake