Début du travail sur la doc Doxygen. Je ne pourrais aller plus loin que lorsqu'on aura toutes les fonctions

sources/lecture/lecture.c

@@ -1,3 +1,13 @@
+/**
+ * @file lecture.c
+ *
+ * Ce module implémente les fonctions du fichier lecture.h
+ *
+ * @version 1
+ * @author Module CSC3502 : Projet Informatique 1ère année TELECOM SudParis
+ * @date  Mai 2014
+*/
+
 #include "lecture.h"
 
 void lireTick (FMOD_SYSTEM* system, Motif* m, int tmp, FMOD_SOUND* sample[], FMOD_CHANNEL* chan[], int nbrPortees, int tempo) {    // On va lire les ticks (plus petite division temporelle de la playlist) de haut en bas

sources/lecture/lecture.h

@@ -1,7 +1,17 @@
+/**
+ * @file lecture.h
+ *
+ * Lecture de la mélodie
+ *
+ * @version 1
+ * @author Module CSC3502 : Projet Informatique 1ère année TELECOM SudParis
+ * @date  Mai 2014
+*/
+
+
 #ifndef _LECTURE_H
 #define _LECTURE_H
 
-
 #include "../melodie/melodie.h"
 // #include "../instruments/instrument.h"
 // #include <SDL2/SDL.h>
@@ -13,6 +23,12 @@
 
 #define NBR_MS
 
+/**
+	Permet la lecture d'un motif
+	@param[in] nbrChaines : nombre de chaines
+	@param[in] tempo : nombre de tempo
+	@param[in] melodie[] : motif lu
+*/
 void lecture(int nbrChaines, int tempo, Motif* melodie[]);
 
 #endif

sources/main.c

@@ -1,3 +1,23 @@
+/**
+ * \mainpage CSC3502 : PonyTracker
+ *
+ * Les fonctionnalités de cette application sont les suivantes :
+ * <ul>
+ * <li> fonction 1</li>
+ * <li> fonction 2</li>
+ * <li> fonction 3</li>
+ * <li> fonction 4</li>
+ * </ul>
+ *
+ * @file main.c
+ *
+ * Programme principal du Ponytracker
+ *
+ * @version 1.1
+ * @author Module CSC3502 : Projet Informatique 1ère année TELECOM SudParis
+ * @date  Mai 2014
+*/
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <gtk/gtk.h>

sources/motifs/motifs.c

@@ -1,3 +1,13 @@
+/**
+ * @file motifs.c
+ *
+ * Ce module implémente les fonctions du fichier motifs.h
+ *
+ * @version 1
+ * @author Module CSC3502 : Projet Informatique 1ère année TELECOM SudParis
+ * @date  Mai 2014
+*/
+
 #include <string.h>
 #include "motifs.h"
 

sources/motifs/motifs.h

@@ -1,3 +1,13 @@
+/**
+ * @file motifs.h
+ *
+ * Gestion des motifs
+ *
+ * @version 1
+ * @author Module CSC3502 : Projet Informatique 1ère année TELECOM SudParis
+ * @date  Mai 2014
+*/
+
 #ifndef _motif_h
 #define _motif_h
 
@@ -25,40 +35,132 @@ typedef struct _motif{
     struct _motif*  suivant;
 } Motif;
 
+/**
+	Permet d'obtenir le numéro d'un motif
+	@param[in] m : Mmtif dont on veut déterminer le numéro
+	@return Le numéro du motif
+*/
 int getIdMotif(Motif* m);
 
+/**
+	Permet d'ajouter un nouveau motif
+	@param[out] pliste : liste de motifs
+	@param[in] nbrTmp : nombre de temps que doit contenir le motif
+	@param[in] nbrPortees : nombre de portées que doit contenir le motif
+*/
 void ajouterMotif(Motif** pliste, int nbrTmp, int nbrPortees);
 
+/**
+	Permet de nommer un motif
+	@param[out] m : motif que l'on veut nommer
+	@param[in] nom : nom que l'on donne au motif
+	*/
 void definirNomMotif(Motif* m, char* nom);
 
 // void definirNbrTmp(Motif* m, int nbrTmp);
 // C'est chiant de changer le nomre de temps en cours de route,
 // donc on le fera après le proto.
 
+/**
+	Permet de supprimer un motif
+	@param[out] cellule : adresse de l'élément de la liste
+	@param[in] nbrPortees : nombre de portées que l'on supprime
+*/
 void supprimerMotif(Motif** cellule, int nbrPortees); // cellule correspond à l'adresse de l'élément de la liste (avec &)
 
+/**
+	Permet de définir une note
+	param[out] m : motif dans lequel on ajoute la note
+	param[in] portee : portée du motif dans laquelle on ajoute la note
+	param[in] tmp : temps du motif dans lequel on ajoute la note
+	param[in] note : note que l'on ajoute
+*/
 void definirNote(Motif* m, int portee, int tmp, int note);
 
+/**
+	Permet de définir une octave
+	param[out] m : motif dans lequel on ajoute l'octave
+	param[in] portee : portée du motif dans laquelle on ajoute l'octave
+	param[in] tmp : temps du motif dans lequel on ajoute l'octave
+	param[in] octave : octave que l'on ajoute à la note
+*/
 void definirOctave(Motif* m, int portee, int tmp, int octave);
 
+/**
+	Permet de définir l'instrument jouant une note
+	param[out] m : motif dans lequel on utilise cet instrument
+	param[in] portee : portée du motif dans laquelle on utilise cet instrument
+	param[in] tmp : temps du motif dans lequel on utilise cet instrument
+	param[in] instrument : instrument que l'on utilise
+*/
 void definirInstrument(Motif* m, int portee, int tmp, int intrument);
 
+/**
+	Permet de définir le volume d'une note
+	param[out] m : motif dans lequel on modifie le volume
+	param[in] portee : portée du motif dans laquelle on modifie le volume
+	param[in] tmp : temps du motif dans lequel on modifie le volume
+	param[in] volume : volume de la note
+*/
 void definirVolume(Motif* m, int portee, int tmp, int volume);
 
+/**
+	Permet de définir l'effet donné à une note
+	param[out] m : motif dans lequel on ajoute l'effet
+	param[in] portee : portée du motif dans laquelle on ajoute l'effet
+	param[in] tmp : temps du motif dans lequel on ajoute l'effet
+	param[in] effet : effet donné à la note
+*/
 void definirEffet(Motif* m, int portee, int tmp, int effet);
 
+/**
+	Permet de supprimer une note
+	param[out] m : motif dans lequel on supprime la note
+	param[in] portee : portée du motif dans laquelle on supprime la note
+	param[in] tmp : temps du motif dans lequel on supprime la note
+*/
 void supprimerNote(Motif* m, int portee, int tmp);
 
 // Maintenant, voici les getters (qui intéressent entre autres Majora)
 
+/**
+	Permet d'afficher une note
+	param[out] m : motif dans lequel on affiche la note
+	param[in] portee : portée du motif dans laquelle on affiche la note
+	param[in] tmp : temps du motif dans lequel on affiche la note
+*/
 int getNote(Motif* m, int portee, int tmp);
 
+/**
+	Permet d'afficher une octave
+	param[out] m : motif dans lequel on affiche l'octave
+	param[in] portee : portée du motif dans laquelle on affiche l'octave
+	param[in] tmp : temps du motif dans lequel on affiche l'octave
+*/
 int getOctave(Motif* m, int portee, int tmp);
 
+/**
+	Permet d'afficher un instrument utilisé
+	param[out] m : motif dans lequel on affiche l'instrument utilisé
+	param[in] portee : portée du motif dans laquelle on affiche l'instrument utilisé
+	param[in] tmp : temps du motif dans lequel on affiche l'instrument utilisé
+*/
 int getInstrument(Motif* m, int portee, int tmp);
 
+/**
+	Permet d'afficher une volume de note
+	param[out] m : motif dans lequel on affiche le volume de la note
+	param[in] portee : portée du motif dans laquelle on affiche le volume de la note
+	param[in] tmp : temps du motif dans lequel on affiche le volume de la note
+*/
 int getVolume(Motif* m, int portee, int tmp);
 
+/**
+	Permet d'afficher un effet donné
+	param[out] m : motif dans lequel on affiche l'effet donné
+	param[in] portee : portée du motif dans laquelle on affiche l'effet donné
+	param[in] tmp : temps du motif dans lequel on affiche l'effet donné
+*/
 int getEffet(Motif* m, int portee, int tmp);
 
 #endif