Changeset 3155


Ignore:
Timestamp:
Jan 3, 2014, 9:04:11 AM (8 years ago)
Author:
Peter
Message:

fixes #777. Make doxygen ignore internal stuff

Location:
branches/0.11-stable
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • branches/0.11-stable/README.developer

    r3132 r3155  
    106106'''Internal Interface'''
    107107
    108 Helper functions and classes that are not part of yat API should either be
    109 labeled with doxygen flag `\internal` or placed in sub-namespace `detail`.
     108Helper functions and classes that are not part of yat API should
     109either be labeled with doxygen flag `\internal` or placed in
     110sub-namespace `detail`. Functionality placed in namespace `detail`
     111should be excluded from doxygen input using a pattern like this:
     112
     113/// \cond IGNORE_DOXYGEN
     114namespace detail {
     115
     116<Some very detailed code here>
     117
     118}
     119/// \endcode
    110120
    111121= Build =
  • branches/0.11-stable/yat/utility/CommandLine.h

    r3114 r3155  
    209209
    210210    // use cond to make doxygen ignore this privat class
    211     /// \cond yat_ignore_this
     211    /// \cond IGNORE_DOXYGEN
    212212    struct OptionCompare
    213213    {
  • branches/0.11-stable/yat/utility/iterator_traits.h

    r2472 r3155  
    5555
    5656
     57/// \cond IGNORE_DOXYGEN
     58
    5759namespace detail {
    5860  /**
     
    8385
    8486} // namespace detail
     87
     88/// \endcond
    8589
    8690
     
    106110
    107111
     112/// \cond IGNORE_DOXYGEN
    108113namespace detail {
    109114  /**
     
    136141  };
    137142} // namespace detail
     143
     144/// \endcond
     145
    138146
    139147  /**
     
    165173  };
    166174
     175  /// \cond IGNORE_DOXYGEN
    167176  namespace detail {
    168177    /**
     
    174183    check_iterator_is_unweighted(utility::unweighted_iterator_tag x){}
    175184  } // namespace detail
     185
     186  /// \endcond
    176187
    177188  /**
     
    187198
    188199
     200/// \cond IGNORE_DOXYGEN
    189201namespace detail {
    190202
     
    380392} // namespace detail
    381393
     394/// \endcond
     395
     396
    382397  /**
    383398     The purpose of this class is to allow polymorphism between
  • branches/0.11-stable/yat/utility/utility.h

    r3066 r3155  
    274274  T log2(T x) { return std::log(x)/M_LN2; }
    275275
     276/// \cond IGNORE_DOXYGEN
     277
    276278// private namespace
    277279namespace detail {
    278280
    279281  /**
     282     \internal
     283
    280284     \brief convert s to t
    281285
     
    328332
    329333} // end of namespace detail
     334
     335/// \endcond
    330336
    331337
     
    478484  }
    479485
     486/// \cond IGNORE_DOXYGEN
    480487namespace detail {
    481488  template<typename T>
     
    518525} // of namespace detail
    519526
     527/// \endcond
     528
    520529}}} // of namespace utility, yat, and theplu
    521530
  • branches/0.11-stable/yat/utility/yat_assert.h

    r3114 r3155  
    3333namespace utility {
    3434
     35  /// \cond IGNORE_DOXYGEN
     36
    3537  /**
    3638     \internal
     
    4749  { }
    4850#endif
     51
     52  /// \endcond
    4953
    5054}}}
Note: See TracChangeset for help on using the changeset viewer.