Skip to content
This repository has been archived by the owner on Mar 26, 2024. It is now read-only.

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
migueltc13 committed Jan 24, 2024
1 parent cff869f commit 7ada59f
Show file tree
Hide file tree
Showing 19 changed files with 25 additions and 23 deletions.
2 changes: 1 addition & 1 deletion docs/html/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceBetterFinds.html" target="_self">BetterFinds</a></td><td class="desc">The namespace containing all classes and components for this project </td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceBetterFinds_1_1Hubs.html" target="_self">Hubs</a></td><td class="desc">The namespace containing the <b>SignalR</b> hub used for real-time updates </td></tr>
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classBetterFinds_1_1Hubs_1_1NotificationHub.html" target="_self">NotificationHub</a></td><td class="desc">SignalR hub for notifications </td></tr>
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classBetterFinds_1_1Hubs_1_1NotificationHub.html" target="_self">NotificationHub</a></td><td class="desc"><b>SignalR</b> hub for notifications and live updates </td></tr>
<tr id="row_0_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_1_" class="arrow" onclick="toggleFolder('0_1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceBetterFinds_1_1Services.html" target="_self">Services</a></td><td class="desc">The namespace containing the asynchronous services used at the start of the application </td></tr>
<tr id="row_0_1_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classBetterFinds_1_1Services_1_1AuctionBackgroundService.html" target="_self">AuctionBackgroundService</a></td><td class="desc">Background service that checks for auctions that ended and notifies users </td></tr>
<tr id="row_0_2_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_2_" class="arrow" onclick="toggleFolder('0_2_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceBetterFinds_1_1Utils.html" target="_self">Utils</a></td><td class="desc">The namespace containing utility classes for this project </td></tr>
Expand Down
8 changes: 4 additions & 4 deletions docs/html/classBetterFinds_1_1Hubs_1_1NotificationHub.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,14 @@
</div><!--header-->
<div class="contents">

