doc/gtkdoc.dot

   1 /* files and tools in gtk-doc workflow
   2  * dot -Tpng gtkdoc.dot -ogtkdoc.png
   3  */
   4
   5 digraph gtkdoc {
   6     /* graph attributes */
   7     /*rankdir=BT;*/
   8
   9     /* default node attributes */
  10     node [ shape=box];
  11
  12     /* tools nodes */
  13     gtkdoc_scan [label="gtkdoc-scan",shape="ellipse" ];
  14     gtkdoc_scangobj [label="gtkdoc-scangobj",shape="ellipse" ];
  15     gtkdoc_mkdb [label="gtkdoc-mkdb",shape="ellipse" ];
  16     gtkdoc_mkhtml [label="gtkdoc-mkhtml",shape="ellipse" ];
  17     gtkdoc_fixxref [label="gtkdoc-fixxref",shape="ellipse" ];
  18     gtkdoc_rebase [label="gtkdoc-rebase",shape="ellipse" ];
  19     gtkdoc_check [label="gtkdoc-check",shape="ellipse" ];
  20
  21     /* file nodes */
  22     headers [label="headers\nall headers under DOC_SOURCE_DIR\n+EXTRA_HFILES\n-IGNORE_HFILES"];
  23     sources [label="source code\nall files under DOC_SOURCE_DIR\nmatching SUFFIXES or *.{c,h}"];
  24     binary [label="compiled binary"];
  25     xml [label="docbook xml"];
  26     html [label="html"];
  27     module_decl_list [label="*-decl-list.txt" ];
  28     module_decl [label="*-decl.txt" ];
  29     module_types [label="*.types" ];
  30     module_sections [label="*-section.txt" ];
  31     module_signals [label="*.signals" ];
  32     module_hierarchy [label="*.hierarchy" ];
  33     module_interfaces [label="*.interfaces" ];
  34     module_prerequisites [label="*.prerequisites" ];
  35     module_args [label="*.args" ];
  36     module_undeclared [label="*-undeclared.txt" ];
  37     module_undocumented [label="*-undocumented.txt" ];
  38     module_unused [label="*-unused.txt" ];
  39
  40     /* tool invokation */
  41     gtkdoc_scan -> gtkdoc_scangobj -> gtkdoc_mkdb -> gtkdoc_mkhtml -> gtkdoc_fixxref -> gtkdoc_rebase -> gtkdoc_check [style="dotted"];
  42
  43     /* file usage */
  44     headers -> gtkdoc_scan;
  45     gtkdoc_scan -> module_sections [label="--rebuild-sections", style="dashed"];
  46     gtkdoc_scan -> module_types [label="--rebuild-types", style="dashed"];
  47     gtkdoc_scan -> module_decl;
  48     gtkdoc_scan -> module_decl_list;
  49
  50     binary -> gtkdoc_scangobj;
  51     module_types -> gtkdoc_scangobj;
  52     gtkdoc_scangobj -> module_signals;
  53     gtkdoc_scangobj -> module_hierarchy;
  54     gtkdoc_scangobj -> module_interfaces;
  55     gtkdoc_scangobj -> module_prerequisites;
  56     gtkdoc_scangobj -> module_args;
  57
  58     sources -> gtkdoc_mkdb;
  59     module_sections -> gtkdoc_mkdb;
  60     module_decl -> gtkdoc_mkdb;
  61     module_signals -> gtkdoc_mkdb;
  62     module_args -> gtkdoc_mkdb;
  63     module_hierarchy -> gtkdoc_mkdb;
  64     module_interfaces -> gtkdoc_mkdb;
  65     module_prerequisites -> gtkdoc_mkdb;
  66     gtkdoc_mkdb -> xml;
  67     gtkdoc_mkdb -> module_undeclared;
  68     gtkdoc_mkdb -> module_undocumented;
  69     gtkdoc_mkdb -> module_unused;
  70
  71     xml -> gtkdoc_mkhtml -> html;
  72
  73     html -> gtkdoc_fixxref -> html;
  74     html -> gtkdoc_rebase -> html;
  75
  76     module_undeclared -> gtkdoc_check;
  77     module_undocumented -> gtkdoc_check;
  78     module_unused -> gtkdoc_check;
  79 }
  80