Référence du fichier Documents/Programmation/CodesArticles/Doxygen/main.c

---

Description détaillée

Programme de tests.

Auteur:

Franck.H

Version:

0.1

Date:

6 septembre 2007

Programme de test pour l'objet de gestion des chaînes de caractères Str_t.

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

Graphe des dépendances par inclusion de main.c:

Structures de données
struct	Str_t
	Objet chaîne de caractères. Plus de détails...
Énumérations
enum	Str_err_e { STR_NO_ERR, STR_EMPTY_ERR, NB_STR_ERR }
	Constantes d'erreurs. Plus de détails...
Fonctions
static Str_err_e	str_destroy (Str_t **self)
	Fonction de destruction de l'objet Str_t.
static Str_t *	str_new (const char *sz)
	Fonction de création d'une nouvelle instance d'un objet Str_t.
int	main (void)
	Entrée du programme.

---

Documentation du type de l'énumération

enum Str_err_e

Constantes d'erreurs.

Str_err_e est une série de constantes prédéfinie pour diverses futures fonctions de l'objet Str_t.

Valeurs énumérées:

STR_NO_ERR	Pas d'erreur.
STR_EMPTY_ERR	Erreur: Objet vide ou non initialisé.
NB_STR_ERR	Nombre total de constantes d'erreur.

---

Documentation des fonctions

static Str_err_e str_destroy

(

Str_t **

self

)

[static]

Fonction de destruction de l'objet Str_t.

Paramètres:

self

Adresse de ll'objet Str_t à détruire.

Renvoie:

STR_NO_ERR si aucune erreur, STR_EMPTY_ERR sinon.

static Str_t * str_new

(

const char *

sz

)

[static]

Fonction de création d'une nouvelle instance d'un objet Str_t.

Paramètres:

sz

Chaîne à stocker dans l'objet Str_t, ne peut être NULL.

Renvoie:

Instance nouvelle allouée d'un objet de type Str_t ou NULL.

int main

(

void

)

Entrée du programme.

Renvoie:

EXIT_SUCCESS - Arrêt normal du programme.

---