]> granicus.if.org Git - graphviz/commitdiff
Clarify use of NULL argument in gvRender
authorerg <devnull@localhost>
Fri, 25 Aug 2006 22:29:20 +0000 (22:29 +0000)
committererg <devnull@localhost>
Fri, 25 Aug 2006 22:29:20 +0000 (22:29 +0000)
doc/libguide/basic.tex

index 252284d25ee7737569f482c018c353e6888a27bc..0c1ff6c40a5af228279912c04ca190aeb6120c99 100644 (file)
@@ -666,7 +666,10 @@ One simple way to do this is to use the position and drawing information as
 supplied by the {\tt dot} or {\tt xdot} format (see
 Sections~\ref{sect:dot} and \ref{sect:xdot}). To get this, the application
 can call the appropriate renderer, passing a NULL stream
-pointer to {\tt gvRender} as in Figure~\ref{fig:nop}.
+pointer to {\tt gvRender}\footnote{
+This convention only works, and only makes sense, with the {\tt dot} 
+and {\tt xdot} renderers. For other renders, a NULL stream will cause
+output to be written on {\tt stdout}.} as in Figure~\ref{fig:nop}.
 This will attach the information as string attributes. The application
 can then use {\tt agget} to read the attributes.