Skip to content

Commit 75477a1

Browse files
thomas40510thomas40510
committed
compiled latex doc
1 parent 0d68249 commit 75477a1

File tree

190 files changed

+17342
-18
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

190 files changed

+17342
-18
lines changed

‎Notes.md

+26-9
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,36 @@
11
# Notes on the project
22

3-
These are notes for me to reference different sources or thoughts I had on a particular function.
3+
Voici mes notes sur le projet et les résultats concernant les 2 méthodes de traitement des fichiers.
44

55
## Function make_cell_from_line
66

7-
For this function, we use the string.h library.
7+
For this function, we use the `string.h` library.
88
In this one, we have the function `strtok`
99

10-
## Function pop
11-
12-
We want to make a function that pops the first element of the list.
13-
On utilise pop pour copier les infos du premier élément vers le paramètre de sortie de la fonction.
14-
On alloue la mémoire de notre paramètre de sortie en dehors de la fonction.
15-
Ensuite, on libère la mémoire de l'élément qui est enlevé après avoir changé la tête de la liste pour le second élément.
16-
1710
## Remarques
1811

1912
Pour faire un checkup des allocations de mémoire et du programme, on utilise `valgrind`
13+
14+
## Captures d'écran sur les résultats du programme
15+
16+
Voici quelques images sur les résultats des 2 méthodes de listes. (Respectivement pour le fichier `small.txt`, `medium.txt` et `large.txt`)
17+
18+
![Small text file on both methods](small.png)
19+
20+
![Medium text file on both methods](medium.png)
21+
22+
![Large text file on both methods](large.png)
23+
24+
## Création d'une documentation pour le projet C
25+
26+
Utilisation de Doxygen pour générer la documentation automatiquement à partir des commentaires dans le code. \
27+
Référence pour l'utilisation de `doxygen` en CLI : [doxygen usage](https://doxygen.nl/manual/doxygen_usage.html) \
28+
29+
Pour bien l'utiliser, il faut bien mettre en forme les commentaires dans le code et utiliser la syntaxe de la doc. \
30+
Ensuite, quand on veut générer la documentation, on se réfère au fichier de configuration que l'on a créé et on vérifie s'il y a bien les bons dossiers et paramètres mis en place pour générer la doc. \
31+
Il est notamment important de mettre l'endroit vers les codes sources dans le paramètre `INPUT`.
32+
33+
Ensuite, on utilise les commandes suivantes :
34+
`doxygen nom_fichier_config`. \
35+
Et tous les fichiers sont générés en fonction de la configuration choisie. \
36+
Pour générer le fichier de configuration, on utilise `doxygen -g nom_fichier_config`

‎bin/main.o

32 Bytes
Binary file not shown.

‎bin/womc

0 Bytes
Binary file not shown.

