Quick docs update with SEO for Visualization and adding a graph image to the readme. (#8)

Author: cpscotti

README.md

@@ -23,40 +23,43 @@ Applications are written as a combination of *Detectors* and *Topics*.
 
 *Topics* carry a particular signal/data-type:
 
-    struct SensorData : public DetectorGraph::TopicState
+    struct FooSensorData : public DetectorGraph::TopicState
     {
         int x;
     }
 
 *Detectors* encode a logical unit that describes the transformation from any number of *Topics* to any number of other *Topics*:
 
-    class ThresholdDetector : public DetectorGraph::Detector,
-        public DetectorGraph::SubscriberInterface<SensorData>,
-        public DetectorGraph::Publisher<ThresholdCrossing>
+    class BarThresholdDetector : public DetectorGraph::Detector,
+        public DetectorGraph::SubscriberInterface<FooSensorData>,
+        public DetectorGraph::Publisher<BazThresholdCrossing>
     {
-        ThresholdDetector(DetectorGraph::Graph* graph) : DetectorGraph::Detector(graph)
+        BarThresholdDetector(DetectorGraph::Graph* graph) : DetectorGraph::Detector(graph)
         {
-            Subscribe<SensorData>(this);
-            SetupPublishing<ThresholdCrossing>(this);
+            Subscribe<FooSensorData>(this);
+            SetupPublishing<BazThresholdCrossing>(this);
         }
-        virtual void Evaluate(const SensorData& data)
+        virtual void Evaluate(const FooSensorData& data)
         {
             if (data.x > 100)
             {
-                Publish(ThresholdCrossing(data.x));
+                Publish(BazThresholdCrossing(data.x));
             }
         }
     }
 
 *DetectorGraphs* are created by adding any number of *Detectors* to a *Graph*. All necessary *Topics* are created on demand and supplied via Dependency Injection.
 
     DetectorGraph::Graph graph;
-    ThresholdDetector detector(&graph);
+    BarThresholdDetector detector(&graph);
 
 *Detectors* and *Topics* are kept sorted in topological order.
 
 Graph *Evaluations* start after data is posted to a *Topic*. This causes all Detector's [`Evaluate()`](@ref DetectorGraph::SubscriberInterface::Evaluate) methods for that *Topic* to be called with the new piece of data which in turn may result in new data being posted to subsequent *Topics*. That may then trigger the `Evaluate()` of other *Detectors*. This process continues following the topological order until the end of the *Graph* is reached or until no more *Topics* with subscribers have new data.
 
+![digraph { FooSensorData -> ThresholdDetector -> ThresholdCrossing }](https://google.github.io/detectorgraph/readme_graph.png)
+*Graphs can be visualized with Graphviz*
+
 ## User Guide
 
 Below are a number of examples showcasing different aspects & usage patterns of the framework (these are in the `./examples/` folder).

doxygen/Doxyfile

@@ -765,7 +765,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = README.md makefile ./include ./src ./test-util ./examples ./platform_standalone ./doxygen
+INPUT                  = README.md makefile ./include ./src ./util ./test-util ./examples ./platform_standalone ./doxygen
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

doxygen/custom_examples.dox

@@ -72,4 +72,15 @@ Full Example: @ref ex-rg-state-persistence
 /**
 @page seo-state-persistence State Persistence
 @copydoc seo-resume-state
-*/
+*/
+
+/**
+@page seo-graphviz Graphviz Visualization
+Any DetectorGraph graphs can be visualized using Graphviz. For more see
+DetectorGraph::GraphAnalyzer and see this [visualization example](@ref ex-tvm-dga) .
+*/
+
+/**
+@page seo-visualization Visualization
+@copydoc seo-graphviz
+*/

examples/helloworld.cpp

@@ -59,7 +59,7 @@ using std::endl;
  * two.
  @snippetlineno helloworld.cpp Detector
  *
- * @section ex-hw-graphGraph
+ * @section ex-hw-graph Graph
  * The final plumbing is to add our newly created Detector to a
  * DetectorGraph::Graph.
  * Depending on the situation this can be done in different ways but here's the