ajout doc doxygene

.vscode/configurationCache.log

@@ -1 +1 @@
-{"buildTargets":["bin/exe","clean"],"launchTargets":["/Users/malanone/SAE2.02/sae2.02-1/bin>exe()"],"customConfigurationProvider":{"workspaceBrowse":{"browsePath":["/Users/malanone/SAE2.02/sae2.02-1/src"],"compilerArgs":["-Wall","-c","src/main.cpp","-o","obj/main.o"],"compilerPath":"/usr/bin/g++","standard":"c++17","windowsSdkVersion":""},"fileIndex":[["/Users/malanone/SAE2.02/sae2.02-1/src/Contact.cpp",{"uri":{"$mid":1,"fsPath":"/Users/malanone/SAE2.02/sae2.02-1/src/Contact.cpp","path":"/Users/malanone/SAE2.02/sae2.02-1/src/Contact.cpp","scheme":"file"},"configuration":{"defines":[],"standard":"c++17","includePath":[],"forcedInclude":[],"compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-c","src/Contact.cpp","-o","obj/Contact.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -std=c++17 -Wall -c src/Contact.cpp -o obj/Contact.o","directory":"/Users/malanone/SAE2.02/sae2.02-1","file":"/Users/malanone/SAE2.02/sae2.02-1/src/Contact.cpp"}}],["/Users/malanone/SAE2.02/sae2.02-1/src/Personne.cpp",{"uri":{"$mid":1,"fsPath":"/Users/malanone/SAE2.02/sae2.02-1/src/Personne.cpp","path":"/Users/malanone/SAE2.02/sae2.02-1/src/Personne.cpp","scheme":"file"},"configuration":{"defines":[],"standard":"c++17","includePath":[],"forcedInclude":[],"compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-c","src/Personne.cpp","-o","obj/Personne.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -std=c++17 -Wall -c src/Personne.cpp -o obj/Personne.o","directory":"/Users/malanone/SAE2.02/sae2.02-1","file":"/Users/malanone/SAE2.02/sae2.02-1/src/Personne.cpp"}}],["/Users/malanone/SAE2.02/sae2.02-1/src/main.cpp",{"uri":{"$mid":1,"fsPath":"/Users/malanone/SAE2.02/sae2.02-1/src/main.cpp","path":"/Users/malanone/SAE2.02/sae2.02-1/src/main.cpp","scheme":"file"},"configuration":{"defines":[],"standard":"c++17","includePath":[],"forcedInclude":[],"compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-c","src/main.cpp","-o","obj/main.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -std=c++17 -Wall -c src/main.cpp -o obj/main.o","directory":"/Users/malanone/SAE2.02/sae2.02-1","file":"/Users/malanone/SAE2.02/sae2.02-1/src/main.cpp"}}]]}}
+{"buildTargets":["bin/exe","clean"],"launchTargets":["/Users/malanone/SAE2.02/sae2.02-2/bin>exe()"],"customConfigurationProvider":{"workspaceBrowse":{"browsePath":["/Users/malanone/SAE2.02/sae2.02-2/src"],"compilerArgs":["-Wall","-c","src/main.cpp","-o","obj/main.o"],"compilerPath":"/usr/bin/g++","standard":"c++17","windowsSdkVersion":""},"fileIndex":[["/Users/malanone/SAE2.02/sae2.02-2/src/Contact.cpp",{"uri":{"$mid":1,"fsPath":"/Users/malanone/SAE2.02/sae2.02-2/src/Contact.cpp","path":"/Users/malanone/SAE2.02/sae2.02-2/src/Contact.cpp","scheme":"file"},"configuration":{"defines":[],"standard":"c++17","includePath":[],"forcedInclude":[],"compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-c","src/Contact.cpp","-o","obj/Contact.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -std=c++17 -Wall -c src/Contact.cpp -o obj/Contact.o","directory":"/Users/malanone/SAE2.02/sae2.02-2","file":"/Users/malanone/SAE2.02/sae2.02-2/src/Contact.cpp"}}],["/Users/malanone/SAE2.02/sae2.02-2/src/Contact3.cpp",{"uri":{"$mid":1,"fsPath":"/Users/malanone/SAE2.02/sae2.02-2/src/Contact3.cpp","path":"/Users/malanone/SAE2.02/sae2.02-2/src/Contact3.cpp","scheme":"file"},"configuration":{"defines":[],"standard":"c++17","includePath":[],"forcedInclude":[],"compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-c","src/Contact3.cpp","-o","obj/Contact3.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -std=c++17 -Wall -c src/Contact3.cpp -o obj/Contact3.o","directory":"/Users/malanone/SAE2.02/sae2.02-2","file":"/Users/malanone/SAE2.02/sae2.02-2/src/Contact3.cpp"}}],["/Users/malanone/SAE2.02/sae2.02-2/src/Personne.cpp",{"uri":{"$mid":1,"fsPath":"/Users/malanone/SAE2.02/sae2.02-2/src/Personne.cpp","path":"/Users/malanone/SAE2.02/sae2.02-2/src/Personne.cpp","scheme":"file"},"configuration":{"defines":[],"standard":"c++17","includePath":[],"forcedInclude":[],"compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-c","src/Personne.cpp","-o","obj/Personne.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -std=c++17 -Wall -c src/Personne.cpp -o obj/Personne.o","directory":"/Users/malanone/SAE2.02/sae2.02-2","file":"/Users/malanone/SAE2.02/sae2.02-2/src/Personne.cpp"}}],["/Users/malanone/SAE2.02/sae2.02-2/src/Personne3.cpp",{"uri":{"$mid":1,"fsPath":"/Users/malanone/SAE2.02/sae2.02-2/src/Personne3.cpp","path":"/Users/malanone/SAE2.02/sae2.02-2/src/Personne3.cpp","scheme":"file"},"configuration":{"defines":[],"standard":"c++17","includePath":[],"forcedInclude":[],"compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-c","src/Personne3.cpp","-o","obj/Personne3.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -std=c++17 -Wall -c src/Personne3.cpp -o obj/Personne3.o","directory":"/Users/malanone/SAE2.02/sae2.02-2","file":"/Users/malanone/SAE2.02/sae2.02-2/src/Personne3.cpp"}}],["/Users/malanone/SAE2.02/sae2.02-2/src/main.cpp",{"uri":{"$mid":1,"fsPath":"/Users/malanone/SAE2.02/sae2.02-2/src/main.cpp","path":"/Users/malanone/SAE2.02/sae2.02-2/src/main.cpp","scheme":"file"},"configuration":{"defines":[],"standard":"c++17","includePath":[],"forcedInclude":[],"compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-c","src/main.cpp","-o","obj/main.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -std=c++17 -Wall -c src/main.cpp -o obj/main.o","directory":"/Users/malanone/SAE2.02/sae2.02-2","file":"/Users/malanone/SAE2.02/sae2.02-2/src/main.cpp"}}]]}}

