You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 31, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README_fr_FR.md
+69-18
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Dgeni Packages
2
2
3
-
Ce dépôt contient une collection de packages de dgeni qui peuvent être utilisés par dgeni, le générateur
3
+
Ce dépôt contient une collection de packages de Dgeni qui peuvent être utilisés par Dgeni, le générateur
4
4
de documentation, pour créer une documentation à partir du code source.
5
5
6
6
@@ -14,6 +14,7 @@ Actuellement, il y a les packages suivants :
14
14
* ngdoc - La partie spécifique d'angular.js, avec la définition des balises, des processeurs et des templates.
15
15
Celui-ci charge les packages de jsdoc et nunjucks pour vous.
16
16
* examples - Processeurs pour supporter les exemples exécutables qui figurent sur les docs du site d'angular.js.
17
+
* dgeni - support pour la documentation des packages de Dgeni
17
18
18
19
## Le package `base`
19
20
@@ -22,11 +23,13 @@ Actuellement, il y a les packages suivants :
22
23
*`debugDumpProcessor` - extrait l'état courant du tableau docs dans un fichier (désactivé par défaut)
23
24
*`readFilesProcessor` - utilisé pour charger les documents depuis les fichiers. Ce processeur peut-être configuré pour utiliser
24
25
un ensemble de **lecteur de fichier**. Il y a des lecteurs de fichiers (file-readers) dans les packages `jsdoc` et `ngdoc`.
26
+
*`computePathsProcessor` - Détermine le `path` et le `outputPath` des documents en utilisant des templates ou des fonctions
27
+
d'aide, sur la base du `docType`.
25
28
*`renderDocsProcessor` - rendre les documents dans une propriété (`doc.renderedContent`) en utilisant
26
29
un `templateEngine` (moteur de template), qui doit être fourni séparément - voir le package `nunjucks`.
27
30
*`unescapeCommentsProcessor` - reformatte les marqueurs de commentaires pour ne pas casser le style des commentaires de jsdoc,
28
31
par exemple `*/`
29
-
*`writeFilesProcessor` - écrit les docs sur le disque
32
+
*`writeFilesProcessor` - écrit les docs (pour ceux ont un `outputPath`) sur le disque
30
33
31
34
### Services
32
35
@@ -79,8 +82,6 @@ pour rendre les documents en texte, tel que le HTML ou le JS, basé sur des temp
79
82
80
83
*`codeNameProcessor` - détermine le nom du document selon le code qui suit dans le document
81
84
dans le fichier source.
82
-
*`computePathProcessor` - détermine le chemin du document, utilisé pour écrire le fichier et pour naviguer
83
-
vers le document dans une application web.
84
85
*`parseTagsProcessor` - utilise un `tagParser` pour analyser les balises de jsdoc dans le contenu du document.
85
86
*`extractTagsProcessor` - utilise un `tagExtractor` pour extraire l'information depuis les balises analysées.
86
87
*`inlineTagsProcessor` - recherche les docs pour les balises [`inline`](http://usejsdoc.org/about-inline-tags.html) qui ont besoin d'avoir de l'injection de contenu
@@ -92,10 +93,10 @@ Le package `jsdoc` contient des définitions pour un certain nombre de balise st
92
93
`animations`, `constructor`, `class`, `classdesc`, `global`, `namespace`, `method`, `type` et
93
94
`kind`.
94
95
95
-
### Services
96
+
### Services (Transformations de balise)
96
97
97
-
Ce package fournit un certain nombre de services tagTransform qui sont utilisés dans les définitions de balise pour transformer
98
-
la valeur de la balise depuis le string dans le commentaire en quelque chose de plus significatif dans le doc.
98
+
Ce package fournit un certain nombre de services **Transform** qui sont utilisés dans les **définitions de balise** pour transformer
99
+
la valeur de la balise depuis le string du commentaire en quelque chose de plus significatif dans le doc.
99
100
100
101
*`extractNameTransform` - extrait un nom à partir d'une balise
101
102
*`extractTypeTransform` - extrait un type à partir d'une balise
@@ -108,6 +109,11 @@ la valeur de la balise depuis le string dans le commentaire en quelque chose de
108
109
**Ce package ne fournit pas de templates, ni un `templateEngine` pour rendre les templates (utilisez le
109
110
package `nunjucks` pour faire cela).**
110
111
112
+
### Définitions des balises
113
+
114
+
Ce package fournit une implémentation minimale des balises du projet JSDoc. Elles extraient le nom et
115
+
le type depuis la description de la balise trouvée, mais elles n'implémentent pas la totalité des fonctionnalités des balises JSDoc.
116
+
111
117
## Le package `ngdoc`
112
118
113
119
Le package `ngdoc` dépend des packages `jsdoc` et `nunjucks`.
@@ -144,25 +150,34 @@ Génère des documents pour chaque groupe de composants (par type) dans un modul
144
150
*`computeIdProcessor` -
145
151
Détermine la propriété id du doc sur la base des balises et d'autres méta-données
146
152
147
-
*`computePathProcessor` -
148
-
Détermine path et outputPath pour les docs qui n'ont pas déjà
149
-
150
153
*`filterNgdocsProcessor` -
151
154
Pour AngularJS, nous sommes seulement intéressés aux documents qui contiennent les balises @ngdoc. Ce processeur
152
155
supprime les docs qui ne contiennent pas cette balise.
153
156
154
157
*`collectPartialNames` -
155
-
Ajoute tous les docs à partialNameMap
158
+
Ajoute tous les docs à `partialNameMap`
159
+
160
+
161
+
### Définitions des balises
162
+
163
+
Ce package modifie et ajoute de nouvelles définitions de balises en plus de celles fournies par le package `jsdoc`.
164
+
165
+
166
+
### Définitions des balises Inline
167
+
168
+
*`link` - Traite les balises Inline de lien (sous la forme {@link une/uri Un Titre}), en les remplaçant par
169
+
des ancres HTML
156
170
157
171
158
172
### Services
159
173
160
-
*`getLinkInfo()`
161
-
*`getPartialNames()`
162
-
*`gettypeClass()`
163
-
*`moduleMap`
164
-
*`parseCodeName()`
165
-
*`patialNameMap`
174
+
*`getLinkInfo()` - Récupère les informations du lien depuis un document qui correspond à l'url donné
175
+
*`getPartialNames()` - Récupère une liste de tous les noms de code de partiel qui peuvent être utilisés à partir d'un ensemble
176
+
donné
177
+
*`gettypeClass()` - Récupère un string de classe CSS pour un string de type donné
178
+
*`moduleMap` - Une collection de modules correspondant au nom du module
179
+
*`parseCodeName()` - Découpe le nom de code en plusieurs morceaux
180
+
*`patialNameMap` - Une map de nom de partiel pour les docs
0 commit comments