- Some fixes in docmentation comments

- added missing #include statement
This commit is contained in:
Ralf Haferkamp 2002-03-06 22:57:39 +00:00
parent 4167eb0d56
commit dc6430e9a6
2 changed files with 13 additions and 12 deletions

View File

@ -1,5 +1,5 @@
/*
* Copyright 2000, OpenLDAP Foundation, All Rights Reserved.
* Copyright 2000-2002, OpenLDAP Foundation, All Rights Reserved.
* COPYING RESTRICTIONS APPLY, see COPYRIGHT file
*/
@ -33,16 +33,16 @@ class LDAPAttribute{
LDAPAttribute(const LDAPAttribute& attr);
/**
* Construct an Attribute with a single std::string value
* Construct an Attribute with a single string value
* @param name The attribute's name (type)
* @param value The std::string value of the attribute, if "" the
* @param value The string value of the attribute, if "" the
* attribute will have no values, for LDAPv3
* this values must be UTF-8 encoded
*/
LDAPAttribute(const std::string& name, const std::string& value="");
/**
* Construct an attribute with multiple std::string values
* Construct an attribute with multiple string values
* @param name The attribute's name (type)
* @param values A 0-terminated array of char*. Each char* specifies
* one value of the attribute (UTF-8 encoded)
@ -50,9 +50,9 @@ class LDAPAttribute{
LDAPAttribute(const char* name, char **values);
/**
* Construct an attribute with multiple std::string values
* Construct an attribute with multiple string values
* @param name The attribute's name (type)
* @param values A std::list of std::strings. Each element specifies
* @param values A list of strings. Each element specifies
* one value of the attribute (UTF-8 or binary
* encoded)
*/
@ -76,7 +76,7 @@ class LDAPAttribute{
~LDAPAttribute();
/**
* Add a single std::string value(bin/char) to the Attribute
* Add a single string value(bin/char) to the Attribute
* @param value Value that should be added, it is copied inside the
* object
*/
@ -95,7 +95,7 @@ class LDAPAttribute{
* Set the values of the attribute. If the object contains some values
* already, they are deleted
* @param values 0-terminated array of char*, each char*
* representing a std::string value to add to the entry
* representing a string value to add to the entry
*
* @return 0 no problem <BR>
* -1 failure (mem. allocation problem)
@ -116,8 +116,8 @@ class LDAPAttribute{
/**
* Set the values of the attribute. If the object does already contain
* some values, they will be deleted
* @param values A std::list of std::string-Objects. Each std::string is
* representing a std::string or binary value to add to
* @param values A list of string-Objects. Each string is
* representing a string or binary value to add to
* the entry
*/
void setValues(const StringList& values);
@ -134,7 +134,7 @@ class LDAPAttribute{
BerValue** getBerValues() const;
/**
* @return The values of the array as a std::list of std::strings
* @return The values of the array as a list of strings
*/
const StringList& getValues() const;

View File

@ -1,9 +1,10 @@
/*
* Copyright 2000, OpenLDAP Foundation, All Rights Reserved.
* Copyright 2000-2002 OpenLDAP Foundation, All Rights Reserved.
* COPYING RESTRICTIONS APPLY, see COPYRIGHT file
*/
#include "LDAPUrlList.h"
#include <assert.h>
#include "debug.h"
using namespace std;