.vscode/dryrun.log

@@ -1,8 +1,11 @@
 make --dry-run --always-make --keep-going --print-directory
-make: Entering directory `/Users/malanone/SAE2.02/sae2.02-1'
+make: Entering directory `/Users/malanone/SAE2.02/sae2.02-2'
 g++ -std=c++17 -Wall -c src/Contact.cpp -o obj/Contact.o
+ 
+g++ -std=c++17 -Wall -c src/Contact3.cpp -o obj/Contact3.o
 g++ -std=c++17 -Wall -c src/Personne.cpp -o obj/Personne.o
+g++ -std=c++17 -Wall -c src/Personne3.cpp -o obj/Personne3.o
 g++ -std=c++17 -Wall -c src/main.cpp -o obj/main.o
-g++ obj/Contact.o obj/Personne.o obj/main.o -o bin/exe
+g++ obj/Contact.o obj/Contact3.o obj/Personne.o obj/Personne3.o obj/main.o -o bin/exe
-make: Leaving directory `/Users/malanone/SAE2.02/sae2.02-1'
+make: Leaving directory `/Users/malanone/SAE2.02/sae2.02-2'
  

.vscode/targets.log

@@ -7,7 +7,7 @@ make all --print-data-base --no-builtin-variables --no-builtin-rules --question
 
 # This program built for i386-apple-darwin11.3.0
 
-# Make data base, printed on Thu Mar 31 13:46:13 2022
+# Make data base, printed on Fri Apr  1 22:38:18 2022
 
 # Variables
 
