Some docs for CandidateRepository

This commit is contained in:
Strahinja Val Markovic 2013-05-25 11:02:53 -07:00
parent 48bc4e224f
commit 0649d11bf4

View File

@ -33,6 +33,15 @@ struct CompletionData;
typedef boost::unordered_map< std::string, const Candidate * > typedef boost::unordered_map< std::string, const Candidate * >
CandidateHolder; CandidateHolder;
// This singleton stores already built Candidate objects for candidate strings
// that were already seen. If Candidates are requested for previously unseen
// strings, new Candidate objects are built.
//
// This is shared by the identifier completer and the clang completer so that
// work is not repeated.
//
// This class is thread-safe.
class CandidateRepository : boost::noncopyable { class CandidateRepository : boost::noncopyable {
public: public:
static CandidateRepository &Instance(); static CandidateRepository &Instance();