📔 Patch some doc things

conf.json

@@ -0,0 +1,8 @@
+{
+    "tags": {
+        "allowUnknownTags": true
+    },
+    "opts": {
+        "recurse": true
+    }
+}

docs/build/html/_sources/code/frontend/index.rst.txt

@@ -1,2 +1,43 @@
 ``nest_frontend`` - Interfaccia utente in React
 ===============================================
+
+.. warning::
+
+    `JSDoc <https://jsdoc.app/>`_ non sembra essere in grado di gestire correttamente il lato frontend del progetto.
+
+    Per maggiori dettagli sul funzionamento dei vari componenti, si suggerisce di guardare le **docstring presenti nel
+    codice sorgente**.
+
+    Seguono sotto le uniche classi che JSDoc è stato in grado di gestire (anche se vengono mostrate solo
+    parzialmente).
+
+
+``.objects`` - Oggetti vari di utility
+---------------------------------------------------------
+
+.. js:autoclass:: Condition
+.. js:autoclass:: ConditionHashtag
+.. js:autoclass:: ConditionUser
+.. js:autoclass:: ConditionTime
+.. js:autoclass:: ConditionLocation
+.. js:autoclass:: NotImplementedError
+.. js:autoclass:: BackendCommunicationError
+.. js:autoclass:: ViewNotAllowedError
+.. js:autoclass:: ServerNotConfiguredError
+.. js:autoclass:: FetchAlreadyRunningError
+.. js:autoclass:: FetchError
+.. js:autoclass:: DecodeError
+.. js:autoclass:: ResultError
+.. js:autoclass:: SerializationError
+.. js:autoclass:: Filter
+.. js:autoclass:: FilterContains
+.. js:autoclass:: FilterHashtag
+.. js:autoclass:: FilterPoster
+.. js:autoclass:: FilterWithLocation
+.. js:autoclass:: FilterWithPlace
+.. js:autoclass:: FilterInsideMapArea
+.. js:autoclass:: FilterInsideTimeRay
+.. js:autoclass:: FilterWithImage
+.. js:autoclass:: FilterIsRetweet
+.. .. js:autoclass:: MapArea
+.. .. js:autoclass:: TimeRay

docs/build/html/_sources/development/artifacts.rst.txt

@@ -8,16 +8,31 @@ Vengono di seguito elencati alcuni artefatti che non sono stati precedentemente
 Diagrammi UML
 -------------
 
-Per la realizzazione dei diagrammi UML, utili nelle fasi iniziali di progettazione di N.E.S.T., è stato utilizzato DrawIO (oggi diagrams.net). Si allega il file con il progetto UML.
+Per la realizzazione dei diagrammi UML, utili nelle fasi iniziali di progettazione di N.E.S.T., è stato utilizzato
+DrawIO (oggi diagrams.net). Si allega il file con il progetto UML.
 
 - :download:`Diagrammi UML <ProgettoDelSoftware.drawio>`
 
-| Dopo aver scaricato il file, recarsi su https://app.diagrams.net/
-| e tramite il menù
-|   File -> Open from -> Device...
-| caricare il file appena scaricato.
+Dopo aver scaricato il file, recarsi su https://app.diagrams.net/ e tramite il menù ``File → Open from → Device...``
+caricare il file appena scaricato.
 
 Demo
 ----
 
-- https://drive.google.com/file/d/15o70Ffe51CNj8LTKHC9dGiqRVnbv9UpZ/view?usp=sharing
+Video
+^^^^^
+
+Il video di demo è disponibile al seguente URL:
+
+- https://drive.google.com/file/d/15o70Ffe51CNj8LTKHC9dGiqRVnbv9UpZ/view
+
+
+Interattiva
+^^^^^^^^^^^
+
+Una demo interattiva è disponibile ai seguenti URL:
+
+- https://api.nest.steffo.eu/ (backend)
+- https://prod.nest.steffo.eu/ (frontend pre-popolato)
+- https://docs.nest.steffo.eu/ (documentazione e relazione)
+

