diff options
| -rw-r--r-- | docs/docs/code/intro.md | 2 | ||||
| -rw-r--r-- | docs/site/404.html | 51 | ||||
| -rw-r--r-- | docs/site/code/classes/index.html | 516 | ||||
| -rw-r--r-- | docs/site/code/intro/index.html (renamed from docs/site/code/index.html) | 131 | ||||
| -rw-r--r-- | docs/site/index.html | 55 | ||||
| -rw-r--r-- | docs/site/search/search_index.json | 2 | ||||
| -rw-r--r-- | docs/site/sitemap.xml | 5 | ||||
| -rw-r--r-- | docs/site/sitemap.xml.gz | bin | 195 -> 195 bytes |
8 files changed, 738 insertions, 24 deletions
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 @@ + + <li class="md-nav__item md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" > + + + + + <label class="md-nav__link" for="__nav_2"> + Code + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="Code" data-md-level="1"> + <label class="md-nav__title" for="__nav_2"> + <span class="md-nav__icon md-icon"></span> + Code + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + <li class="md-nav__item"> - <a href="/code/" class="md-nav__link"> - Code documentation + <a href="/code/classes/" class="md-nav__link"> + Classes </a> </li> + + + + + + + + <li class="md-nav__item"> + <a href="/code/intro/" class="md-nav__link"> + About + </a> + </li> + + + + + </ul> + </nav> + </li> + + </ul> </nav> 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 @@ + +<!doctype html> +<html lang="en" class="no-js"> + <head> + + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width,initial-scale=1"> + + + + <link rel="icon" href="../../assets/images/favicon.png"> + <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-8.2.5"> + + + + <title>Classes - minesweeper</title> + + + + <link rel="stylesheet" href="../../assets/stylesheets/main.2d9f7617.min.css"> + + + <link rel="stylesheet" href="../../assets/stylesheets/palette.e6a45f82.min.css"> + + + + + + + + + <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"> + <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style> + + + + <script>__md_scope=new URL("../..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> + + + + + + </head> + + + + + + + + <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none"> + + + + <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> + <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> + <label class="md-overlay" for="__drawer"></label> + <div data-md-component="skip"> + + + <a href="#classes" class="md-skip"> + Skip to content + </a> + + </div> + <div data-md-component="announce"> + + </div> + + + + +<header class="md-header" data-md-component="header"> + <nav class="md-header__inner md-grid" aria-label="Header"> + <a href="../.." title="minesweeper" class="md-header__button md-logo" aria-label="minesweeper" data-md-component="logo"> + + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg> + + </a> + <label class="md-header__button md-icon" for="__drawer"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg> + </label> + <div class="md-header__title" data-md-component="header-title"> + <div class="md-header__ellipsis"> + <div class="md-header__topic"> + <span class="md-ellipsis"> + minesweeper + </span> + </div> + <div class="md-header__topic" data-md-component="header-topic"> + <span class="md-ellipsis"> + + Classes + + </span> + </div> + </div> + </div> + + + + <label class="md-header__button md-icon" for="__search"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> + </label> + <div class="md-search" data-md-component="search" role="dialog"> + <label class="md-search__overlay" for="__search"></label> + <div class="md-search__inner" role="search"> + <form class="md-search__form" name="search"> + <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required> + <label class="md-search__icon md-icon" for="__search"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> + </label> + <nav class="md-search__options" aria-label="Search"> + + <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg> + </button> + </nav> + + </form> + <div class="md-search__output"> + <div class="md-search__scrollwrap" data-md-scrollfix> + <div class="md-search-result" data-md-component="search-result"> + <div class="md-search-result__meta"> + Initializing search + </div> + <ol class="md-search-result__list"></ol> + </div> + </div> + </div> + </div> +</div> + + + </nav> + +</header> + + <div class="md-container" data-md-component="container"> + + + + + + + <main class="md-main" data-md-component="main"> + <div class="md-main__inner md-grid"> + + + + <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + + + +<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> + <label class="md-nav__title" for="__drawer"> + <a href="../.." title="minesweeper" class="md-nav__button md-logo" aria-label="minesweeper" data-md-component="logo"> + + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg> + + </a> + minesweeper + </label> + + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + + <li class="md-nav__item"> + <a href="../.." class="md-nav__link"> + About + </a> + </li> + + + + + + + + + + + + + + <li class="md-nav__item md-nav__item--active md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked> + + + + + <label class="md-nav__link" for="__nav_2"> + Code + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="Code" data-md-level="1"> + <label class="md-nav__title" for="__nav_2"> + <span class="md-nav__icon md-icon"></span> + Code + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + + <li class="md-nav__item md-nav__item--active"> + + <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> + + + + + + <label class="md-nav__link md-nav__link--active" for="__toc"> + Classes + <span class="md-nav__icon md-icon"></span> + </label> + + <a href="./" class="md-nav__link md-nav__link--active"> + Classes + </a> + + + +<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> + + + + + + + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#game" class="md-nav__link"> + Game + </a> + + <nav class="md-nav" aria-label="Game"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#global-variables" class="md-nav__link"> + Global variables + </a> + + <nav class="md-nav" aria-label="Global variables"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#public" class="md-nav__link"> + Public + </a> + + <nav class="md-nav" aria-label="Public"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#editdiff" class="md-nav__link"> + editDiff() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#initdiff" class="md-nav__link"> + initDiff() + </a> + +</li> + + </ul> + </nav> + +</li> + + </ul> + </nav> + +</li> + + </ul> + </nav> + +</li> + + </ul> + +</nav> + + </li> + + + + + + + + + + <li class="md-nav__item"> + <a href="../intro/" class="md-nav__link"> + About + </a> + </li> + + + + + </ul> + </nav> + </li> + + + + </ul> +</nav> + </div> + </div> + </div> + + + + <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + + +<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> + + + + + + + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#game" class="md-nav__link"> + Game + </a> + + <nav class="md-nav" aria-label="Game"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#global-variables" class="md-nav__link"> + Global variables + </a> + + <nav class="md-nav" aria-label="Global variables"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#public" class="md-nav__link"> + Public + </a> + + <nav class="md-nav" aria-label="Public"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#editdiff" class="md-nav__link"> + editDiff() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#initdiff" class="md-nav__link"> + initDiff() + </a> + +</li> + + </ul> + </nav> + +</li> + + </ul> + </nav> + +</li> + + </ul> + </nav> + +</li> + + </ul> + +</nav> + </div> + </div> + </div> + + + <div class="md-content" data-md-component="content"> + <article class="md-content__inner md-typeset"> + + + + +<h1 id="classes">Classes</h1> +<p>The code is mostly being structured in classes.</p> +<h2 id="game"><code>Game</code></h2> +<p><code>Game</code> class is operating on game logic, display and usage.</p> +<h3 id="global-variables">Global variables</h3> +<h4 id="public">Public</h4> +<h5 id="editdiff"><code>editDiff()</code></h5> +<p>A function of type <code>int</code>. Responsible for providing interface letting user edit custom game parameters (fourth difficulty option). Uses methods from <code>Utils</code> class. Detailed specification of this function is <code>int editDiff()</code>.</p> +<h5 id="initdiff"><code>initDiff()</code></h5> +<p>A function of type <code>void</code>. This function sets game parameters (<code>boardWidth</code>, <code>boardHeight</code>, <code>mines</code>) to specified value depending on gived difficulty value <code>diff</code> (type <code>int</code>). The function requires a <code>diff</code> parameter of type <code>int</code>. Full specification of declaration of this function is <code>void initDiff(int diff)</code>.</p> +<p>First difficulty is <em>Easy</em> with <code>diff</code> value of 0, second difficulty is <em>Medium</em> with <code>diff</code> value of 1, third difficulty is <em>Hard</em> with <code>diff</code> value of 2, fourth difficulty is <em>Custom</em> with <code>diff</code> value of 3. On <em>Custom</em> difficulty given, <code>editDiff()</code> is being called.</p> +<p>Plot width, which means how much cells wide is the plot, is declared as <code>boardWidth</code>. The same with <code>boardHeight</code>. Amount of mines randomly placed in cells is declared as <code>mines</code>. These three variables are a type of <code>int</code> and are being properly set by <code>initDiff()</code> function. For <em>Easy</em> difficulty, all three variables are set to value <code>9</code>, which means that the plot is 9 cells wide and high, with 9 bombs randomly spread across the plot.</p> + + + </article> + </div> + </div> + + </main> + + <footer class="md-footer"> + + <nav class="md-footer__inner md-grid" aria-label="Footer"> + + + <a href="../.." class="md-footer__link md-footer__link--prev" aria-label="Previous: About" rel="prev"> + <div class="md-footer__button md-icon"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> + </div> + <div class="md-footer__title"> + <div class="md-ellipsis"> + <span class="md-footer__direction"> + Previous + </span> + About + </div> + </div> + </a> + + + + <a href="../intro/" class="md-footer__link md-footer__link--next" aria-label="Next: About" rel="next"> + <div class="md-footer__title"> + <div class="md-ellipsis"> + <span class="md-footer__direction"> + Next + </span> + About + </div> + </div> + <div class="md-footer__button md-icon"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg> + </div> + </a> + + </nav> + + <div class="md-footer-meta md-typeset"> + <div class="md-footer-meta__inner md-grid"> + <div class="md-copyright"> + + + Made with + <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> + Material for MkDocs + </a> + +</div> + + </div> + </div> +</footer> + + </div> + <div class="md-dialog" data-md-component="dialog"> + <div class="md-dialog__inner md-typeset"></div> + </div> + <script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.bd0b6b67.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script> + + + <script src="../../assets/javascripts/bundle.467223ff.min.js"></script> + + + </body> +</html>
\ No newline at end of file diff --git a/docs/site/code/index.html b/docs/site/code/intro/index.html index cba0b88..a03e3f8 100644 --- a/docs/site/code/index.html +++ b/docs/site/code/intro/index.html @@ -8,19 +8,19 @@ - <link rel="icon" href="../assets/images/favicon.png"> + <link rel="icon" href="../../assets/images/favicon.png"> <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-8.2.5"> - <title>Code documentation - minesweeper</title> + <title>About - minesweeper</title> - <link rel="stylesheet" href="../assets/stylesheets/main.2d9f7617.min.css"> + <link rel="stylesheet" href="../../assets/stylesheets/main.2d9f7617.min.css"> - <link rel="stylesheet" href="../assets/stylesheets/palette.e6a45f82.min.css"> + <link rel="stylesheet" href="../../assets/stylesheets/palette.e6a45f82.min.css"> @@ -35,7 +35,7 @@ - <script>__md_scope=new URL("..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> + <script>__md_scope=new URL("../..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> @@ -59,7 +59,7 @@ <div data-md-component="skip"> - <a href="#code-documentation" class="md-skip"> + <a href="#about" class="md-skip"> Skip to content </a> @@ -73,7 +73,7 @@ <header class="md-header" data-md-component="header"> <nav class="md-header__inner md-grid" aria-label="Header"> - <a href=".." title="minesweeper" class="md-header__button md-logo" aria-label="minesweeper" data-md-component="logo"> + <a href="../.." title="minesweeper" class="md-header__button md-logo" aria-label="minesweeper" data-md-component="logo"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg> @@ -92,7 +92,7 @@ <div class="md-header__topic" data-md-component="header-topic"> <span class="md-ellipsis"> - Code documentation + About </span> </div> @@ -159,7 +159,7 @@ <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> <label class="md-nav__title" for="__drawer"> - <a href=".." title="minesweeper" class="md-nav__button md-logo" aria-label="minesweeper" data-md-component="logo"> + <a href="../.." title="minesweeper" class="md-nav__button md-logo" aria-label="minesweeper" data-md-component="logo"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg> @@ -178,7 +178,7 @@ <li class="md-nav__item"> - <a href=".." class="md-nav__link"> + <a href="../.." class="md-nav__link"> About </a> </li> @@ -194,6 +194,48 @@ + + <li class="md-nav__item md-nav__item--active md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked> + + + + + <label class="md-nav__link" for="__nav_2"> + Code + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="Code" data-md-level="1"> + <label class="md-nav__title" for="__nav_2"> + <span class="md-nav__icon md-icon"></span> + Code + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + <li class="md-nav__item"> + <a href="../classes/" class="md-nav__link"> + Classes + </a> + </li> + + + + + + + + + + + <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> @@ -202,10 +244,48 @@ + <label class="md-nav__link md-nav__link--active" for="__toc"> + About + <span class="md-nav__icon md-icon"></span> + </label> + <a href="./" class="md-nav__link md-nav__link--active"> - Code documentation + About </a> + + +<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> + + + + + + + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#chapters" class="md-nav__link"> + Chapters + </a> + +</li> + + </ul> + +</nav> + + </li> + + + + + </ul> + </nav> </li> @@ -230,6 +310,21 @@ + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#chapters" class="md-nav__link"> + Chapters + </a> + +</li> + + </ul> + </nav> </div> </div> @@ -242,8 +337,12 @@ -<h1 id="code-documentation">Code documentation</h1> +<h1 id="about">About</h1> <p>This site documentates minesweeper code.</p> +<h2 id="chapters">Chapters</h2> +<ul> +<li><a href="../classes/">Classes</a></li> +</ul> </article> @@ -257,7 +356,7 @@ <nav class="md-footer__inner md-grid" aria-label="Footer"> - <a href=".." class="md-footer__link md-footer__link--prev" aria-label="Previous: About" rel="prev"> + <a href="../classes/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Classes" rel="prev"> <div class="md-footer__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> </div> @@ -266,7 +365,7 @@ <span class="md-footer__direction"> Previous </span> - About + Classes </div> </div> </a> @@ -294,10 +393,10 @@ <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> - <script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.bd0b6b67.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script> + <script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.bd0b6b67.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script> - <script src="../assets/javascripts/bundle.467223ff.min.js"></script> + <script src="../../assets/javascripts/bundle.467223ff.min.js"></script> </body> 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 @@ + + <li class="md-nav__item md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" > + + + + + <label class="md-nav__link" for="__nav_2"> + Code + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="Code" data-md-level="1"> + <label class="md-nav__title" for="__nav_2"> + <span class="md-nav__icon md-icon"></span> + Code + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + <li class="md-nav__item"> - <a href="code/" class="md-nav__link"> - Code documentation + <a href="code/classes/" class="md-nav__link"> + Classes </a> </li> + + + + + + + + <li class="md-nav__item"> + <a href="code/intro/" class="md-nav__link"> + About + </a> + </li> + + + + + </ul> + </nav> + </li> + + </ul> </nav> @@ -312,13 +359,13 @@ - <a href="code/" class="md-footer__link md-footer__link--next" aria-label="Next: Code documentation" rel="next"> + <a href="code/classes/" class="md-footer__link md-footer__link--next" aria-label="Next: Classes" rel="next"> <div class="md-footer__title"> <div class="md-ellipsis"> <span class="md-footer__direction"> Next </span> - Code documentation + Classes </div> </div> <div class="md-footer__button md-icon"> diff --git a/docs/site/search/search_index.json b/docs/site/search/search_index.json index 7acae56..43bae65 100644 --- a/docs/site/search/search_index.json +++ b/docs/site/search/search_index.json @@ -1 +1 @@ -{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"About A reimplementation of minesweeper game in C++ in terminal. Concept There are going to be 3 difficulties and one additional option where user can determine plot size and amount of mines by himself. Game commands are going to be read from normal std::cin input method. The project is not going to use curses, ncurses or lncurses libraries for now. Plot is going to be displayed (printed) on the upper left side of the screen, eventually with colors. Here are planned symbols of in-game elements: # - unrevealed tile. . - revealed tile (no mines around). X - (red color) bomb. Colorful numbers from 1 (1 mine around the revealed tile) to (maximum) 8 (8 mines around the revealed tile) - numbers saying how much mines are around it.","title":"About"},{"location":"#about","text":"A reimplementation of minesweeper game in C++ in terminal.","title":"About"},{"location":"#concept","text":"There are going to be 3 difficulties and one additional option where user can determine plot size and amount of mines by himself. Game commands are going to be read from normal std::cin input method. The project is not going to use curses, ncurses or lncurses libraries for now. Plot is going to be displayed (printed) on the upper left side of the screen, eventually with colors. Here are planned symbols of in-game elements: # - unrevealed tile. . - revealed tile (no mines around). X - (red color) bomb. Colorful numbers from 1 (1 mine around the revealed tile) to (maximum) 8 (8 mines around the revealed tile) - numbers saying how much mines are around it.","title":"Concept"},{"location":"code/","text":"Code documentation This site documentates minesweeper code.","title":"Code documentation"},{"location":"code/#code-documentation","text":"This site documentates minesweeper code.","title":"Code documentation"}]}
\ No newline at end of file +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"About A reimplementation of minesweeper game in C++ in terminal. Concept There are going to be 3 difficulties and one additional option where user can determine plot size and amount of mines by himself. Game commands are going to be read from normal std::cin input method. The project is not going to use curses, ncurses or lncurses libraries for now. Plot is going to be displayed (printed) on the upper left side of the screen, eventually with colors. Here are planned symbols of in-game elements: # - unrevealed tile. . - revealed tile (no mines around). X - (red color) bomb. Colorful numbers from 1 (1 mine around the revealed tile) to (maximum) 8 (8 mines around the revealed tile) - numbers saying how much mines are around it.","title":"About"},{"location":"#about","text":"A reimplementation of minesweeper game in C++ in terminal.","title":"About"},{"location":"#concept","text":"There are going to be 3 difficulties and one additional option where user can determine plot size and amount of mines by himself. Game commands are going to be read from normal std::cin input method. The project is not going to use curses, ncurses or lncurses libraries for now. Plot is going to be displayed (printed) on the upper left side of the screen, eventually with colors. Here are planned symbols of in-game elements: # - unrevealed tile. . - revealed tile (no mines around). X - (red color) bomb. Colorful numbers from 1 (1 mine around the revealed tile) to (maximum) 8 (8 mines around the revealed tile) - numbers saying how much mines are around it.","title":"Concept"},{"location":"code/classes/","text":"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.","title":"Classes"},{"location":"code/classes/#classes","text":"The code is mostly being structured in classes.","title":"Classes"},{"location":"code/classes/#game","text":"Game class is operating on game logic, display and usage.","title":"Game"},{"location":"code/classes/#global-variables","text":"","title":"Global variables"},{"location":"code/classes/#public","text":"","title":"Public"},{"location":"code/classes/#editdiff","text":"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() .","title":"editDiff()"},{"location":"code/classes/#initdiff","text":"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.","title":"initDiff()"},{"location":"code/intro/","text":"About This site documentates minesweeper code. Chapters Classes","title":"About"},{"location":"code/intro/#about","text":"This site documentates minesweeper code.","title":"About"},{"location":"code/intro/#chapters","text":"Classes","title":"Chapters"}]}
\ No newline at end of file diff --git a/docs/site/sitemap.xml b/docs/site/sitemap.xml index 40be497..e530e15 100644 --- a/docs/site/sitemap.xml +++ b/docs/site/sitemap.xml @@ -10,4 +10,9 @@ <lastmod>2026-01-29</lastmod> <changefreq>daily</changefreq> </url> + <url> + <loc>None</loc> + <lastmod>2026-01-29</lastmod> + <changefreq>daily</changefreq> + </url> </urlset>
\ No newline at end of file diff --git a/docs/site/sitemap.xml.gz b/docs/site/sitemap.xml.gz Binary files differindex d8ba030..41a6ba2 100644 --- a/docs/site/sitemap.xml.gz +++ b/docs/site/sitemap.xml.gz |