From 06cae09dd309458c381b71171452247fe295812e Mon Sep 17 00:00:00 2001 From: dawidg81 Date: Thu, 29 Jan 2026 15:37:10 +0100 Subject: docs builded --- docs/docs/code/intro.md | 2 +- docs/site/404.html | 51 +++- docs/site/code/classes/index.html | 516 +++++++++++++++++++++++++++++++++++++ docs/site/code/index.html | 304 ---------------------- docs/site/code/intro/index.html | 403 +++++++++++++++++++++++++++++ docs/site/index.html | 55 +++- docs/site/search/search_index.json | 2 +- docs/site/sitemap.xml | 5 + docs/site/sitemap.xml.gz | Bin 195 -> 195 bytes 9 files changed, 1026 insertions(+), 312 deletions(-) create mode 100644 docs/site/code/classes/index.html delete mode 100644 docs/site/code/index.html create mode 100644 docs/site/code/intro/index.html diff --git a/docs/docs/code/intro.md b/docs/docs/code/intro.md index e942db3..da50371 100644 --- a/docs/docs/code/intro.md +++ b/docs/docs/code/intro.md @@ -1,4 +1,4 @@ -# Code documentation +# About This site documentates minesweeper code. diff --git a/docs/site/404.html b/docs/site/404.html index ce54f72..d3f55a0 100644 --- a/docs/site/404.html +++ b/docs/site/404.html @@ -187,13 +187,60 @@ + +
  • + + + + + + + + + + +
    • + + diff --git a/docs/site/code/classes/index.html b/docs/site/code/classes/index.html new file mode 100644 index 0000000..323d731 --- /dev/null +++ b/docs/site/code/classes/index.html @@ -0,0 +1,516 @@ + + + + + + + + + + + + + + + + Classes - minesweeper + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + +
    +
    + + + + +

    Classes

    +

    The code is mostly being structured in classes.

    +

    Game

    +

    Game class is operating on game logic, display and usage.

    +

    Global variables

    +

    Public

    +
    editDiff()
    +

    A function of type int. Responsible for providing interface letting user edit custom game parameters (fourth difficulty option). Uses methods from Utils class. Detailed specification of this function is int editDiff().

    +
    initDiff()
    +

    A function of type void. This function sets game parameters (boardWidth, boardHeight, mines) to specified value depending on gived difficulty value diff (type int). The function requires a diff parameter of type int. Full specification of declaration of this function is void initDiff(int diff).

    +

    First difficulty is Easy with diff value of 0, second difficulty is Medium with diff value of 1, third difficulty is Hard with diff value of 2, fourth difficulty is Custom with diff value of 3. On Custom difficulty given, editDiff() is being called.

    +

    Plot width, which means how much cells wide is the plot, is declared as boardWidth. The same with boardHeight. Amount of mines randomly placed in cells is declared as mines. These three variables are a type of int and are being properly set by initDiff() function. For Easy difficulty, all three variables are set to value 9, which means that the plot is 9 cells wide and high, with 9 bombs randomly spread across the plot.

    + + +
    +
    +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + \ No newline at end of file diff --git a/docs/site/code/index.html b/docs/site/code/index.html deleted file mode 100644 index cba0b88..0000000 --- a/docs/site/code/index.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - - - - - - Code documentation - minesweeper - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - - - - -
    - - -
    - -
    - - - - - - -
    -
    - - - -
    -
    -
    - - - - -
    -
    -
    - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    - - - - -

    Code documentation

    -

    This site documentates minesweeper code.

    - - -
    -
    -
    - -
    - - - -
    -
    -
    -
    - - - - - - - - \ No newline at end of file diff --git a/docs/site/code/intro/index.html b/docs/site/code/intro/index.html new file mode 100644 index 0000000..a03e3f8 --- /dev/null +++ b/docs/site/code/intro/index.html @@ -0,0 +1,403 @@ + + + + + + + + + + + + + + + + About - minesweeper + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + +
    +
    + + + + +

    About

    +

    This site documentates minesweeper code.

    +

    Chapters

    + + + +
    +
    +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + \ No newline at end of file diff --git a/docs/site/index.html b/docs/site/index.html index f9bd6b7..45a3dea 100644 --- a/docs/site/index.html +++ b/docs/site/index.html @@ -233,13 +233,60 @@ + +
  • + + + + + + + + + + +
    • + + @@ -312,13 +359,13 @@ -