‎docs/html/annotated.html

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.17"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Projet C: Data Structures</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">Projet C
25+
&#160;<span id="projectnumber">1.0.0</span>
26+
</div>
27+
</td>
28+
</tr>
29+
</tbody>
30+
</table>
31+
</div>
32+
<!-- end header part -->
33+
<!-- Generated by Doxygen 1.8.17 -->
34+
<script type="text/javascript">
35+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
36+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
37+
/* @license-end */
38+
</script>
39+
<script type="text/javascript" src="menudata.js"></script>
40+
<script type="text/javascript" src="menu.js"></script>
41+
<script type="text/javascript">
42+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
43+
$(function() {
44+
initMenu('',true,false,'search.php','Search');
45+
$(document).ready(function() { init_search(); });
46+
});
47+
/* @license-end */</script>
48+
<div id="main-nav"></div>
49+
</div><!-- top -->
50+
<!-- window showing the filter options -->
51+
<div id="MSearchSelectWindow"
52+
onmouseover="return searchBox.OnSearchSelectShow()"
53+
onmouseout="return searchBox.OnSearchSelectHide()"
54+
onkeydown="return searchBox.OnSearchSelectKey(event)">
55+
</div>
56+
57+
<!-- iframe showing the search results (closed by default) -->
58+
<div id="MSearchResultsWindow">
59+
<iframe src="javascript:void(0)" frameborder="0"
60+
name="MSearchResults" id="MSearchResults">
61+
</iframe>
62+
</div>
63+
64+
<div class="header">
65+
<div class="headertitle">
66+
<div class="title">Data Structures</div> </div>
67+
</div><!--header-->
68+
<div class="contents">
69+
<div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
70+
<table class="directory">
71+
<tr id="row_0_" 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="structcell.html" target="_self">cell</a></td><td class="desc"></td></tr>
72+
<tr id="row_1_"><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="structlcell.html" target="_self">lcell</a></td><td class="desc"></td></tr>
73+
<tr id="row_2_" 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="structlist.html" target="_self">list</a></td><td class="desc"></td></tr>
74+
<tr id="row_3_"><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="structllist.html" target="_self">llist</a></td><td class="desc"></td></tr>
75+
</table>
76+
</div><!-- directory -->
77+
</div><!-- contents -->
78+
<!-- start footer part -->
79+
<hr class="footer"/><address class="footer"><small>
80+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
81+
<img class="footer" src="doxygen.png" alt="doxygen"/>
82+
</a> 1.8.17
83+
</small></address>
84+
</body>
85+
</html>

‎docs/html/bc_s.png

676 Bytes
Loading

‎docs/html/bdwn.png

147 Bytes
Loading

‎docs/html/classes.html

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.17"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Projet C: Data Structure Index</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">Projet C
25+
&#160;<span id="projectnumber">1.0.0</span>
26+
</div>
27+
</td>
28+
</tr>
29+
</tbody>
30+
</table>
31+
</div>
32+
<!-- end header part -->
33+
<!-- Generated by Doxygen 1.8.17 -->
34+
<script type="text/javascript">
35+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
36+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
37+
/* @license-end */
38+
</script>
39+
<script type="text/javascript" src="menudata.js"></script>
40+
<script type="text/javascript" src="menu.js"></script>
41+
<script type="text/javascript">
42+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
43+
$(function() {
44+
initMenu('',true,false,'search.php','Search');
45+
$(document).ready(function() { init_search(); });
46+
});
47+
/* @license-end */</script>
48+
<div id="main-nav"></div>
49+
</div><!-- top -->
50+
<!-- window showing the filter options -->
51+
<div id="MSearchSelectWindow"
52+
onmouseover="return searchBox.OnSearchSelectShow()"
53+
onmouseout="return searchBox.OnSearchSelectHide()"
54+
onkeydown="return searchBox.OnSearchSelectKey(event)">
55+
</div>
56+
57+
<!-- iframe showing the search results (closed by default) -->
58+
<div id="MSearchResultsWindow">
59+
<iframe src="javascript:void(0)" frameborder="0"
60+
name="MSearchResults" id="MSearchResults">
61+
</iframe>
62+
</div>
63+
64+
<div class="header">
65+
<div class="headertitle">
66+
<div class="title">Data Structure Index</div> </div>
67+
</div><!--header-->
68+
<div class="contents">
69+
<div class="qindex"><a class="qindex" href="#letter_c">c</a>&#160;|&#160;<a class="qindex" href="#letter_l">l</a></div>
70+
<table class="classindex">
71+
<tr><td rowspan="2" valign="bottom"><a name="letter_c"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;c&#160;&#160;</div></td></tr></table>
72+
</td>
73+
<td rowspan="2" valign="bottom"><a name="letter_l"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;l&#160;&#160;</div></td></tr></table>
74+
</td>
75+
<td valign="top"><a class="el" href="structlist.html">list</a>&#160;&#160;&#160;</td>
76+
<td></td></tr>
77+
<tr><td valign="top"><a class="el" href="structllist.html">llist</a>&#160;&#160;&#160;</td>
78+
<td></td></tr>
79+
<tr><td valign="top"><a class="el" href="structcell.html">cell</a>&#160;&#160;&#160;</td>
80+
<td valign="top"><a class="el" href="structlcell.html">lcell</a>&#160;&#160;&#160;</td>
81+
<td></td><td></td></tr>
82+
<tr><td></td><td></td><td></td><td></td></tr>
83+
</table>
84+
<div class="qindex"><a class="qindex" href="#letter_c">c</a>&#160;|&#160;<a class="qindex" href="#letter_l">l</a></div>
85+
</div><!-- contents -->
86+
<!-- start footer part -->
87+
<hr class="footer"/><address class="footer"><small>
88+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
89+
<img class="footer" src="doxygen.png" alt="doxygen"/>
90+
</a> 1.8.17
91+
</small></address>
92+
</body>
93+
</html>