@@ -28,11 +28,11 @@ VSCODE_LOG_NATIVE = false
 # automatic
 @F = $(notdir $@)
 # makefile
-CURDIR := /Users/malanone/SAE2.02/sae2.02-1
+CURDIR := /Users/malanone/SAE2.02/sae2.02-2
 # makefile
 SHELL = /bin/sh
 # environment
-VSCODE_NLS_CONFIG = {"locale":"fr","availableLanguages":{"*":"fr"},"_languagePackId":"7f0881eff5702ae7f1e58d234d47750c.fr","_translationsConfigFile":"/Users/malanone/Library/Application Support/Code/clp/7f0881eff5702ae7f1e58d234d47750c.fr/tcf.json","_cacheRoot":"/Users/malanone/Library/Application Support/Code/clp/7f0881eff5702ae7f1e58d234d47750c.fr","_resolvedLanguagePackCoreLocation":"/Users/malanone/Library/Application Support/Code/clp/7f0881eff5702ae7f1e58d234d47750c.fr/c722ca6c7eed3d7987c0d5c3df5c45f6b15e77d1","_corruptedFile":"/Users/malanone/Library/Application Support/Code/clp/7f0881eff5702ae7f1e58d234d47750c.fr/corrupted.info","_languagePackSupport":true}
+VSCODE_NLS_CONFIG = {"locale":"fr","availableLanguages":{"*":"fr"},"_languagePackId":"46c2c285347814a2356333ceb4dff7cd.fr","_translationsConfigFile":"/Users/malanone/Library/Application Support/Code/clp/46c2c285347814a2356333ceb4dff7cd.fr/tcf.json","_cacheRoot":"/Users/malanone/Library/Application Support/Code/clp/46c2c285347814a2356333ceb4dff7cd.fr","_resolvedLanguagePackCoreLocation":"/Users/malanone/Library/Application Support/Code/clp/46c2c285347814a2356333ceb4dff7cd.fr/e18005f0f1b33c29e81d732535d8c0e47cafb0b5","_corruptedFile":"/Users/malanone/Library/Application Support/Code/clp/46c2c285347814a2356333ceb4dff7cd.fr/corrupted.info","_languagePackSupport":true}
 # environment
 _ = /usr/bin/make
 # makefile (from `Makefile', line 5)
@@ -46,7 +46,7 @@ __CFBundleIdentifier = com.microsoft.VSCode
 # environment
 INFOPATH = /opt/homebrew/share/info:
 # environment
-VSCODE_IPC_HOOK_EXTHOST = /var/folders/2c/84f5fdhx7xb36m9x0bh2cd9c0000gn/T/vscode-ipc-9967a400-0bc4-4c4a-8b81-f12f2d798b01.sock
+VSCODE_IPC_HOOK_EXTHOST = /var/folders/2c/84f5fdhx7xb36m9x0bh2cd9c0000gn/T/vscode-ipc-b861592a-2ed3-48f1-a40c-83e271989f05.sock
 # environment
 VSCODE_CWD = /
 # environment
@@ -64,7 +64,7 @@ SSH_AUTH_SOCK = /private/tmp/com.apple.launchd.BVHmcK3OBC/Listeners
 # environment
 VSCODE_PIPE_LOGGING = true
 # environment
-PWD = /Users/malanone/SAE2.02/sae2.02-1
+PWD = /Users/malanone/SAE2.02/sae2.02-2
 # environment
 HOMEBREW_CELLAR = /opt/homebrew/Cellar
 # environment
@@ -78,7 +78,7 @@ HOME = /Users/malanone
 # default
 MAKEFILEPATH = $(shell /usr/bin/xcode-select -print-path 2>/dev/null || echo /Developer)/Makefiles
 # environment
-VSCODE_CODE_CACHE_PATH = /Users/malanone/Library/Application Support/Code/CachedData/c722ca6c7eed3d7987c0d5c3df5c45f6b15e77d1
+VSCODE_CODE_CACHE_PATH = /Users/malanone/Library/Application Support/Code/CachedData/e18005f0f1b33c29e81d732535d8c0e47cafb0b5
 # environment
 LOGNAME = malanone
 # environment
@@ -114,7 +114,7 @@ TMPDIR = /var/folders/2c/84f5fdhx7xb36m9x0bh2cd9c0000gn/T/
 # automatic
 *F = $(notdir $*)
 # environment
