X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBiblioInfo.h;h=efe4bff233948d61e5785959e87a0f2815bd320f;hb=c393abbe12c360eec07a3dcbb5929e6b7c0ad329;hp=3e7266fac85214d66b30d7affc1a93f92ff9e184;hpb=2a21c12eab4035b64d68a911a0e1f5008dfee1b3;p=lyx.git

diff --git a/src/BiblioInfo.h b/src/BiblioInfo.h
index 3e7266fac8..efe4bff233 100644
--- a/src/BiblioInfo.h
+++ b/src/BiblioInfo.h
@@ -173,6 +173,8 @@ public:
 	/// \return formatted BibTeX data associated with a given key.
 	/// Empty if no info exists. 
 	/// Note that this will retrieve data from the crossref as needed.
+	/// If \param richtext is true, then it will output any richtext tags
+	/// marked in the citation format and escape < and > elsewhere.
 	docstring const getInfo(docstring const & key, Buffer const & buf,
 			bool richtext = false) const;
 	/// Is this a reference from a bibtex database