anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2024-11-09 18:31:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix some comments.

Browse Source 
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@27634 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Richard Heck 2008-11-19 03:58:20 +00:00
parent 656ffa1079
commit 900355d27f
1 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/BiblioInfo.h
View File

@ -32,17 +32,16 @@ class Buffer;
std::vector<CiteStyle> citeStyles(CiteEngine); std::vector<CiteStyle> citeStyles(CiteEngine);
/// \param latex_str a LaTeX command, "cite", "Citep*", etc /// \param latex_str a LaTeX command, "cite", "Citep*", etc
CitationStyle citationStyleFromString(std::string const & latex_str); CitationStyle citationStyleFromString(std::string const & latex_str);
/// the other way rounf /// the other way round
std::string citationStyleToString(CitationStyle const &); std::string citationStyleToString(CitationStyle const &);
/// Class to represent information about a BibTeX or /// Class to represent information about a BibTeX or
/// bibliography entry. /// bibliography entry.
/// The keys are BibTeX fields (e.g., author, title, etc),
/// and the values are the associated field values.
class BibTeXInfo { class BibTeXInfo {
public: public:
/// /// The keys are BibTeX fields (e.g., author, title, etc),
/// and the values are the associated field values.
typedef std::map<docstring, docstring>::const_iterator const_iterator; typedef std::map<docstring, docstring>::const_iterator const_iterator;
/// ///
BibTeXInfo() : is_bibtex_(true) {} BibTeXInfo() : is_bibtex_(true) {}
@ -59,11 +58,11 @@ public:
docstring const & getValueForField(std::string const & field) const; docstring const & getValueForField(std::string const & field) const;
/// ///
bool hasField(docstring const & field) const; bool hasField(docstring const & field) const;
/// return the short form of an authorlist /// \return the short form of an authorlist
docstring const getAbbreviatedAuthor() const; docstring const getAbbreviatedAuthor() const;
/// ///
docstring const getYear() const; docstring const getYear() const;
/// Returns formatted BibTeX data suitable for framing. /// \return formatted BibTeX data suitable for framing.
docstring const getInfo() const; docstring const getInfo() const;
/// ///
int count(docstring const & f) const { return bimap_.count(f); } int count(docstring const & f) const { return bimap_.count(f); }
@ -100,20 +99,19 @@ class BiblioInfo {
public: public:
/// bibliography key --> data for that key /// bibliography key --> data for that key
typedef std::map<docstring, BibTeXInfo>::const_iterator const_iterator; typedef std::map<docstring, BibTeXInfo>::const_iterator const_iterator;
/// Returns a sorted vector of bibliography keys /// \return a sorted vector of bibliography keys
std::vector<docstring> const getKeys() const; std::vector<docstring> const getKeys() const;
/// Returns a sorted vector of present BibTeX fields /// \return a sorted vector of present BibTeX fields
std::vector<docstring> const getFields() const; std::vector<docstring> const getFields() const;
/// Returns a sorted vector of BibTeX entry types in use /// \return a sorted vector of BibTeX entry types in use
std::vector<docstring> const getEntries() const; std::vector<docstring> const getEntries() const;
/// return the short form of an authorlist /// \return the short form of an authorlist
docstring const getAbbreviatedAuthor(docstring const & key) const; docstring const getAbbreviatedAuthor(docstring const & key) const;
/// return the year from the bibtex data record /// \return the year from the bibtex data record
docstring const getYear(docstring const & key) const; docstring const getYear(docstring const & key) const;
/// Returns formatted BibTeX data associated with a given key. /// \return formatted BibTeX data associated with a given key.
/// Empty if no info exists. /// Empty if no info exists.
docstring const getInfo(docstring const & key) const; docstring const getInfo(docstring const & key) const;
/** /**
* "Translates" the available Citation Styles into strings for a given key, * "Translates" the available Citation Styles into strings for a given key,
* either numerical or author-year depending upon the active engine. (See * either numerical or author-year depending upon the active engine. (See