-VSCODE_IPC_HOOK = /Users/malanone/Library/Application Support/Code/1.65.2-main.sock
+VSCODE_IPC_HOOK = /Users/malanone/Library/Application Support/Code/1.66.0-main.sock
 # makefile
 MAKEFLAGS = Rrqp
 # environment
@@ -124,7 +124,7 @@ MFLAGS = -Rrqp
 # automatic
 *D = $(patsubst %/,%,$(dir $*))
 # environment
-XPC_SERVICE_NAME = application.com.microsoft.VSCode.12793600.12793606
+XPC_SERVICE_NAME = application.com.microsoft.VSCode.14373281.14373287
 # environment
 HOMEBREW_PREFIX = /opt/homebrew
 # automatic
@@ -154,7 +154,7 @@ MAKELEVEL := 0
 # environment
 LANG = C
 # environment
-VSCODE_PID = 39657
+VSCODE_PID = 70352
 # variable set hash-table stats:
 # Load=72/1024=7%, Rehash=0, Collisions=3/98=3%
 
@@ -164,10 +164,10 @@ VSCODE_PID = 39657
 
 # Directories
 
-# . (device 16777232, inode 14352802): 12 files, no impossibilities.
+# . (device 16777232, inode 14483492): 13 files, no impossibilities.
-# src (device 16777232, inode 14352887): 8 files, no impossibilities.
+# src (device 16777232, inode 14483585): 12 files, no impossibilities.
 
-# 20 files, no impossibilities in 2 directories.
+# 25 files, no impossibilities in 2 directories.
 
 # Implicit Rules
 
@@ -180,6 +180,12 @@ obj/%.o: src/%.cpp
 
 # Files
 
+# Not a target:
+obj/Contact3.o:
+#  Implicit rule search has not been done.
+#  Modification time never checked.
+#  File has not been updated.
+
 # Not a target:
 all:
 #  Command-line target.
@@ -210,13 +216,13 @@ obj/main.o:
 # Not a target:
 Makefile:
 #  Implicit rule search has been done.
-#  Last modified 2022-03-31 13:46:10
+#  Last modified 2022-04-01 22:38:14
 #  File has been updated.
 #  Successfully updated.
 # variable set hash-table stats:
 # Load=0/32=0%, Rehash=0, Collisions=0/0=0%
 
-bin/exe: obj/Contact.o obj/Personne.o obj/main.o
+bin/exe: obj/Contact.o obj/Contact3.o obj/Personne.o obj/Personne3.o obj/main.o
 #  Implicit rule search has not been done.
 #  Modification time never checked.
 #  File has not been updated.
@@ -230,6 +236,12 @@ bin/exe: obj/Contact.o obj/Personne.o obj/main.o
 #  Modification time never checked.
 #  File has not been updated.
 
+# Not a target:
+obj/Personne3.o:
+#  Implicit rule search has not been done.
+#  Modification time never checked.
+#  File has not been updated.
+
 clean:
 #  Implicit rule search has not been done.
 #  Modification time never checked.
@@ -245,7 +257,7 @@ obj/Personne.o:
 #  File has not been updated.
 
 # files hash-table stats:
-# Load=9/1024=1%, Rehash=0, Collisions=0/24=0%
+# Load=11/1024=1%, Rehash=0, Collisions=0/28=0%
 # VPATH Search Paths
 
 # No `vpath' search paths.
@@ -257,7 +269,7 @@ obj/Personne.o:
 # strcache size: total = 4096 / max = 4096 / min = 4096 / avg = 4096
 # strcache free: total = 4087 / max = 4087 / min = 4087 / avg = 4087
 