docs/build/html/_sources/development/sprint3/index.rst.txt

@@ -109,10 +109,6 @@ Il video di Demo è disponibile al seguente link:
 Registro attività
 -----------------
 
-.. todo::
-
-    Compilare il registro attività dello sprint 3.
-
 
 Riunioni collettive
 ^^^^^^^^^^^^^^^^^^^

docs/build/html/code/frontend/index.html

@@ -106,7 +106,10 @@
 <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Struttura del database</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../crawler/index.html"><code class="docutils literal notranslate"><span class="pre">nest_crawler</span></code> - Crawler in Python</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">nest_frontend</span></code> - Interfaccia utente in React</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">nest_frontend</span></code> - Interfaccia utente in React</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#objects-oggetti-vari-di-utility"><code class="docutils literal notranslate"><span class="pre">.objects</span></code> - Oggetti vari di utility</a></li>
+</ul>
+</li>
 </ul>
 
             
@@ -176,6 +179,170 @@
             
   <div class="section" id="nest-frontend-interfaccia-utente-in-react">
 <h1><code class="docutils literal notranslate"><span class="pre">nest_frontend</span></code> - Interfaccia utente in React<a class="headerlink" href="#nest-frontend-interfaccia-utente-in-react" title="Link a questa intestazione">¶</a></h1>
