From 5063b4e94425f42c3aca25f3576d553d690c3770 Mon Sep 17 00:00:00 2001 From: Colin Clark Date: Thu, 23 Jun 2022 14:37:29 +0100 Subject: [PATCH] Include duplicates data layout diagram A duplicates data diagram in the doxygen-created documents --- doc/diagrams.c | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) diff --git a/doc/diagrams.c b/doc/diagrams.c index 2e5bf8a3..03ba92b4 100644 --- a/doc/diagrams.c +++ b/doc/diagrams.c @@ -409,3 +409,87 @@ * @file * @ref image_load_overview "Image Load Overview" */ + +/** + * @page diagrams Diagrams + * @section duplicates_data_layout Duplicates Data Layout + * + * #_DupeWindow #_DupeItem #_DupeMatch + * + * @startuml + * + * database DupeWindow [ + * DupeWindow->list + * ==== + * DupeItem + * ---- + * DupeItem + * ---- + * DupeItem + * ---- + * . + * . + * . + * ] + * note left + * One entry for each file + * dropped onto the dupes window + * end note + * + * card DupeItem [ + * DupeItem + * (parent) + * ==== + * . + * . + * . + * ---- + * fd + * ---- + * group (list) + * ---- + * group_rank + * ---- + * . + * . + * . + * ] + * note right + * group_rank: (sum of all child ranks) / n + * end note + * + * database group [ + * group (list) + * (children) + * ==== + * DupeMatch + * ---- + * DupeMatch + * ---- + * DupeMatch + * ---- + * . + * . + * . + * ] + * note left + * One entry for each file + * matching parent + * end note + * + * card DupeMatch [ + * DupeMatch + * ==== + * DupeItem + * ---- + * rank + * ---- + * ] + * + * DupeWindow -r-> DupeItem + * group -r-> DupeMatch + * DupeItem --> group + * @enduml + */ + + -- 2.20.1