LG

Générer le fichier de base

doxygen -g Doxyfile

Remplir obligatoirement les champs :

• PROJECT_NAME : nom du projet,
• CASE_SENSE_NAMES = NO

Pour une compatibilité avec CMake :

• INPUT = @PROJECT_SOURCE_DIR@/src
• OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doc
• STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@/src
• STRIP_FROM_INC_PATH = @PROJECT_SOURCE_DIR@/src
• EXAMPLE_PATH = @PROJECT_SOURCE_DIR@/tests si existant
• INCLUDE_PATH = @PROJECT_BINARY_DIR@/src @PROJECT_SOURCE_DIR@/src

Pour faire joli :

• TAB_SIZE = 2,
• OPTIMIZE_OUTPUT_FOR_C = NO : si C seulement, pas C++,
• SORT_MEMBER_DOCS = YES,
• SORT_BRIEF_DOCS = YES,
• SORT_MEMBERS_CTORS_1ST = YES,
• SORT_GROUP_NAMES = YES,
• SORT_BY_SCOPE_NAME = YES,
• USE_HTAGS = NO : nécessite global (http://www.gnu.org/software/global/global.html) mais doxygen plante,
• GENERATE_TREEVIEW = YES,
• USE_MATHJAX = YES,
• HAVE_DOT = YES,
• DOT_IMAGE_FORMAT = svg,
• INTERACTIVE_SVG = yes,
• DOT_GRAPH_MAX_NODES = 1000

Pour documentation la plus complète possible :

• ALWAYS_DETAILED_SEC = NO : pas nécessaire,
• INLINE_INHERITED_MEMB = YES : alourdi la documentation mais affiche dans la classe la documentation des membres des parents si héritage il y a,
• TOC_INCLUDE_HEADINGS = 5 : permet d'ajouter les titres des markdown sous forme de liste à puces dépliable dans le sommaire,
• BUILTIN_STL_SUPPORT = YES : complète les diagrammes avec les données de la STL. Ça surcharge beaucoup mais ça permet d'analyser les arguments template des STL.

Sans : Avec :

• EXTRACT_ALL = NO : l'idéal est YES mais à ce moment là, cela désactive les avertissements des membres non documentés,
• EXTRACT_PRIVATE = YES,
• EXTRACT_STATIC = YES,
• EXTRACT_ANON_NSPACES = YES,
• INTERNAL_DOCS = YES,
• SHOW_GROUPED_MEMB_INC = YES : ajoute l'include nécessaire pour chaque membre. A voir…,
• STRICT_PROTO_MATCHING = YES,
• WARN_NO_PARAMDOC = YES,
• FILE_PATTERNS = *.c *.cc *.h *.md : à adapter,
• INCLUDE_FILE_PATTERNS = *.h *.hpp
• RECURSIVE = YES,
• SOURCE_BROWSER = YES,
• REFERENCES_RELATION = YES,
• SKIP_FUNCTION_MACROS = NO,
• CLASS_GRAPH = YES,
• UML_LOOK = NO, si YES, ça fait des diagrammes très gros,
• CALL_GRAPH = YES,
• CALLER_GRAPH = YES,