<p>SignalR hub for notifications
<p><b>SignalR</b> hub for notifications and live updates.
<a href="classBetterFinds_1_1Hubs_1_1NotificationHub.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for BetterFinds.Hubs.NotificationHub:</div>
<div class="dyncontent">
<div class="center"><img src="classBetterFinds_1_1Hubs_1_1NotificationHub__inherit__graph.png" border="0" usemap="#aBetterFinds_8Hubs_8NotificationHub_inherit__map" alt="Inheritance graph"/></div>
<map name="aBetterFinds_8Hubs_8NotificationHub_inherit__map" id="aBetterFinds_8Hubs_8NotificationHub_inherit__map">
<area shape="rect" title="SignalR hub for notifications" alt="" coords="5,80,244,107"/>
<area shape="rect" title="SignalR hub for notifications and live updates." alt="" coords="5,80,244,107"/>
<area shape="rect" title=" " alt="" coords="101,5,149,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
Expand All @@ -89,12 +89,12 @@
<div class="dyncontent">
<div class="center"><img src="classBetterFinds_1_1Hubs_1_1NotificationHub__coll__graph.png" border="0" usemap="#aBetterFinds_8Hubs_8NotificationHub_coll__map" alt="Collaboration graph"/></div>
<map name="aBetterFinds_8Hubs_8NotificationHub_coll__map" id="aBetterFinds_8Hubs_8NotificationHub_coll__map">
<area shape="rect" title="SignalR hub for notifications" alt="" coords="5,80,244,107"/>
<area shape="rect" title="SignalR hub for notifications and live updates." alt="" coords="5,80,244,107"/>
<area shape="rect" title=" " alt="" coords="101,5,149,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>SignalR hub for notifications </p>
<div class="textblock"><p><b>SignalR</b> hub for notifications and live updates. </p>
<p>This hub is used to send notifications to the client and live update the UI. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>BetterFinds/Hubs/NotificationHub.cs</li>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<map id="BetterFinds.Hubs.NotificationHub" name="BetterFinds.Hubs.NotificationHub">
<area shape="rect" id="node1" title="SignalR hub for notifications" alt="" coords="5,80,244,107"/>
<area shape="rect" id="node1" title="SignalR hub for notifications and live updates." alt="" coords="5,80,244,107"/>
<area shape="rect" id="node2" title=" " alt="" coords="101,5,149,32"/>
</map>
Original file line number Diff line number Diff line change
@@ -1 +1 @@
607978016f6ac48125e2916ac9da5fdb
e275a646b80ca85d7a14f078f11aece9
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<map id="BetterFinds.Hubs.NotificationHub" name="BetterFinds.Hubs.NotificationHub">
<area shape="rect" id="node1" title="SignalR hub for notifications" alt="" coords="5,80,244,107"/>
<area shape="rect" id="node1" title="SignalR hub for notifications and live updates." alt="" coords="5,80,244,107"/>
<area shape="rect" id="node2" title=" " alt="" coords="101,5,149,32"/>
</map>
Original file line number Diff line number Diff line change
@@ -1 +1 @@
607978016f6ac48125e2916ac9da5fdb
e275a646b80ca85d7a14f078f11aece9
2 changes: 1 addition & 1 deletion docs/html/hierarchy.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<tr id="row_3_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classBetterFinds_1_1Utils_1_1Client.html" target="_self">BetterFinds.Utils.Client</a></td><td class="desc">Provides utility functions for handling client-related operations </td></tr>
<tr id="row_4_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classBetterFinds_1_1Utils_1_1Currency.html" target="_self">BetterFinds.Utils.Currency</a></td><td class="desc">Provides utility functions for handling currency-related operations </td></tr>
<tr id="row_5_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_5_" class="arrow" onclick="toggleFolder('5_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>Hub</b></td><td class="desc"></td></tr>
<tr id="row_5_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classBetterFinds_1_1Hubs_1_1NotificationHub.html" target="_self">BetterFinds.Hubs.NotificationHub</a></td><td class="desc">SignalR hub for notifications </td></tr>
<tr id="row_5_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classBetterFinds_1_1Hubs_1_1NotificationHub.html" target="_self">BetterFinds.Hubs.NotificationHub</a></td><td class="desc"><b>SignalR</b> hub for notifications and live updates </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classBetterFinds_1_1Utils_1_1Images.html" target="_self">BetterFinds.Utils.Images</a></td><td class="desc">Provides utility functions for handling images-related operations </td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classBetterFinds_1_1Utils_1_1Notification.html" target="_self">BetterFinds.Utils.Notification</a></td><td class="desc">Provides utility functions for handling notifications-related operations </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_8_" class="arrow" onclick="toggleFolder('8_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>PageModel</b></td><td class="desc"></td></tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/inherit_graph_0.map
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<map id="Graphical Class Hierarchy" name="Graphical Class Hierarchy">
<area shape="rect" id="node1" title=" " alt="" coords="5,5,53,32"/>
<area shape="rect" id="node2" href="$classBetterFinds_1_1Hubs_1_1NotificationHub.html" title="SignalR hub for notifications" alt="" coords="101,5,340,32"/>
<area shape="rect" id="node2" href="$classBetterFinds_1_1Hubs_1_1NotificationHub.html" title="SignalR hub for notifications and live updates." alt="" coords="101,5,340,32"/>
</map>
2 changes: 1 addition & 1 deletion docs/html/inherit_graph_0.md5
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1f524624d5c6290e88b27a5bd5d3ee04
7a88be1b9188be25d626d9adacd50558
2 changes: 1 addition & 1 deletion docs/html/inherits.html
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
<tr><td><img src="inherit_graph_0.png" border="0" usemap="#aBetterFinds_8Hubs_8NotificationHub" alt=""/>
<map name="aBetterFinds_8Hubs_8NotificationHub" id="aBetterFinds_8Hubs_8NotificationHub">
<area shape="rect" title=" " alt="" coords="5,5,53,32"/>
<area shape="rect" href="classBetterFinds_1_1Hubs_1_1NotificationHub.html" title="SignalR hub for notifications" alt="" coords="101,5,340,32"/>
<area shape="rect" href="classBetterFinds_1_1Hubs_1_1NotificationHub.html" title="SignalR hub for notifications and live updates." alt="" coords="101,5,340,32"/>
</map>
</td></tr>
<tr><td><img src="inherit_graph_1.png" border="0" usemap="#aBetterFinds_8Services_8AuctionBackgroundService" alt=""/>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/namespaceBetterFinds_1_1Hubs.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBetterFinds_1_1Hubs_1_1NotificationHub.html">NotificationHub</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">SignalR hub for notifications <a href="classBetterFinds_1_1Hubs_1_1NotificationHub.html#details">More...</a><br /></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>SignalR</b> hub for notifications and live updates. <a href="classBetterFinds_1_1Hubs_1_1NotificationHub.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/namespaces.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceBetterFinds.html" target="_self">BetterFinds</a></td><td class="desc">The namespace containing all classes and components for this project </td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceBetterFinds_1_1Hubs.html" target="_self">Hubs</a></td><td class="desc">The namespace containing the <b>SignalR</b> hub used for real-time updates </td></tr>
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classBetterFinds_1_1Hubs_1_1NotificationHub.html" target="_self">NotificationHub</a></td><td class="desc">SignalR hub for notifications </td></tr>
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classBetterFinds_1_1Hubs_1_1NotificationHub.html" target="_self">NotificationHub</a></td><td class="desc"><b>SignalR</b> hub for notifications and live updates </td></tr>
<tr id="row_0_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceBetterFinds_1_1Pages.html" target="_self">Pages</a></td><td class="desc">The namespace containing the <b>Razor Pages</b> that make up the core of this web application </td></tr>
<tr id="row_0_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_2_" class="arrow" onclick="toggleFolder('0_2_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceBetterFinds_1_1Services.html" target="_self">Services</a></td><td class="desc">The namespace containing the asynchronous services used at the start of the application </td></tr>
<tr id="row_0_2_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classBetterFinds_1_1Services_1_1AuctionBackgroundService.html" target="_self">AuctionBackgroundService</a></td><td class="desc">Background service that checks for auctions that ended and notifies users </td></tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/latex/annotated.tex
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
\item\contentsline{section}{\mbox{\hyperlink{classBetterFinds_1_1Utils_1_1Images}{Better\+Finds.\+Utils.\+Images}} \\*Provides utility functions for handling images-\/related operations }{\pageref{classBetterFinds_1_1Utils_1_1Images}}{}
\item\contentsline{section}{\mbox{\hyperlink{classLogoutModel}{Logout\+Model}} }{\pageref{classLogoutModel}}{}
\item\contentsline{section}{\mbox{\hyperlink{classBetterFinds_1_1Utils_1_1Notification}{Better\+Finds.\+Utils.\+Notification}} \\*Provides utility functions for handling notifications-\/related operations }{\pageref{classBetterFinds_1_1Utils_1_1Notification}}{}
\item\contentsline{section}{\mbox{\hyperlink{classBetterFinds_1_1Hubs_1_1NotificationHub}{Better\+Finds.\+Hubs.\+Notification\+Hub}} \\*SignalR hub for notifications }{\pageref{classBetterFinds_1_1Hubs_1_1NotificationHub}}{}
\item\contentsline{section}{\mbox{\hyperlink{classBetterFinds_1_1Hubs_1_1NotificationHub}{Better\+Finds.\+Hubs.\+Notification\+Hub}} \\*{\bfseries{SignalR}} hub for notifications and live updates }{\pageref{classBetterFinds_1_1Hubs_1_1NotificationHub}}{}
\item\contentsline{section}{\mbox{\hyperlink{classProgram}{Program}} }{\pageref{classProgram}}{}
\end{DoxyCompactList}
10 changes: 6 additions & 4 deletions docs/latex/classBetterFinds_1_1Hubs_1_1NotificationHub.tex
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
\label{classBetterFinds_1_1Hubs_1_1NotificationHub}\index{BetterFinds.Hubs.NotificationHub@{BetterFinds.Hubs.NotificationHub}}


SignalR hub for notifications
{\bfseries{SignalR}} hub for notifications and live updates.




Inheritance diagram for Better\+Finds.\+Hubs.\+Notification\+Hub\+:\nopagebreak
Inheritance diagram for Better\+Finds.\+Hubs.\+Notification\+Hub\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
Expand All @@ -16,7 +17,8 @@
\end{figure}


Collaboration diagram for Better\+Finds.\+Hubs.\+Notification\+Hub\+:\nopagebreak
Collaboration diagram for Better\+Finds.\+Hubs.\+Notification\+Hub\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
Expand All @@ -26,7 +28,7 @@


\doxysubsection{Detailed Description}
SignalR hub for notifications
{\bfseries{SignalR}} hub for notifications and live updates.

This hub is used to send notifications to the client and live update the UI.

Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
8b9acaaa8570338f6444d8770043258a
db277a779e3899cc4345210441d3e84a
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
8b9acaaa8570338f6444d8770043258a
db277a779e3899cc4345210441d3e84a
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/latex/namespaceBetterFinds_1_1Hubs.tex
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
\begin{DoxyCompactItemize}
\item
class \mbox{\hyperlink{classBetterFinds_1_1Hubs_1_1NotificationHub}{Notification\+Hub}}
\begin{DoxyCompactList}\small\item\em SignalR hub for notifications \end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{DoxyCompactList}\small\item\em {\bfseries{SignalR}} hub for notifications and live updates. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Expand Down

0 comments on commit 7ada59f

Please sign in to comment.