doc clarifications

This commit is contained in:
Guenter Obiltschnig 2016-10-07 11:05:36 +02:00
parent bae5b38df0
commit a5d801cc6e
2 changed files with 8 additions and 1 deletions

View File

@ -45,7 +45,11 @@ public:
/// If a NamePool is given, it becomes the Document's NamePool. /// If a NamePool is given, it becomes the Document's NamePool.
explicit DOMParser(unsigned long namePoolSize); explicit DOMParser(unsigned long namePoolSize);
/// Creates a new DOMParser, using the given name pool size. /// Creates a new DOMParser, using the given NamePool size.
///
/// The given namePoolSize should be a suitable prime number,
/// e.g. 251, 509, 1021 or 4093, depending on the expected
/// size of the document.
~DOMParser(); ~DOMParser();
/// Destroys the DOMParser. /// Destroys the DOMParser.

View File

@ -44,6 +44,9 @@ class XML_API NamePool
public: public:
NamePool(unsigned long size = POCO_XML_NAMEPOOL_DEFAULT_SIZE); NamePool(unsigned long size = POCO_XML_NAMEPOOL_DEFAULT_SIZE);
/// Creates a name pool with room for up to size strings. /// Creates a name pool with room for up to size strings.
///
/// The given size should be a suitable prime number,
/// e.g. 251, 509, 1021 or 4093.
const Name& insert(const XMLString& qname, const XMLString& namespaceURI, const XMLString& localName); const Name& insert(const XMLString& qname, const XMLString& namespaceURI, const XMLString& localName);
/// Returns a const reference to an Name for the given names. /// Returns a const reference to an Name for the given names.