Routines to retrieve HTML style information.

[lyx.git] / src / BiblioInfo.h

diff --git a/src/BiblioInfo.h b/src/BiblioInfo.h
index 9ebc866ec6df84d2dda218f4ccc39a2fba1a074c..e265045ba03bb843be5076f0ba91c994648f76e9 100644 (file)
--- a/src/BiblioInfo.h
+++ b/src/BiblioInfo.h
@@ -63,7 +63,7 @@ public:
        docstring const getXRef() const;
        /// \return formatted BibTeX data suitable for framing.
        /// \param pointer to crossref information
-       docstring const getInfo(BibTeXInfo const * const xref = 0) const;
+       docstring const & getInfo(BibTeXInfo const * const xref = 0) const;
        ///
        int count(docstring const & f) const { return bimap_.count(f); }
        ///
@@ -87,7 +87,9 @@ public:
        ///
        docstring entryType() const { return entry_type_; }
 private:
-       /// like operator[], except it will also check the given xref
+       /// like operator[], except, if the field is empty, it will attempt
+       /// to get the data from xref BibTeXInfo object, which would normally
+       /// be the one referenced in the crossref field.
        docstring getValueForKey(std::string const & key, 
                        BibTeXInfo const * const xref = 0) const;
        /// true if from BibTeX; false if from bibliography environment