Changeset 966 for trunk/yat/utility


Ignore:
Timestamp:
Oct 11, 2007, 7:01:01 PM (14 years ago)
Author:
Peter
Message:

fixing some doxygen warnings

Location:
trunk/yat/utility
Files:
2 added
6 edited

Legend:

Unmodified
Added
Removed
  • trunk/yat/utility/Iterator.h

    r936 r966  
    157157       \brief Equality operator
    158158
    159        \return True if \a lhs and \rhs are pointing to same element
     159       \return True if \a lhs and \a rhs are pointing to same element
    160160     */
    161161    friend bool operator==(const Iterator<return_type, Container>& lhs,
     
    166166       \brief Non-equality operator
    167167
    168        \return False if \a lhs and \rhs are pointing to same element
     168       \return False if \a lhs and \a rhs are pointing to same element
    169169     */
    170170    friend bool operator!=(const Iterator<return_type, Container>& lhs,
  • trunk/yat/utility/TypeInfo.h

    r872 r966  
    4747       @brief Constructor
    4848    */
     49    // For convenience we allow implicit conversion from type_info to
     50    // TypeInfo.
    4951    TypeInfo(const std::type_info&);
    5052
    5153    /**
     54       \return stored type_info
    5255     */
    5356    const std::type_info& get(void) const;
  • trunk/yat/utility/iterator_traits.h

    r958 r966  
    3131namespace utility {
    3232
    33   /*
     33  /**
    3434    Struct to be used to make compile-time decision that Iterator is
    3535    unweighted, which is the default.
     
    3939  };
    4040   
    41   /*
     41  /**
    4242    Struct to be used to make compile-time decision that Iterator is
    4343    weighted. Some algorithms come in also in a weighted version in
     
    4949  };
    5050
    51   // All iterators should default to unweighted type ...
     51  /// All iterators should default to unweighted type ...
    5252  template <class T>
    5353  struct weighted_iterator_traits {
     
    5555  };
    5656
    57   // but specialized to return weighted type for some things
     57  /// but specialized to return weighted type for some things
    5858  //
    5959  // if you add a new weighted iterator, add a new specialization like
     
    6666
    6767
    68   /*
     68  /**
    6969    Metafunction that works on a pair weighted-unweighted types and
    7070    return weighted_type. The metafunction is specialized for
     
    7676  };
    7777
    78   /*
     78  /**
    7979    Specialization that sets type to be unweighted when both arguments
    8080    are unweighted
     
    8585  };
    8686
    87   /*
     87  /**
    8888    struct used to determine if a pair of iterators should be treated
    8989    as weighted. If both iterators are unweighted, type is set to
     
    9797  };
    9898
    99   /*
     99  /**
    100100    Same as weighted_iterator_traits2 but for 3 arguments.
    101101   */
     
    107107  };
    108108
    109   // check (at compile time) that iterator is unweighted.
     109  /// check (at compile time) that iterator is unweighted.
    110110  inline void check_iterator_is_unweighted(unweighted_type x){}
     111
     112  /**
     113     check (at compile time) that iterator \a iter is unweighted. This
     114     function is strictly not needed, but exists only for convenience.
     115   */
    111116  template <class Iter>
    112117  void check_iterator_is_unweighted(Iter iter)
     
    116121
    117122
    118   /*
     123  /**
    119124    Function to be used to make compile-time decision how to return
    120125    data from an iterator separating two cases: weighted and
     
    130135                                weighted_iterator_traits<Iter>::type()); }
    131136
     137  /**
     138     \return data for weighted iterator
     139   */
    132140  template <class Iter>
    133141  double iterator_traits_data(Iter i, weighted_type)
    134142  { return i.data(); }
    135143
     144  /**
     145     \return data for unweighted data
     146   */
    136147  template <class Iter>
    137148  double iterator_traits_data(Iter i, unweighted_type)
    138149  { return *i; }
    139150
    140   /*
     151  /**
    141152    Function to be used to make compile-time decision how to return
    142153    data from an iterator separating two cases: weighted and
     
    153164                                  weighted_iterator_traits<Iter>::type()); }
    154165
     166  /**
     167     \return weight for weighted iterator
     168   */
    155169  template <class Iter>
    156170  double iterator_traits_weight(Iter i, weighted_type)
    157171  { return i.weight(); }
    158172
     173  /**
     174     \return weight for unweighted iterator
     175   */
    159176  template <class Iter>
    160177  double iterator_traits_weight(Iter i, unweighted_type)
  • trunk/yat/utility/utility.h

    r917 r966  
    5050  /**
    5151     @return true if string \a s fulfills regular expression \verbatim
    52      ^\w* \endverbatim \a other \verbaim \w*$ \endverbatim (case
     52     ^\w* \endverbatim \a other \verbatim \w*$ \endverbatim (case
    5353     insensitive)
    5454  */
  • trunk/yat/utility/vector.h

    r899 r966  
    8888  public:
    8989
     90    /// \brief vector::iterator
    9091    typedef Iterator<double&, vector> iterator;
     92    /// \brief vector::const_iterator
    9193    typedef Iterator<const double, const vector> const_iterator;
    9294
     
    219221
    220222    /**
     223       \return mutable iterator to start of vector
    221224     */
    222225    iterator begin(void);
    223226
    224227    /**
     228       \return read-only iterator to start of vector
    225229     */
    226230    const_iterator begin(void) const;
     
    243247
    244248    /**
     249       \return mutable iterator to end of vector
    245250     */
    246251    iterator end(void);
    247252
    248253    /**
     254       \return read-only iterator to end of vector
    249255     */
    250256    const_iterator end(void) const;
  • trunk/yat/utility/yat_assert.h

    r936 r966  
    3030namespace utility {
    3131
     32  /**
     33     \brief yat_assert is similar to assert in std.
     34
     35     If YAT_DEBUG is enabled and \a assertion is false, and exception
     36     X is thrown using constructor X(\a msg ).
     37   */
    3238  template<class X> inline void yat_assert(bool assertion, std::string msg="")
    3339#ifdef YAT_DEBUG
Note: See TracChangeset for help on using the changeset viewer.