From fd58f6ff2d3536af7902cea75c51901dd0d9e4a7 Mon Sep 17 00:00:00 2001 From: Pradheep Unnikrishnan <pradheep.unnikrishnan@etu.unistra.fr> Date: Tue, 19 Mar 2024 06:16:50 +0100 Subject: [PATCH] =?UTF-8?q?Ajout=20d'informations=20sur=20la=20cr=C3=A9ati?= =?UTF-8?q?on=20et=20le=20param=C3=A9trage=20sur=20la=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../code_modifie/sans_organisation/README.md | 14 +++++++++++--- .../code_modifie/sans_organisation/main.c | 9 +++++++++ 2 files changed, 20 insertions(+), 3 deletions(-) diff --git a/TP3_SUITE_TP2_CLONE/code_modifie/sans_organisation/README.md b/TP3_SUITE_TP2_CLONE/code_modifie/sans_organisation/README.md index 66b1e6f..c17f556 100644 --- a/TP3_SUITE_TP2_CLONE/code_modifie/sans_organisation/README.md +++ b/TP3_SUITE_TP2_CLONE/code_modifie/sans_organisation/README.md @@ -42,9 +42,17 @@ Cette option -g ajoute des informations de débogage au fichier exécutable gén * Premièrement, nous allons initialisé t.tab à NULL par convention, deuxièmement nous créons une gestion d'erreur pour connaitre si l'allocation mémoire de t.tab a été bien faite où dans le cas contraire nous serions informer par un message d'erreur puis pour terminer nous mettons en place la libération de mémoire par free(t.tab) ### Documentation *** - - - +#### Création et Paramétrage de la documentation +1. Création d'un fichier Doxyfile : doxygen -g +2. Configuration du fichier Doxyfile avec les paramètres ci-dessous : +* PROJECT_NAME = "TP3 - Outils de développement (Code sans_organisation)" +* PROJECT_NUMBER = 1.0 +* PROJECT_BRIEF = "Trier un tableau 1D dynamique" +* SOURCE_BROWSER = YES +* INLINE_SOURCES = YES +* INPUT = ../ <!-- ../ : chemin relatif de l'emplacement du fichier principales main.c ; makefile et le README.md --> +3. Commande permettant de créer deux repertoires 'html' et 'latex' : doxygen Doxyfile +4. Dans le répertoire 'html', nous pouvons visualiser la documentation via le fichier index.html diff --git a/TP3_SUITE_TP2_CLONE/code_modifie/sans_organisation/main.c b/TP3_SUITE_TP2_CLONE/code_modifie/sans_organisation/main.c index 3429421..bc3423e 100755 --- a/TP3_SUITE_TP2_CLONE/code_modifie/sans_organisation/main.c +++ b/TP3_SUITE_TP2_CLONE/code_modifie/sans_organisation/main.c @@ -1,3 +1,12 @@ +/** +*@file main.c +*Programme principale +*@author Pradheep U. +*@date 19/03/2024 +*@version 1.0 +*@copyright copyright 2024 Pradheep U. +*/ + #include <stdio.h> #include <stdlib.h> -- GitLab