From Chris Hanson, minor tweaks to docs on getDescriptions.

This commit is contained in:
Robert Osfield 2005-01-27 13:23:46 +00:00
parent 7e75997db0
commit d0f42c9231

View File

@ -198,19 +198,24 @@ class SG_EXPORT Node : public Object
/** A vector of std::string's which are used to describe the object.*/
typedef std::vector<std::string> DescriptionList;
/** Set the description list of the const node.*/
/** Set the description list of the node.*/
inline void setDescriptions(const DescriptionList& descriptions) { _descriptions=descriptions; }
/** Get the description list of the const node.*/
inline const DescriptionList& getDescriptions() const { return _descriptions; }
/** Get the description list of the const node.*/
/** Get the description list of the node.*/
inline DescriptionList& getDescriptions() { return _descriptions; }
/** Get the const description list of the const node.*/
inline const DescriptionList& getDescriptions() const { return _descriptions; }
/** Get a single const description of the const node.*/
inline const std::string& getDescription(unsigned int i) const { return _descriptions[i]; }
/** Get a single description of the node.*/
inline std::string& getDescription(unsigned int i) { return _descriptions[i]; }
/** Get the number of descriptions of the node.*/
inline unsigned int getNumDescriptions() const { return _descriptions.size(); }
/** Add a description string to the node.*/
void addDescription(const std::string& desc) { _descriptions.push_back(desc); }