Что такое BOOST_LOG_DOXYGEN_PASS для Boost.Log?

Question

Там вы какой-то странный код в библиотеке Boost.Log, например, в BoostFileLogging.cpp, он говорит

#ifndef BOOST_LOG_DOXYGEN_PASS 

#define BOOST_LOG_INIT_LOG_TO_FILE_INTERNAL(z, n, data)\ 
    template< BOOST_PP_ENUM_PARAMS(n, typename T) >\ 
    inline shared_ptr< BOOST_LOG_FILE_SINK_FRONTEND_INTERNAL<sinks::text_file_backend> > add_file_log(BOOST_PP_ENUM_BINARY_PARAMS(n, T, const& arg))\ 
    {\ 
     return aux::add_file_log((\ 
      aux::wrap_file_name(arg0, typename parameter::aux::is_named_argument<T0>::type())\ 
      BOOST_PP_COMMA_IF(BOOST_PP_GREATER(n, 1))\ 
      BOOST_PP_ENUM_SHIFTED_PARAMS(n, arg)\ 
      ));\ 
    } 

BOOST_PP_REPEAT_FROM_TO(1, BOOST_LOG_MAX_PARAMETER_ARGS, BOOST_LOG_INIT_LOG_TO_FILE_INTERNAL, ~) 

#undef BOOST_LOG_INIT_LOG_TO_FILE_INTERNAL 

#else // BOOST_LOG_DOXYGEN_PASS 

/*! 
* The function initializes the logging library to write logs to a file stream. 
* 
* \param args A number of named arguments. The following parameters are supported: 
*    \li \c file_name The file name or its pattern. This parameter is mandatory. 
*    \li \c open_mode The mask that describes the open mode for the file. See <tt>std::ios_base::openmode</tt>. 
*    \li \c rotation_size The size of the file at which rotation should occur. See <tt>basic_text_file_backend</tt>. 
*    \li \c time_based_rotation The predicate for time-based file rotations. See <tt>basic_text_file_backend</tt>. 
*    \li \c auto_flush A boolean flag that shows whether the sink should automatically flush the file 
*        after each written record. 
*    \li \c target The target directory to store rotated files in. See <tt>sinks::file::make_collector</tt>. 
*    \li \c max_size The maximum total size of rotated files in the target directory. See <tt>sinks::file::make_collector</tt>. 
*    \li \c min_free_space Minimum free space in the target directory. See <tt>sinks::file::make_collector</tt>. 
*    \li \c scan_method The method of scanning the target directory for log files. See <tt>sinks::file::scan_method</tt>. 
*    \li \c filter Specifies a filter to install into the sink. May be a string that represents a filter, 
*       or a filter lambda expression. 
*    \li \c format Specifies a formatter to install into the sink. May be a string that represents a formatter, 
*       or a formatter lambda expression (either streaming or Boost.Format-like notation). 
* \return Pointer to the constructed sink. 
*/ 
template< typename... ArgsT > 
shared_ptr< BOOST_LOG_FILE_SINK_FRONTEND_INTERNAL<sinks::text_file_backend> > add_file_log(ArgsT... const& args); 

#endif // BOOST_LOG_DOXYGEN_PASS 

Что мотивация для этого макроса? следует ли включить его или отключить? это не документировано.

Answer 1

Doxygen - это программа, которая анализирует исходный код и создает документацию.

Целью этого является то, что Doxygen видит (и документы) что-то отличное от того, что видит настоящий компилятор.

В этом случае, Doxygen будет видеть VARIADIC шаблон, и поэтому документация HTML будет сказать что-то вроде этого:

add_file_log (ArgsT ... константные & арг);

параметры шаблона:

• шаблон < имяТипа ... ArgsT>

Возвращаемый тип:

shared_ptr< BOOST_LOG_FILE_SINK_FRONTEND_INTERNAL<sinks::text_file_backend> > 

Функция инициализирует библиотеку журналирования для записи журналов в поток файла ,

... и так далее

Но Повысьте Вход, видимо, работает на компиляторы, которые не поддерживают VARIADIC шаблонов, поэтому реальный компилятор не может видеть это. То, что компилятор видит кучу не-переменным числом шаблонов, то вдоль этих линий (хотя это не имеет значения для объяснения BOOST_LOG_DOXYGEN_PASS):

template<typename Arg1T> shared_ptr</*snip*/> add_file_log(Arg1T const& arg1); 
template<typename Arg1T, typename Arg2T> shared_ptr</*snip*/> add_file_log(Arg1T const& arg1, Arg2T const& arg2); 
template<typename Arg1T, typename Arg2T, typename Arg3T> shared_ptr</*snip*/> add_file_log(Arg1T const& arg1, Arg2T const& arg2, Arg3T const& arg3); 
// and so on 

Вы не хотели бы, чтобы отдельный вход документации для каждого из них, это было бы просто загромождать документацию.