Boost.LogのBOOST_LOG_DOXYGEN_PASSは何ですか？

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は可変長テンプレートが表示され、そのHTMLマニュアルは、次のようなものを言うだろう：

add_file_log（ArgsT ... constの&引数を）。

テンプレートパラメータ：

• テンプレート<型名... ArgsT>

戻り値の型：

shared_ptr< BOOST_LOG_FILE_SINK_FRONTEND_INTERNAL<sinks::text_file_backend> > 

機能は、ファイルストリームにログを書き込むために、ロギングライブラリを初期化。

...とそう

上でも明らかに可変引数テンプレートをサポートしていないコンパイラで動作しますので、実際のコンパイラはこれを見ることができないログを後押し。 （それは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 

あなたはこれらのそれぞれに個別のドキュメントエントリを望んでいないだろう、それはですドキュメントを乱雑にするだけです。