Skip to content

Commit

Permalink
fixed contribute.md & comments.md
Browse files Browse the repository at this point in the history
  • Loading branch information
spirosmaggioros committed Feb 6, 2024
1 parent f1c01c6 commit 73f40b5
Show file tree
Hide file tree
Showing 31 changed files with 179 additions and 184 deletions.
2 changes: 1 addition & 1 deletion COMMENTS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### **How should i comment my code?**
### How should i comment my code?

The following is a **must** if you want to contribute, note that no maintaner or admin will add comments for you, the comments are strictly like this because the documentation is updated from the legacy code.

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### **How to contribute?**
### How to contribute?

* Open a **pull request** explaining your addition/fix. If it is an addition of a class or an algorithm please explain why it's useful and provide a url to a wikipedia page for the algorithm/data structure you're suggesting. *(Note that the code **must** follow our code-style to be accepted)*.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AlgoPlus: &lt;strong&gt;How should i comment my code?&lt;/strong&gt;</title>
<title>AlgoPlus: How should i comment my code?</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
Expand Down Expand Up @@ -72,7 +72,7 @@

</div><!-- top -->
<div><div class="header">
<div class="headertitle"><div class="title">&lt;strong&gt;How should i comment my code?&lt;/strong&gt;</div></div>
<div class="headertitle"><div class="title">How should i comment my code?</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="autotoc_md0"></a> The following is a <b>must</b> if you want to contribute, note that no maintaner or admin will add comments for you, the comments are strictly like this because the documentation is updated from the legacy code.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AlgoPlus: &lt;strong&gt;How to contribute?&lt;/strong&gt;</title>
<title>AlgoPlus: How to contribute?</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
Expand Down Expand Up @@ -72,7 +72,7 @@

</div><!-- top -->
<div><div class="header">
<div class="headertitle"><div class="title">&lt;strong&gt;How to contribute?&lt;/strong&gt;</div></div>
<div class="headertitle"><div class="title">How to contribute?</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="autotoc_md1"></a></p><ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AlgoPlus: Mini tutorial for circular linked list class</title>
<title>AlgoPlus: Mini tutorial for doubly linked list class</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
Expand Down Expand Up @@ -72,7 +72,7 @@

</div><!-- top -->
<div><div class="header">
<div class="headertitle"><div class="title">Mini tutorial for circular linked list class</div></div>
<div class="headertitle"><div class="title">Mini tutorial for doubly linked list class</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="autotoc_md46"></a></p><pre class="fragment">doubly_linked_list&lt;T&gt; -- creates a doubly linked list with elements of type T
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AlgoPlus: &lt;strong&gt;Mini tutorial for single linked list class&lt;/strong&gt;</title>
<title>AlgoPlus: Mini tutorial for single linked list class</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
Expand Down Expand Up @@ -72,7 +72,7 @@

</div><!-- top -->
<div><div class="header">
<div class="headertitle"><div class="title">&lt;strong&gt;Mini tutorial for single linked list class&lt;/strong&gt;</div></div>
<div class="headertitle"><div class="title">Mini tutorial for single linked list class</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="autotoc_md82"></a></p><pre class="fragment">linked_list&lt;T&gt; -- creates a linked list with elements of type T
Expand Down
8 changes: 4 additions & 4 deletions docs/html/pages.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,17 +77,17 @@
<div class="contents">
<div class="textblock">Here is a list of all related documentation pages:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2_c_o_m_m_e_n_t_s.html" target="_self">&lt;strong&gt;How should i comment my code?&lt;/strong&gt;</a></td><td class="desc"></td></tr>
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2_c_o_n_t_r_i_b_u_t_e.html" target="_self">&lt;strong&gt;How to contribute?&lt;/strong&gt;</a></td><td class="desc"></td></tr>
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2_c_o_m_m_e_n_t_s.html" target="_self">How should i comment my code?</a></td><td class="desc"></td></tr>
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2_c_o_n_t_r_i_b_u_t_e.html" target="_self">How to contribute?</a></td><td class="desc"></td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2tutorial_2avl.html" target="_self">Mini Tutorial for the AVL tree class</a></td><td class="desc"></td></tr>
<tr id="row_3_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2tutorial_2bst.html" target="_self">Mini Tutorial for the BST class</a></td><td class="desc"></td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2tutorial_2circular__linked__list.html" target="_self">Mini tutorial for circular linked list class</a></td><td class="desc"></td></tr>
<tr id="row_5_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2tutorial_2dequeue.html" target="_self">Mini Tutorial for the Stack class</a></td><td class="desc"></td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2tutorial_2doubly__linked__list.html" target="_self">Mini tutorial for circular linked list class</a></td><td class="desc"></td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2tutorial_2doubly__linked__list.html" target="_self">Mini tutorial for doubly linked list class</a></td><td class="desc"></td></tr>
<tr id="row_7_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2tutorial_2graph.html" target="_self">Mini Tutorial for the Graph class</a></td><td class="desc"></td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2tutorial_2hash__table.html" target="_self">Mini Tutorial for the hash_table class</a></td><td class="desc"></td></tr>
<tr id="row_9_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2tutorial_2interval__tree.html" target="_self">Mini Tutorial for the Interval Tree class</a></td><td class="desc"></td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2tutorial_2linked__list.html" target="_self">&lt;strong&gt;Mini tutorial for single linked list class&lt;/strong&gt;</a></td><td class="desc"></td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2tutorial_2linked__list.html" target="_self">Mini tutorial for single linked list class</a></td><td class="desc"></td></tr>
<tr id="row_11_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2tutorial_2skip__list.html" target="_self">Mini Tutorial for the Skip List class</a></td><td class="desc"></td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2tutorial_2splay__tree.html" target="_self">Mini Tutorial for the Splay Tree class</a></td><td class="desc"></td></tr>
<tr id="row_13_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="md__2_users_2spirosmag_2_documents_2_algo_plus_2tutorial_2stack.html" target="_self">Mini Tutorial for the Stack class</a></td><td class="desc"></td></tr>
Expand Down
Loading

0 comments on commit 73f40b5

Please sign in to comment.