Branch: Tag:

2002-07-13

2002-07-13 16:45:24 by Honza Petrous <hop@unibase.cz>

Autodoc: added @returns to all methods.

Rev: lib/modules/Protocols.pmod/LDAP.pmod/client.pike:1.40

2:      // LDAP client protocol implementation for Pike.   // - // $Id: client.pike,v 1.39 2002/07/12 14:39:08 manual Exp $ + // $Id: client.pike,v 1.40 2002/07/13 16:45:24 hop Exp $   //   // Honza Petrous, hop@unibase.cz   //
358:    void create(string|void url, object|void context)    {    -  info = ([ "code_revision" : ("$Revision: 1.39 $"/" ")[1] ]); +  info = ([ "code_revision" : ("$Revision: 1.40 $"/" ")[1] ]);       if(!url || !sizeof(url))    url = LDAP_DEFAULT_URL;
457:    //! Only @tt{2@} or @tt{3@} can be entered.    //!    //! @returns -  //! Returns @tt{1@} on uccess, @tt{0@} otherwise. +  //! Returns @tt{1@} on success, @tt{0@} otherwise.    //!    //! @note    //! Only simple authentication type is implemented. So be warned
541:    //! @param dn    //! The distinguished name of deleted entry.    //! +  //! @returns +  //! Returns @tt{1@} on success, @tt{0@} otherwise. +  //!    //! @note    //! The API change: the returning code was changed in Pike 7.3+    //! to follow his logic better.
597:    //! @param aval    //! The mapping of compared attributes and theirs values.    //! +  //! @returns +  //! Returns @tt{1@} on success, @tt{0@} otherwise. +  //!    //! @note    //! The API change: the returning code was changed in Pike 7.3+    //! to follow his logic better.
668:    //! The mapping of attributes and their values that make up the content    //! of the entry being added.    //! +  //! @returns +  //! Returns @tt{1@} on success, @tt{0@} otherwise. +  //!    //! @note    //! The API change: the returning code was changed in Pike 7.3+    //! to follow his logic better.
1164:    //! If present, this is the Distinguished Name of the entry    //! which becomes the immediate superior of the existing entry.    //! +  //! @returns +  //! Returns @tt{1@} on success, @tt{0@} otherwise. +  //!    //! @note    //! The API change: the returning code was changed in Pike 7.3+    //! to follow his logic better.