1.1 --- a/src/core/object-names.h	Tue Jan 20 22:42:11 2009 -0800
     1.2 +++ b/src/core/object-names.h	Wed Jan 21 00:28:47 2009 -0800
     1.3 @@ -55,6 +55,8 @@
     1.4     *                name to be defined.
     1.5     * \param name The name of the object you want to associate.
     1.6     * \param obj A smart pointer to the object itself.
     1.7 +   *
     1.8 +   * \returns true if the association was successfully completed, false otherwise
     1.9     */
    1.10    static bool Add (Ptr<Object> context, std::string name, Ptr<Object> object);
    1.11  
    1.12 @@ -69,6 +71,8 @@
    1.13     *                under which you want this name to be defined.
    1.14     * \param name The name of the object you want to associate.
    1.15     * \param obj A smart pointer to the object itself.
    1.16 +   *
    1.17 +   * \returns true if the association was successfully completed, false otherwise
    1.18     */
    1.19    static bool Add (std::string context, std::string name, Ptr<Object> object);
    1.20  
    1.21 @@ -87,6 +91,8 @@
    1.22     *
    1.23     * \param object A spart pointer to an object for which you want to find
    1.24     *               its shortname.
    1.25 +   *
    1.26 +   * \returns a string containing the shortname of the object.
    1.27     */
    1.28    static std::string FindShortName (Ptr<Object> object);
    1.29  
    1.30 @@ -106,6 +112,8 @@
    1.31     *
    1.32     * \param object A spart pointer to an object for which you want to find
    1.33     *               its fullname.
    1.34 +   *
    1.35 +   * \returns a string containing the fullname of the object.
    1.36     */
    1.37    static std::string FindFullName (Ptr<Object> object);
    1.38  
    1.39 @@ -121,6 +129,9 @@
    1.40     *
    1.41     * \param name A string containing a fully qualified name space name 
    1.42     *             used to locate the object.
    1.43 +   *
    1.44 +   * \returns a smart pointer to the named object converted to the requested
    1.45 +   *          type.
    1.46     */
    1.47    template <typename T>
    1.48    static Ptr<T> FindObjectFromFullName (std::string name);
    1.49 @@ -138,6 +149,10 @@
    1.50     * \param name A string containing a fully qualified name space name 
    1.51     *             used to locate the object.
    1.52     *
    1.53 +   *
    1.54 +   * \returns a smart pointer to the named object converted to the requested
    1.55 +   *          type.
    1.56 +   *
    1.57     * @comment This method is identical to FindObjectFromFullName, but has a
    1.58     * short signature since it is a common use and we want it to be easy to 
    1.59     * type.
    1.60 @@ -167,6 +182,9 @@
    1.61     * \param context A spart pointer to an object under which you want to look 
    1.62     *                for the provided name.
    1.63     * \param name A string containing a shortname to look for.
    1.64 +   *
    1.65 +   * \returns a smart pointer to the named object converted to the requested
    1.66 +   *          type.
    1.67     */
    1.68    template <typename T>
    1.69    static Ptr<T> FindObjectFromShortName (Ptr<Object> context, std::string name);
    1.70 @@ -185,6 +203,8 @@
    1.71     * \brief Non-templated internal version of FindObjectFromLongName
    1.72     *
    1.73     * \param name A string containing a longname to look for.
    1.74 +   *
    1.75 +   * \returns a smart pointer to the named object.
    1.76     */
    1.77    static Ptr<Object> FindObjectFromFullNameInternal (std::string name);
    1.78  
    1.79 @@ -196,6 +216,8 @@
    1.80     * \param context A spart pointer to an object under which you want to look 
    1.81     *                for the provided name.
    1.82     * \param name A string containing a shortname to look for.
    1.83 +   *
    1.84 +   * \returns a smart pointer to the named object.
    1.85     */
    1.86    static Ptr<Object> FindObjectFromShortNameInternal (Ptr<Object> context, std::string name);
    1.87  };