‎docs/html/closed.png

132 Bytes
Loading

‎docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.17"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Projet C: src Directory Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">Projet C
25+
&#160;<span id="projectnumber">1.0.0</span>
26+
</div>
27+
</td>
28+
</tr>
29+
</tbody>
30+
</table>
31+
</div>
32+
<!-- end header part -->
33+
<!-- Generated by Doxygen 1.8.17 -->
34+
<script type="text/javascript">
35+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
36+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
37+
/* @license-end */
38+
</script>
39+
<script type="text/javascript" src="menudata.js"></script>
40+
<script type="text/javascript" src="menu.js"></script>
41+
<script type="text/javascript">
42+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
43+
$(function() {
44+
initMenu('',true,false,'search.php','Search');
45+
$(document).ready(function() { init_search(); });
46+
});
47+
/* @license-end */</script>
48+
<div id="main-nav"></div>
49+
<!-- window showing the filter options -->
50+
<div id="MSearchSelectWindow"
51+
onmouseover="return searchBox.OnSearchSelectShow()"
52+
onmouseout="return searchBox.OnSearchSelectHide()"
53+
onkeydown="return searchBox.OnSearchSelectKey(event)">
54+
</div>
55+
56+
<!-- iframe showing the search results (closed by default) -->
57+
<div id="MSearchResultsWindow">
58+
<iframe src="javascript:void(0)" frameborder="0"
59+
name="MSearchResults" id="MSearchResults">
60+
</iframe>
61+
</div>
62+
63+
<div id="nav-path" class="navpath">
64+
<ul>
65+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
66+
</div>
67+
</div><!-- top -->
68+
<div class="header">
69+
<div class="headertitle">
70+
<div class="title">src Directory Reference</div> </div>
71+
</div><!--header-->
72+
<div class="contents">
73+
<table class="memberdecls">
74+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
75+
Files</h2></td></tr>
76+
<tr class="memitem:list_8c"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="list_8c.html">list.c</a></td></tr>
77+
<tr class="memdesc:list_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the <a class="el" href="list_8c.html" title="This is the list.c file.">list.c</a> file. <br /></td></tr>
78+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
79+
<tr class="memitem:list_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="list_8h.html">list.h</a> <a href="list_8h_source.html">[code]</a></td></tr>
80+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
81+
<tr class="memitem:llist_8c"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="llist_8c.html">llist.c</a></td></tr>
82+
<tr class="memdesc:llist_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the <a class="el" href="llist_8c.html" title="This is the llist.c file.">llist.c</a> file. <br /></td></tr>
83+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
84+
<tr class="memitem:llist_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="llist_8h.html">llist.h</a> <a href="llist_8h_source.html">[code]</a></td></tr>
85+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
86+
<tr class="memitem:main_8c"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="main_8c.html">main.c</a></td></tr>
87+
<tr class="memdesc:main_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the main file used to launch the methods for loading files. <br /></td></tr>
88+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
89+
</table>
90+
</div><!-- contents -->
91+
<!-- start footer part -->
92+
<hr class="footer"/><address class="footer"><small>
93+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
94+
<img class="footer" src="doxygen.png" alt="doxygen"/>
95+
</a> 1.8.17
96+
</small></address>
97+
</body>
98+
</html>

‎docs/html/doc.png

746 Bytes
Loading

0 commit comments

Comments
 (0)