Links to flamegraph renderers (#11)

Summary: Pull Request resolved: facebookexperimental/allocative#11

Reviewed By: ndmitchell

Differential Revision: D52630519

Pulled By: stepancheg

fbshipit-source-id: 0ce683c4cdcdf00dde904a2368aa2032e571b513

allocative/allocative/src/flamegraph.rs

@@ -23,6 +23,8 @@ use crate::visitor::VisitorImpl;
 use crate::Allocative;
 
 /// Node in flamegraph tree.
+///
+/// Can be written to flamegraph format with [`write`](FlameGraph::write).
 #[derive(Debug, Default, Clone)]
 pub struct FlameGraph {
     children: HashMap<Key, FlameGraph>,
@@ -82,7 +84,10 @@ impl FlameGraph {
         }
     }
 
-    /// Write flamegraph in format suitable for `flamegraph.pl` or `inferno`.
+    /// Write flamegraph in format suitable for [`flamegraph.pl`] or [inferno].
+    ///
+    /// [flamegraph.pl]: https://github.com/brendangregg/FlameGraph
+    /// [inferno]: https://github.com/jonhoo/inferno
     pub fn write(&self) -> String {
         let mut r = String::new();
         self.write_flame_graph_impl(&[], &mut r);