+<div class="admonition warning">
+<p class="admonition-title">Avvertimento</p>
+<p><a class="reference external" href="https://jsdoc.app/">JSDoc</a> non sembra essere in grado di gestire correttamente il lato frontend del progetto.</p>
+<p>Per maggiori dettagli sul funzionamento dei vari componenti, si suggerisce di guardare le <strong>docstring presenti nel
+codice sorgente</strong>.</p>
+<p>Seguono sotto le uniche classi che JSDoc è stato in grado di gestire (anche se vengono mostrate solo
+parzialmente).</p>
+</div>
+<div class="section" id="objects-oggetti-vari-di-utility">
+<h2><code class="docutils literal notranslate"><span class="pre">.objects</span></code> - Oggetti vari di utility<a class="headerlink" href="#objects-oggetti-vari-di-utility" title="Link a questa intestazione">¶</a></h2>
+<dl class="js class">
+<dt id="Condition">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Condition</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Condition" title="Link a questa definizione">¶</a></dt>
+<dd><p>Condition class for an undefined/unknown condition.</p>
+<p>See [the Condition spec](<a class="reference external" href="https://gitlab.steffo.eu/nest/g2-progetto/-/wikis/sprint-2/Specifica-delle-Conditions">https://gitlab.steffo.eu/nest/g2-progetto/-/wikis/sprint-2/Specifica-delle-Conditions</a>).</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="ConditionHashtag">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConditionHashtag</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ConditionHashtag" title="Link a questa definizione">¶</a></dt>
+<dd><p>Require a tweet to contain a specific hashtag to be gathered.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="ConditionUser">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConditionUser</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ConditionUser" title="Link a questa definizione">¶</a></dt>
+<dd><p>Require a tweet to be posted by a certain user to be gathered.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="ConditionTime">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConditionTime</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ConditionTime" title="Link a questa definizione">¶</a></dt>
+<dd><p>Require a tweet to be posted before or after a certain time to be gathered.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="ConditionLocation">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConditionLocation</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ConditionLocation" title="Link a questa definizione">¶</a></dt>
+<dd><p>Require a tweet to have coordinates associated and to be posted within the <a class="reference external" href="mailto:{&#37;&#52;&#48;link">{<span>&#64;</span>link</a> MapArea}.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="NotImplementedError">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NotImplementedError</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#NotImplementedError" title="Link a questa definizione">¶</a></dt>
+<dd><p>Error thrown when a function is not implemented in the current class/instance.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="BackendCommunicationError">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">BackendCommunicationError</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#BackendCommunicationError" title="Link a questa definizione">¶</a></dt>
+<dd><p>An error in the N.E.S.T. frontend-backend communication.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="ViewNotAllowedError">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ViewNotAllowedError</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ViewNotAllowedError" title="Link a questa definizione">¶</a></dt>
+<dd><p>Error thrown when trying to access a backend view which doesn't exist or isn't allowed in the used hook.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="ServerNotConfiguredError">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ServerNotConfiguredError</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ServerNotConfiguredError" title="Link a questa definizione">¶</a></dt>
+<dd><p>Error thrown when trying to access a backend view when outside a <a class="reference external" href="mailto:{&#37;&#52;&#48;link">{<span>&#64;</span>link</a> ContextServer}.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="FetchAlreadyRunningError">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FetchAlreadyRunningError</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FetchAlreadyRunningError" title="Link a questa definizione">¶</a></dt>
+<dd><p>Error thrown when trying to access a backend view while another access is ongoing.</p>
+<p>This is not allowed due to potential race conditions.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="FetchError">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FetchError</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FetchError" title="Link a questa definizione">¶</a></dt>
+<dd><p>Abstract class for <a class="reference external" href="mailto:{&#37;&#52;&#48;link">{<span>&#64;</span>link</a> DecodeError} and <a class="reference external" href="mailto:{&#37;&#52;&#48;link">{<span>&#64;</span>link</a> ResultError}.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="DecodeError">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DecodeError</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#DecodeError" title="Link a questa definizione">¶</a></dt>
+<dd><p>Error thrown when the frontend can't parse the data received from the backend.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="ResultError">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ResultError</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ResultError" title="Link a questa definizione">¶</a></dt>
+<dd><p>Error thrown when the backend returns a falsy <cite>&quot;result&quot;</cite> value.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="SerializationError">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">SerializationError</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#SerializationError" title="Link a questa definizione">¶</a></dt>
+<dd><p>Error thrown when a string couldn't be serialized into an object.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="Filter">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Filter</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="pre">negate=false</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Filter" title="Link a questa definizione">¶</a></dt>
+<dd><p>A filter applicable in the Analysis mode.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parametri</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>negate</strong> -- If the filter output should be reversed.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="js class">
+<dt id="FilterContains">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterContains</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FilterContains" title="Link a questa definizione">¶</a></dt>
+<dd><p>Checks if a tweet contains a string.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="FilterHashtag">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterHashtag</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FilterHashtag" title="Link a questa definizione">¶</a></dt>
+<dd><p>Check if a tweet contains an hashtag.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="FilterPoster">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterPoster</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FilterPoster" title="Link a questa definizione">¶</a></dt>
+<dd><p>Check if a tweet was posted by a certain user.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="FilterWithLocation">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterWithLocation</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FilterWithLocation" title="Link a questa definizione">¶</a></dt>
+<dd><p>Check if a tweet contains <cite>location</cite> metadata.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="FilterWithPlace">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterWithPlace</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FilterWithPlace" title="Link a questa definizione">¶</a></dt>
+<dd><p>Check if a tweet contains <cite>place</cite> metadata.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="FilterInsideMapArea">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterInsideMapArea</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FilterInsideMapArea" title="Link a questa definizione">¶</a></dt>
+<dd><p>Check if a tweet's <cite>location</cite> is inside a <a class="reference external" href="mailto:{&#37;&#52;&#48;link">{<span>&#64;</span>link</a> MapArea}.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="FilterInsideTimeRay">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterInsideTimeRay</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FilterInsideTimeRay" title="Link a questa definizione">¶</a></dt>
+<dd><p>Check if a tweet's <cite>post_time</cite> is inside a <a class="reference external" href="mailto:{&#37;&#52;&#48;link">{<span>&#64;</span>link</a> TimeRay}.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="FilterWithImage">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterWithImage</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FilterWithImage" title="Link a questa definizione">¶</a></dt>
+<dd><p>Check if a tweet has an associated <cite>image_url</cite>.</p>
+</dd></dl>
+
+<dl class="js class">
+<dt id="FilterIsRetweet">
+<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterIsRetweet</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FilterIsRetweet" title="Link a questa definizione">¶</a></dt>
+<dd><p>Check if a tweet is a retweet.</p>
+</dd></dl>
+
+</div>
 </div>
 
 

docs/build/html/development/artifacts.html

@@ -99,7 +99,11 @@
 <li class="toctree-l1"><a class="reference internal" href="process.html">Processo di sviluppo</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Artefatti</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#diagrammi-uml">Diagrammi UML</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#demo">Demo</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#demo">Demo</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#video">Video</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#interattiva">Interattiva</a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="conclusions.html">Conclusioni</a></li>
@@ -185,25 +189,33 @@
 <p>Vengono di seguito elencati alcuni artefatti che non sono stati precedentemente elencati:</p>
 <div class="section" id="diagrammi-uml">
 <h2>Diagrammi UML<a class="headerlink" href="#diagrammi-uml" title="Link a questa intestazione">¶</a></h2>
-<p>Per la realizzazione dei diagrammi UML, utili nelle fasi iniziali di progettazione di N.E.S.T., è stato utilizzato DrawIO (oggi diagrams.net). Si allega il file con il progetto UML.</p>
+<p>Per la realizzazione dei diagrammi UML, utili nelle fasi iniziali di progettazione di N.E.S.T., è stato utilizzato
+DrawIO (oggi diagrams.net). Si allega il file con il progetto UML.</p>
 <ul class="simple">
 <li><p><a class="reference download internal" download="" href="../_downloads/a8f6f8c96d6ffe6b240cca1614b7f2dc/ProgettoDelSoftware.drawio"><code class="xref download docutils literal notranslate"><span class="pre">Diagrammi</span> <span class="pre">UML</span></code></a></p></li>
 </ul>
-<div class="line-block">
-<div class="line">Dopo aver scaricato il file, recarsi su <a class="reference external" href="https://app.diagrams.net/">https://app.diagrams.net/</a></div>
-<div class="line">e tramite il menù</div>
-<div class="line-block">
-<div class="line">File -&gt; Open from -&gt; Device...</div>
-</div>
-<div class="line">caricare il file appena scaricato.</div>
-</div>
+<p>Dopo aver scaricato il file, recarsi su <a class="reference external" href="https://app.diagrams.net/">https://app.diagrams.net/</a> e tramite il menù <code class="docutils literal notranslate"><span class="pre">File</span> <span class="pre">→</span> <span class="pre">Open</span> <span class="pre">from</span> <span class="pre">→</span> <span class="pre">Device...</span></code>
+caricare il file appena scaricato.</p>
 </div>
 <div class="section" id="demo">
 <h2>Demo<a class="headerlink" href="#demo" title="Link a questa intestazione">¶</a></h2>
+<div class="section" id="video">
+<h3>Video<a class="headerlink" href="#video" title="Link a questa intestazione">¶</a></h3>
+<p>Il video di demo è disponibile al seguente URL:</p>
 <ul class="simple">
-<li><p><a class="reference external" href="https://drive.google.com/file/d/15o70Ffe51CNj8LTKHC9dGiqRVnbv9UpZ/view?usp=sharing">https://drive.google.com/file/d/15o70Ffe51CNj8LTKHC9dGiqRVnbv9UpZ/view?usp=sharing</a></p></li>
+<li><p><a class="reference external" href="https://drive.google.com/file/d/15o70Ffe51CNj8LTKHC9dGiqRVnbv9UpZ/view">https://drive.google.com/file/d/15o70Ffe51CNj8LTKHC9dGiqRVnbv9UpZ/view</a></p></li>
 </ul>
 </div>
+<div class="section" id="interattiva">
+<h3>Interattiva<a class="headerlink" href="#interattiva" title="Link a questa intestazione">¶</a></h3>
+<p>Una demo interattiva è disponibile ai seguenti URL:</p>
+<ul class="simple">
+<li><p><a class="reference external" href="https://api.nest.steffo.eu/">https://api.nest.steffo.eu/</a> (backend)</p></li>
+<li><p><a class="reference external" href="https://prod.nest.steffo.eu/">https://prod.nest.steffo.eu/</a> (frontend pre-popolato)</p></li>
+<li><p><a class="reference external" href="https://docs.nest.steffo.eu/">https://docs.nest.steffo.eu/</a> (documentazione e relazione)</p></li>
+</ul>
+</div>
+</div>
 </div>
 
 

docs/build/html/development/sprint3/index.html

@@ -291,10 +291,6 @@ sviluppo in partenza.</p>
 </div>
 <div class="section" id="registro-attivita">
 <h2>Registro attività<a class="headerlink" href="#registro-attivita" title="Link a questa intestazione">¶</a></h2>
-<div class="admonition-todo admonition" id="id1">
-<p class="admonition-title">Da fare</p>
-<p>Compilare il registro attività dello sprint 3.</p>
-</div>
 <div class="section" id="riunioni-collettive">
 <h3>Riunioni collettive<a class="headerlink" href="#riunioni-collettive" title="Link a questa intestazione">¶</a></h3>
 <table class="docutils align-default">
@@ -755,7 +751,7 @@ sviluppo in partenza.</p>
 </div>
 <div class="section" id="giorgio-minoccari">
 <h4>Giorgio Minoccari<a class="headerlink" href="#giorgio-minoccari" title="Link a questa intestazione">¶</a></h4>
-<div class="admonition-todo admonition" id="id2">
+<div class="admonition-todo admonition" id="id1">
 <p class="admonition-title">Da fare</p>
 <p>Inserire activity log di Giorgio Minoccari relativo allo Sprint 3.</p>
 </div>

docs/build/html/genindex.html

@@ -177,7 +177,9 @@
 <div class="genindex-jumpbox">
  <a href="#_"><strong>_</strong></a>
  | <a href="#A"><strong>A</strong></a>
+ | <a href="#B"><strong>B</strong></a>
  | <a href="#C"><strong>C</strong></a>
+ | <a href="#D"><strong>D</strong></a>
  | <a href="#E"><strong>E</strong></a>
  | <a href="#F"><strong>F</strong></a>
  | <a href="#G"><strong>G</strong></a>
@@ -193,6 +195,7 @@
  | <a href="#S"><strong>S</strong></a>
  | <a href="#T"><strong>T</strong></a>
  | <a href="#U"><strong>U</strong></a>
+ | <a href="#V"><strong>V</strong></a>
  | <a href="#W"><strong>W</strong></a>
  
 </div>
@@ -282,6 +285,14 @@
   </ul></td>
 </tr></table>
 
+<h2 id="B">B</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="code/frontend/index.html#BackendCommunicationError">BackendCommunicationError() (classe)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -309,10 +320,16 @@
         <li><a href="code/backend/index.html#nest_backend.database.tables.MadeOf.condition">(nest_backend.database.tables.MadeOf attributo)</a>
 </li>
       </ul></li>
-      <li><a href="code/backend/index.html#nest_backend.database.tables.ConditionMode">ConditionMode (classe in nest_backend.database.tables)</a>
+      <li><a href="code/frontend/index.html#Condition">Condition() (classe)</a>
+</li>
+      <li><a href="code/frontend/index.html#ConditionHashtag">ConditionHashtag() (classe)</a>
+</li>
+      <li><a href="code/frontend/index.html#ConditionLocation">ConditionLocation() (classe)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="code/backend/index.html#nest_backend.database.tables.ConditionMode">ConditionMode (classe in nest_backend.database.tables)</a>
+</li>
       <li><a href="code/backend/index.html#nest_backend.database.tables.Alert.conditions">conditions (nest_backend.database.tables.Alert attributo)</a>
 
       <ul>
@@ -321,7 +338,11 @@
         <li><a href="code/backend/index.html#nest_backend.database.tables.Tweet.conditions">(nest_backend.database.tables.Tweet attributo)</a>
 </li>
       </ul></li>
+      <li><a href="code/frontend/index.html#ConditionTime">ConditionTime() (classe)</a>
+</li>
       <li><a href="code/backend/index.html#nest_backend.database.tables.ConditionType">ConditionType (classe in nest_backend.database.tables)</a>
+</li>
+      <li><a href="code/frontend/index.html#ConditionUser">ConditionUser() (classe)</a>
 </li>
       <li><a href="code/database/index.html#Contains">Contains (classe built-in)</a>
 
@@ -340,6 +361,14 @@
   </ul></td>
 </tr></table>
 
+<h2 id="D">D</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="code/frontend/index.html#DecodeError">DecodeError() (classe)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="E">E</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -367,6 +396,32 @@
 <h2 id="F">F</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="code/frontend/index.html#FetchAlreadyRunningError">FetchAlreadyRunningError() (classe)</a>
+</li>
+      <li><a href="code/frontend/index.html#FetchError">FetchError() (classe)</a>
+</li>
+      <li><a href="code/frontend/index.html#Filter">Filter() (classe)</a>
+</li>
+      <li><a href="code/frontend/index.html#FilterContains">FilterContains() (classe)</a>
+</li>
+      <li><a href="code/frontend/index.html#FilterHashtag">FilterHashtag() (classe)</a>
+</li>
+      <li><a href="code/frontend/index.html#FilterInsideMapArea">FilterInsideMapArea() (classe)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="code/frontend/index.html#FilterInsideTimeRay">FilterInsideTimeRay() (classe)</a>
+</li>
+      <li><a href="code/frontend/index.html#FilterIsRetweet">FilterIsRetweet() (classe)</a>
+</li>
+      <li><a href="code/frontend/index.html#FilterPoster">FilterPoster() (classe)</a>
+</li>
+      <li><a href="code/frontend/index.html#FilterWithImage">FilterWithImage() (classe)</a>
+</li>
+      <li><a href="code/frontend/index.html#FilterWithLocation">FilterWithLocation() (classe)</a>
+</li>
+      <li><a href="code/frontend/index.html#FilterWithPlace">FilterWithPlace() (classe)</a>
+</li>
       <li><a href="code/backend/index.html#nest_backend.gestione.find_user">find_user() (nel modulo nest_backend.gestione)</a>
 </li>
   </ul></td>
@@ -515,8 +570,6 @@
         <li><a href="code/backend/index.html#module-nest_backend.database.base">modulo</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     nest_backend.database.tables
 
@@ -524,6 +577,8 @@
         <li><a href="code/backend/index.html#module-nest_backend.database.tables">modulo</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     nest_backend.gestione
 
@@ -545,6 +600,8 @@
 </li>
       </ul></li>
       <li><a href="code/backend/index.html#nest_backend.database.tables.Alert.notifications">notifications (nest_backend.database.tables.Alert attributo)</a>
+</li>
+      <li><a href="code/frontend/index.html#NotImplementedError">NotImplementedError() (classe)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -618,6 +675,8 @@
         <li><a href="code/backend/index.html#nest_backend.database.tables.Condition.repository_id">(nest_backend.database.tables.Condition attributo)</a>
 </li>
       </ul></li>
+      <li><a href="code/frontend/index.html#ResultError">ResultError() (classe)</a>
+</li>
       <li><a href="code/backend/index.html#nest_backend.database.tables.Authorization.rid">rid (nest_backend.database.tables.Authorization attributo)</a>
 
       <ul>
@@ -635,9 +694,13 @@
       <li><a href="code/crawler/index.html#nest_crawler.send_notification_email">send_notification_email() (nel modulo nest_crawler)</a>
 </li>
       <li><a href="code/crawler/index.html#nest_crawler.send_notification_tweet">send_notification_tweet() (nel modulo nest_crawler)</a>
+</li>
+      <li><a href="code/frontend/index.html#SerializationError">SerializationError() (classe)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="code/frontend/index.html#ServerNotConfiguredError">ServerNotConfiguredError() (classe)</a>
+</li>
       <li><a href="code/backend/index.html#nest_backend.database.tables.Composed.snowflake">snowflake (nest_backend.database.tables.Composed attributo)</a>
 
       <ul>
@@ -719,6 +782,14 @@
   </ul></td>
 </tr></table>
 
+<h2 id="V">V</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="code/frontend/index.html#ViewNotAllowedError">ViewNotAllowedError() (classe)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="W">W</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>

docs/build/html/index.html

@@ -277,7 +277,11 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="development/artifacts.html">Artefatti</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="development/artifacts.html#diagrammi-uml">Diagrammi UML</a></li>
-<li class="toctree-l2"><a class="reference internal" href="development/artifacts.html#demo">Demo</a></li>
+<li class="toctree-l2"><a class="reference internal" href="development/artifacts.html#demo">Demo</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="development/artifacts.html#video">Video</a></li>
+<li class="toctree-l3"><a class="reference internal" href="development/artifacts.html#interattiva">Interattiva</a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="development/conclusions.html">Conclusioni</a></li>
@@ -305,21 +309,19 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="code/crawler/index.html"><code class="docutils literal notranslate"><span class="pre">nest_crawler</span></code> - Crawler in Python</a></li>
-<li class="toctree-l1"><a class="reference internal" href="code/frontend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_frontend</span></code> - Interfaccia utente in React</a></li>
+<li class="toctree-l1"><a class="reference internal" href="code/frontend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_frontend</span></code> - Interfaccia utente in React</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="code/frontend/index.html#objects-oggetti-vari-di-utility"><code class="docutils literal notranslate"><span class="pre">.objects</span></code> - Oggetti vari di utility</a></li>
+</ul>
+</li>
 </ul>
 </div>
 <div class="section" id="cose-rimaste-da-fare">
 <h2>Cose rimaste da fare<a class="headerlink" href="#cose-rimaste-da-fare" title="Link a questa intestazione">¶</a></h2>
 <div class="admonition-todo admonition">
 <p class="admonition-title">Da fare</p>
-<p>Compilare il registro attività dello sprint 3.</p>
-</div>
-<p class="todo-source">(L'<a class="reference internal" href="development/sprint3/index.html#id1"><em>riga originale</em></a> si trova in /Users/stefano/Documents/GitLab/g2-progetto/docs/source/development/sprint3/index.rst, linea 112.)</p>
-<div class="admonition-todo admonition">
-<p class="admonition-title">Da fare</p>
 <p>Inserire activity log di Giorgio Minoccari relativo allo Sprint 3.</p>
 </div>
-<p class="todo-source">(L'<a class="reference internal" href="development/sprint3/index.html#id2"><em>riga originale</em></a> si trova in /Users/stefano/Documents/GitLab/g2-progetto/docs/source/development/sprint3/index.rst, linea 472.)</p>
+<p class="todo-source">(L'<a class="reference internal" href="development/sprint3/index.html#id1"><em>riga originale</em></a> si trova in /mnt/tera/ext4/code/g2-progetto-2/docs/source/development/sprint3/index.rst, linea 468.)</p>
 </div>
 <div class="section" id="altri-collegamenti">
 <h2>Altri collegamenti<a class="headerlink" href="#altri-collegamenti" title="Link a questa intestazione">¶</a></h2>

docs/source/code/frontend/index.rst

@@ -1,2 +1,43 @@
 ``nest_frontend`` - Interfaccia utente in React
 ===============================================
+
+.. warning::
+
+    `JSDoc <https://jsdoc.app/>`_ non sembra essere in grado di gestire correttamente il lato frontend del progetto.
+
+    Per maggiori dettagli sul funzionamento dei vari componenti, si suggerisce di guardare le **docstring presenti nel
+    codice sorgente**.
+
+    Seguono sotto le uniche classi che JSDoc è stato in grado di gestire (anche se vengono mostrate solo
+    parzialmente).
+
+
+``.objects`` - Oggetti vari di utility
+---------------------------------------------------------
+
+.. js:autoclass:: Condition
+.. js:autoclass:: ConditionHashtag
+.. js:autoclass:: ConditionUser
+.. js:autoclass:: ConditionTime
+.. js:autoclass:: ConditionLocation
+.. js:autoclass:: NotImplementedError
+.. js:autoclass:: BackendCommunicationError
+.. js:autoclass:: ViewNotAllowedError
+.. js:autoclass:: ServerNotConfiguredError
+.. js:autoclass:: FetchAlreadyRunningError
+.. js:autoclass:: FetchError
+.. js:autoclass:: DecodeError
+.. js:autoclass:: ResultError
+.. js:autoclass:: SerializationError
+.. js:autoclass:: Filter
+.. js:autoclass:: FilterContains
+.. js:autoclass:: FilterHashtag
+.. js:autoclass:: FilterPoster
+.. js:autoclass:: FilterWithLocation
+.. js:autoclass:: FilterWithPlace
+.. js:autoclass:: FilterInsideMapArea
+.. js:autoclass:: FilterInsideTimeRay
+.. js:autoclass:: FilterWithImage
+.. js:autoclass:: FilterIsRetweet
+.. .. js:autoclass:: MapArea
+.. .. js:autoclass:: TimeRay

docs/source/conf.py

@@ -34,6 +34,7 @@ extensions = [
     "sphinx.ext.intersphinx",
     "sphinx.ext.todo",
     "sphinx.ext.autosectionlabel",
+    "sphinx_js"
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -102,6 +103,8 @@ def setup(app):
 todo_include_todos = True
 todo_emit_warnings = True
 smartquotes = False
+js_source_path = "../../nest_frontend"
+jsdoc_config_path = "../../conf.json"
 
 # -- Automodule settings -----------------------------------------------------
 

docs/source/development/sprint3/index.rst

@@ -109,10 +109,6 @@ Il video di Demo è disponibile al seguente link:
 Registro attività
 -----------------
 
-.. todo::
-
-    Compilare il registro attività dello sprint 3.
-
 
 Riunioni collettive
 ^^^^^^^^^^^^^^^^^^^

nest_frontend/components/providers/AlertEditor.js

@@ -60,8 +60,6 @@ export default function AlertEditor({className}) {
 
     /**
      * Save the current changes, creating or editing it as needed.
-     *
-     * @type {(function(): Promise<void>)|*}
      */
     const save = useCallback(
         async () => {
@@ -83,8 +81,6 @@ export default function AlertEditor({className}) {
 
     /**
      * Try to add a new condition, logging a message to the console if something goes wrong.
-     *
-     * @type {(function(): void)|*}
      */
     const addCondition = useCallback(
         (newCond) => {

nest_frontend/components/providers/RepositoryEditor.js

@@ -64,8 +64,6 @@ export default function RepositoryEditor({
 
     /**
      * Save the current changes, creating or editing it as needed.
-     *
-     * @type {(function(): Promise<void>)|*}
      */
     const save = useCallback(
         async () => {
@@ -97,8 +95,6 @@ export default function RepositoryEditor({
 
     /**
      * Cancel the changes made so far to the repository.
-     *
-     * @type {(function(): void)|*}
      */
     const revert = useCallback(
         () => {
@@ -111,8 +107,6 @@ export default function RepositoryEditor({
 
     /**
      * Try to add a new condition, logging a message to the console if something goes wrong.
-     *
-     * @type {(function(): void)|*}
      */
     const addCondition = useCallback(
         (newCond) => {

nest_frontend/objects/Coordinates.js

@@ -65,7 +65,7 @@ export default class Coordinates {
     /**
      * Transform this object in a 2-ple.
      *
-     * @returns {[Number, Number]}
+     * @returns {Array}
      */
     toArray() {
         return [this.lat, this.lng]

nest_frontend/objects/Errors.js

@@ -104,6 +104,9 @@ export class ResultError extends FetchError {
 }
 
 
+/**
+ * Error thrown when a string couldn't be serialized into an object.
+ */
 export class SerializationError {
     invalidString