-
Notifications
You must be signed in to change notification settings - Fork 0
/
DocxyConfigLite.conf
174 lines (117 loc) · 4.16 KB
/
DocxyConfigLite.conf
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
#
# Doc :
# Pour le fichier config : https://www.doxygen.nl/manual/config.html
# Pour le code : https://www.doxygen.nl/manual/commands.html
#
######################################
# Information sur le projet #
######################################
#Nom du Projet
PROJECT_NAME = "Shape's Editor"
#Version du Projet
PROJECT_NUMBER = 1.0
# Logo du Projet
PROJECT_LOGO =
./ressources/logodoc.
png
#Description rapide
PROJECT_BRIEF = "Retrouverez toute les information sur les classes composants Shape's Editor !"
#Fichier qui contient le text qui sera afficher dans la main page / index
#Il est possible de stylisé ce text, voire : https://www.doxygen.nl/manual/markdown.html
INPUT += ./README.
md USE_MDFILE_AS_MAINPAGE =
./README.
md
# Language de sortie
OUTPUT_LANGUAGE = French
######################################
# INPUT #
######################################
# Repertoire ou Fichier source du projet
INPUT +=
src RECURSIVE = YES
# On exclut la classe ezdraw++ car ce n'est pas à nous de la créer
EXCLUDE = src / ez - draw++
################################################
# Extraction des données #
################################################
# Extrait toute les données
EXTRACT_ALL = YES
# Extrait les fonctions locales soit les fonctions qui ne sont pas définies dans l'interface de la classe
EXTRACT_LOCAL_METHODS = YES
# Extrait la partie Private des classes
EXTRACT_PRIVATE = YES
# Extrait les méthodes privées et virtuelles
EXTRACT_PRIV_VIRTUAL = YES
# Extrait les statics
EXTRACT_STATIC = YES
# Ajout des libs stl
BUILTIN_STL_SUPPORT = YES
################################################
# OUTPUT and his SETTINGS #
################################################
# Indique le dossier de sortie de la documentation
OUTPUT_DIRECTORY =
./
docs
# Active la génération d'une documentation HTML
GENERATE_HTML = YES
# Désactive la génération de documentation Latex
GENERATE_LATEX = NO
# Active les caractères Unicodes
ALLOW_UNICODE_NAMES = YES
# Affiche les membres hérités comme de membres de la classe héritiaire
INLINE_INHERITED_MEMB = YES
# Active les présentations rapides intelligentes des fonctions
ABBREVIATE_BRIEF = YES
# Active de brèves descriptions des membres
BRIEF_MEMBER_DESC = YES
# Permet de donnez des petit descriptions
JAVADOC_AUTOBRIEF = YES
################################################
# SETTINGS of Doxygen #
################################################
# A paramètrer après une execution de Doxygen
# Paramètre la taille du cache de symboles
LOOKUP_CACHE_SIZE = 0
# Activer les avertissements de construction de la doc
WARNINGS = NO
################################################
# OUTPUT HTML #
################################################
# Ajout d'éléments sup dans la table de matière de l'aide HTML et de l'arborescence
TOC_EXPAND = YES
# Génère une table des matières binaires
BINARY_TOC = YES
# Permet d'avoir des sections html dynamiques
HTML_DYNAMIC_SECTIONS = YES
# Active l'arborescence dans l'index de gauche
GENERATE_TREEVIEW = YES
# Affiche les fichier inclu
SHOW_INCLUDE_FILES = YES
################################################
# SETTINGS of Graphs #
################################################
# Permet d'activer la génération de graphique
HAVE_DOT = NO
UML_LOOK = NO
CLASS_DIAGRAMS = YES
CLASS_GRAPH = YES
# Active un graphique d'appelants pour chaque fonctions membres et chaque fonctions globales
# Mais augmente le temps de génération
CALLER_GRAPH = NO
# Active un graphique d'appels pour chaque fonctions membres et chaque fonctions globales
# Mais augmente le temps de génération
CALL_GRAPH = NO
# Précission des types dans les diagrammes
DOT_UML_DETAILS = NO
# Les graph montreront les relations entre modèles et instances
TEMPLATE_RELATIONS = YES
# Spécifie le nombre max de noeuds
DOT_GRAPH_MAX_NODES = 10000
# Spécifie la taille max de char sur une ligne d'un graphe
DOT_WRAP_THRESHOLD = 1000
# Limite le nb d'éléments pour chaque noeuds
# 0 =
INFINI UML_LIMIT_NUM_FIELDS = 0
# Fin