-# Finished Make data base on Thu Mar 31 13:46:13 2022
+# Finished Make data base on Fri Apr  1 22:38:18 2022
 
  
 make: *** No rule to make target `all'.  Stop.

src/Contact.cpp

@@ -1,3 +1,11 @@
+/**
+ * \file Contact.cpp
+ * \brief On implémente les différentes fonctions et méthodes définies dans les fichiers d'en-tête. La compilation de ce fichiers .cpp nous permettra d'utiliser dans le main ces fonctions
+Il inclut les définitions à partir d'un en-tête.
+ * \author Matis MAZINGUE Joan PIERRON Maxence LANONE Hugo PRADIER G7
+ * \date 31 Mars 2022
+ */
+
 #include <iostream>
 #include "Contact.hpp"
 
@@ -5,14 +13,31 @@
 using namespace std;
 using namespace reseau;
 
+/**
+ * @brief Construct a new Contact:: Contact object
+ * 
+ * @param Proprietaire 
+ */
 Contact::Contact(const Personne& Proprietaire): Proprietaire{Proprietaire} {
 	// cout << "Contact créé " << Proprietaire << "\n";
 }
 
+/**
+ * @brief 
+ * 
+ * @return const Personne& 
+ */
 const Personne& Contact::getProprio() const {
 	return this->Proprietaire;
 }
 
+/**
+ * @brief 
+ * 
+ * @param unContact 
+ * @return true 
+ * @return false 
+ */
 bool Contact::ajouterContact(const Personne& unContact){
 	if(lesContacts.empty()){
 		// cout << "Contact ajouté " << unContact <<"\n";
@@ -36,6 +61,13 @@ bool Contact::ajouterContact(const Personne& unContact){
 	}
 }
 
+/**
+ * @brief 
+ * 
+ * @param unContact 
+ * @return true 
+ * @return false 
+ */
 bool Contact::rechercher(const Personne& unContact){
 	list<const Personne*>::iterator it = find(lesContacts.begin(), lesContacts.end(),&unContact);
 	if(it != lesContacts.end())
@@ -51,6 +83,13 @@ bool Contact::rechercher(const Personne& unContact){
 	lesContacts.sort();
 }
 
+/**
+ * @brief 
+ * 
+ * @param unContact 
+ * @return true 
+ * @return false 
+ */
 bool Contact::supprimerContact(const Personne& unContact){
 	list<const Personne*>::iterator it = find(lesContacts.begin(), lesContacts.end(), &unContact);
 	if(it!=lesContacts.end()){
@@ -64,6 +103,10 @@ bool Contact::supprimerContact(const Personne& unContact){
 	}
 }
 
+/**
+ * @brief 
+ * 
+ */
 void Contact::afficherContactDirect() {
 	cout << " Les contacts directs de " << this->Proprietaire << " sont : ";
 	for(list<const Personne*>::const_iterator it = lesContacts.cbegin(); it != lesContacts.cend(); ++it){
@@ -77,6 +120,12 @@ void Contact::afficherContactDirect() {
 	cout << "\n";
 }
 
+/**
+ * @brief 
+ * 
+ * @param Contacts 
+ * @param set 
+ */
 void Contact::Recursive(list<Contact*> Contacts, set<const Personne*>* set) {
 	for(const Personne* Personne : lesContacts) {
 		if(set->find(Personne)!=set->end())
@@ -90,6 +139,11 @@ void Contact::Recursive(list<Contact*> Contacts, set<const Personne*>* set) {
 	}
 }
 
+/**
+ * @brief 
+ * 
+ * @param Contacts 
+ */
 void Contact::afficherContactIndirect(list<Contact*> Contacts) {
 	cout << " Les contacts directs et indirects de " << this->Proprietaire << " sont : ";
 	set<const Personne*> lesPersonnes{};
@@ -101,10 +155,25 @@ void Contact::afficherContactIndirect(list<Contact*> Contacts) {
 	cout << "\n"; 
 }
 
+/**
+ * @brief 
+ * 
+ * @param os 
+ * @param p 
+ * @return ostream& 
+ */
 ostream& reseau::operator<<(ostream& os, Personne p){
 	return os << p.getPrenom();
 }
 
+/**
+ * @brief 
+ * 
+ * @param p1 
+ * @param p2 
+ * @return true 
+ * @return false 
+ */
 bool reseau::operator==(reseau::Personne p1, reseau::Personne p2){
 	if(p1.getPrenom()==p2.getPrenom())
 		return true;

src/Contact.hpp

@@ -1,3 +1,10 @@
+/**
+ * \file Contact.hpp
+ * \brief Contient des variables, des constantes et divers types de données relatifs à notre classe Contact. Cela nous permet de stocker des composants de code.
+ * \author Matis MAZINGUE Joan PIERRON Maxence LANONE Hugo PRADIER G7
+ * \date 31 Mars 2022
+ */
+
 #ifndef CONTACT_hpp
 #define CONTACT_hpp
 #include"Personne.hpp"
@@ -5,6 +12,7 @@
 #include<iostream>
 #include<set>
 
+
 namespace reseau{
 	class Contact {
 		reseau::Personne Proprietaire;

src/Contact3.cpp

@@ -1,29 +1,73 @@
+/**
+ * \file Contact3.cpp
+ * \brief On implémente les différentes fonctions et méthodes définies dans les fichiers d'en-tête. La compilation de ce fichiers .cpp nous permettra d'utiliser dans le main ces fonctions
+Il inclut les définitions à partir d'un en-tête.
+ * \author Matis MAZINGUE Joan PIERRON Maxence LANONE Hugo PRADIER G7
+ * \date 31 Mars 2022
+ */
+
 #include <iostream>
 #include "Contact3.hpp"
 
 using namespace std;
 using namespace reseau2;
 
+/**
+ * @brief 
+ * 
+ * @return list<const Personne*> 
+ */
 list<const Personne*> ListeContact::getValue() {
 			return personnes;
 }
 
+/**
+ * @brief 
+ * 
+ * @param p 
+ */
 void ListeContact::ajtContact(const Personne& p) {
 			personnes.push_back(&p);
 }
 
+/**
+ * @brief Construct a new Liaison Personne:: Liaison Personne object
+ * 
+ * @param envoyeur 
+ * @param destinataire 
+ */
 LiaisonPersonne::LiaisonPersonne(const Personne *envoyeur, const Personne *destinataire) : envoyeur(envoyeur), destinataire(destinataire) {}
 
+/**
+ * @brief 
+ * 
+ * @return const Personne* 
+ */
 const Personne* LiaisonPersonne::getEnvoyeur() const {
 	return envoyeur;
 }
 
+/**
+ * @brief 
+ * 
+ * @return const Personne* 
+ */
 const Personne* LiaisonPersonne::getDestinataire() const {
 	return destinataire;
 }
 
+/**
+ * @brief Construct a new Conteneur:: Conteneur object
+ * 
+ * @param pers 
+ */
 Conteneur::Conteneur(Personne *pers) : pers(pers) {}
 
+/**
+ * @brief 
+ * 
+ * @return std::list<const Personne*> 
+ */
 std::list<const Personne*> Conteneur::getValue() {
 	cout << "test";
 	std::list<const Personne*> liste;
@@ -33,6 +77,11 @@ std::list<const Personne*> Conteneur::getValue() {
 	return liste;
 }
 
+/**
+ * @brief 
+ * 
+ * @param p 
+ */
 void Conteneur::ajtContact(const Personne& p) {
 	personnes.emplace_back(pers, &p);
 }

src/Contact3.hpp

@@ -1,3 +1,10 @@
+/**
+ * \file Contact3.hpp
+ * \brief Contient des variables, des constantes et divers types de données relatifs à notre classe Contact. Cela nous permet de stocker des composants de code.
+ * \author Matis MAZINGUE Joan PIERRON Maxence LANONE Hugo PRADIER G7
+ * \date 31 Mars 2022
+ */
+
 #ifndef CONTACT3_hpp
 #define CONTACT3_hpp
 #include<list>

src/Personne.cpp

@@ -1,9 +1,22 @@
+/**
+ * \file Personne.cpp
+ * \brief On implémente les différentes fonctions et méthodes définies dans les fichiers d'en-tête. La compilation de ce fichiers .cpp nous permettra d'utiliser dans le main ces fonctions
+Il inclut les définitions à partir d'un en-tête.
+ * \author Matis MAZINGUE Joan PIERRON Maxence LANONE Hugo PRADIER G7
+ * \date 31 Mars 2022
+ */
+
 #include <iostream>
 #include "Personne.hpp"
 
 using namespace std;
 using namespace reseau;
 
+/**
+ * @brief Construct a new Personne:: Personne object
+ * 
+ * @param prenom 
+ */
 Personne::Personne(const std::string& prenom):prenom{prenom}{
 	// cout << "Personne créée " << prenom <<"\n";
 }
@@ -12,6 +25,11 @@ Personne::Personne(const std::string& prenom):prenom{prenom}{
 // 	cout << "Personne créée \n";
 // }
 
+/**
+ * @brief 
+ * 
+ * @return const string& 
+ */
 const string& Personne::getPrenom() const{
 	return this->prenom;
 }

src/Personne.hpp

@@ -1,3 +1,10 @@
+/**
+ * \file Personne.hpp
+ * \brief Contient des variables, des constantes et divers types de données relatifs à notre classe Personne. Cela nous permet de stocker des composants de code.
+ * \author Matis MAZINGUE Joan PIERRON Maxence LANONE Hugo PRADIER G7
+ * \date 31 Mars 2022
+ */
+
 #ifndef PERSONNE_hpp
 #define PERSONNE_hpp
 

src/Personne3.cpp

@@ -1,3 +1,11 @@
+/**
+ * \file Personne3.cpp
+ * \brief On implémente les différentes fonctions et méthodes définies dans les fichiers d'en-tête. La compilation de ce fichiers .cpp nous permettra d'utiliser dans le main ces fonctions
+Il inclut les définitions à partir d'un en-tête.
+ * \author Matis MAZINGUE Joan PIERRON Maxence LANONE Hugo PRADIER G7
+ * \date 31 Mars 2022
+ */
+
 #include "Personne3.hpp"
 #include "Contact3.hpp"
 
@@ -10,6 +18,11 @@ using namespace reseau2;
 
 // #define TECHNIQUE_A
 
+/**
+ * @brief Construct a new Personne:: Personne object
+ * 
+ * @param prenom 
+ */
 Personne::Personne(const std::string& prenom):prenom{prenom}{
 // #ifdef TECHNIQUE_A
 	contacts = new ListeContact{};
@@ -18,18 +31,39 @@ Personne::Personne(const std::string& prenom):prenom{prenom}{
 // #endif
 }
 
+/**
+ * @brief 
+ * 
+ * @return const string& 
+ */
 const string& Personne::getPrenom() const{
 	return this->prenom;
 }
 
+/**
+ * @brief 
+ * 
+ * @param personne 
+ */
 void reseau2::Personne::ajtContact(const Personne &personne) {
 	this->contacts->ajtContact(personne);
 }
 
+/**
+ * @brief Destroy the Personne:: Personne object
+ * 
+ */
 Personne::~Personne() {
 	delete contacts;
 }
 
+/**
+ * @brief 
+ * 
+ * @param p 
+ * @return true 
+ * @return false 
+ */
 bool Personne::peutCommuniquerA(const Personne &p) const {
 	unordered_set<const Personne*> visited;
 	queue<const Personne*> file;

src/Personne3.hpp

@@ -1,3 +1,10 @@
+/**
+ * \file Personne3.hpp
+ * \brief Contient des variables, des constantes et divers types de données relatifs à notre classe Personne. Cela nous permet de stocker des composants de code.
+ * \author Matis MAZINGUE Joan PIERRON Maxence LANONE Hugo PRADIER G7
+ * \date 31 Mars 2022
+ */
+
 #ifndef PERSONNE3_hpp
 #define PERSONNE3_hpp
 

src/main.cpp

@@ -1,3 +1,13 @@
+/**
+ * \file main.cpp
+ * \brief Fonctions permettant d'appeller des fonctions à l'aide d'un menu et de mettre en place un réseau
+ * \author Matis MAZINGUE Joan PIERRON Maxence LANONE Hugo PRADIER G7
+ * \date 31 Mars 2022
+ */
+
+
+
+
 #include <iostream>
 #include "Personne3.hpp"
 #include "Contact3.hpp"
@@ -9,6 +19,15 @@ using namespace std;
 using namespace reseau;
 
 int main() {
+	/** 
+	* \brief Main divisé en deux partie :
+	*
+	*	Partie 1 : qui qui permet la création de personnes appartent au futur réseau, la création à partir de ces personnes de propriétaire possédant *	une liste de contact, enfin on ajoute les contacts directs dans la liste de chaque propriétaire.
+	*
+	*	Partie 2 : menu qui permet à l'utilisateur d'appeller des fonctions pour réaliser les différentes techniques, il va pouvoir pour chacune *	afficher la liste de contact direct et indirect pour une ou toutes les personnes.
+	*
+	*	choix, choix2, choix3, persChoix : correspond à la demande de l'utlisateur qui entraîne l'appel de la fonction souhaitée
+	*/
 
 	/* 
 	On crée chaque personne qui seront dans notre réseau