Doxygen ドキュメントにコメントが表示されないように、ソース (またはヘッダー) ファイルにコメントを配置する方法を見つけようとしています。 現在、どのコメントが表示され、どのコメントが表示されないかについてはよくわかりません。
多くの場合、ソース ファイル (.cpp) の 1 つに次のようなコードがあります。
///* OCBA P(CS) implementation for "max" problems */
//void OCBA_PCS() {
//
// Code goes here...
//
//}
/*! OCBA minimize simulation cost for "max" problems */
void OCBA_SC() {
// Code goes here...
}
ここで、関数が現在コメント アウトされていることがわかりますOCBA_PCS()。おそらく、機能していないため、ビルドから除外したいからです。ただし、Doxygen を実行すると、
* OCBA P(CS) implementation for "max" problems */
の詳細なドキュメント セクションに移動しOCBA_SC()ます。 どうすればこれを防ぐことができますか?
以下は、私が使用している関連する Doxygen 構成設定です。
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = YES
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = YES
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = NO
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
FORCE_LOCAL_INCLUDES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES = NO
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_DIRECTORIES = NO
SHOW_FILES = YES
SHOW_NAMESPACES = YES
FILE_VERSION_FILTER =
LAYOUT_FILE =