From 24f915daf34982dbf25466984b82afd499429dab Mon Sep 17 00:00:00 2001 From: Varun Agrawal Date: Tue, 8 Dec 2020 09:42:18 -0500 Subject: [PATCH] better documentation --- gtsam/nonlinear/NonlinearFactorGraph.h | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/gtsam/nonlinear/NonlinearFactorGraph.h b/gtsam/nonlinear/NonlinearFactorGraph.h index f6b17edbc..989f493d3 100644 --- a/gtsam/nonlinear/NonlinearFactorGraph.h +++ b/gtsam/nonlinear/NonlinearFactorGraph.h @@ -111,12 +111,17 @@ namespace gtsam { /** Test equality */ bool equals(const NonlinearFactorGraph& other, double tol = 1e-9) const; - /** Write the graph in GraphViz format for visualization */ + /// Write the graph in GraphViz format for visualization void saveGraph(std::ostream& stm, const Values& values = Values(), const GraphvizFormatting& graphvizFormatting = GraphvizFormatting(), const KeyFormatter& keyFormatter = DefaultKeyFormatter) const; - - /** Write the graph in GraphViz format to file for visualization */ + + /** + * Write the graph in GraphViz format to file for visualization. + * + * This is a wrapper friendly version since wrapped languages don't have + * access to C++ streams. + */ void saveGraph(const std::string& file, const Values& values = Values(), const GraphvizFormatting& graphvizFormatting = GraphvizFormatting(), const KeyFormatter& keyFormatter = DefaultKeyFormatter) const;