X-Git-Url: https://git.saurik.com/bison.git/blobdiff_plain/df04a68ab54dcd8b899532c51ed0c8e1a0486296..7d6bad195977b0204fc8406cac57cf5a4f1c769b:/src/graphviz.h diff --git a/src/graphviz.h b/src/graphviz.h index 371b15c5..0254ef74 100644 --- a/src/graphviz.h +++ b/src/graphviz.h @@ -1,6 +1,6 @@ /* Output Graphviz specification of a state machine generated by Bison. - Copyright (C) 2006, 2010-2012 Free Software Foundation, Inc. + Copyright (C) 2006, 2010-2013 Free Software Foundation, Inc. This file is part of Bison, the GNU Compiler Compiler. @@ -22,40 +22,50 @@ #ifndef GRAPHVIZ_H_ # define GRAPHVIZ_H_ -#include "state.h" +# include "state.h" -/// Begin a Dot graph. -/// \param fout output stream. +/** Begin a Dot graph. + * + * \param fout output stream. + */ void start_graph (FILE *fout); -/// Output a Dot node. -/// \param id identifier of the node -/// \param label human readable label of the node (no Dot escaping needed). -/// \param fout output stream. +/** Output a Dot node. + * + * \param id identifier of the node + * \param label human readable label of the node (no Dot escaping needed). + * \param fout output stream. + */ void output_node (int id, char const *label, FILE *fout); -/// Output a Dot edge. -/// \param source id of the source node -/// \param destination id of the target node -/// \param label human readable label of the edge -/// (no Dot escaping needed). Can be 0. -/// \param style Dot style of the edge (e.g., "dotted" or "solid"). -/// \param fout output stream. +/** Output a Dot edge. + * \param source id of the source node + * \param destination id of the target node + * \param label human readable label of the edge + * (no Dot escaping needed). Can be 0. + * \param style Dot style of the edge (e.g., "dotted" or "solid"). + * \param fout output stream. + */ void output_edge (int source, int destination, char const *label, char const *style, FILE *fout); -/// Output a reduction. -/// \param s current state -/// \param reds the set of reductions -/// \param fout output stream. +/** Output a reduction. + * \param s current state + * \param reds the set of reductions + * \param fout output stream. + */ void output_red (state const *s, reductions const *reds, FILE *fout); -/// End a Dot graph. -/// \param fout output stream. +/** End a Dot graph. + * + * \param fout output stream. + */ void finish_graph (FILE *fout); -/// Escape a lookahead token. -/// \param name the token. +/** Escape a lookahead token. + * + * \param name the token. + */ char const *escape (char const *name); #endif /* ! GRAPHVIZ_H_ */