(C++) クラスのプライベート セクションの後にパブリック セクションをドキュメント化するように Doxygen に指示するにはどうすればよいですか?
例えば
class Brg {
public:
//! this function will be documented
void documentedFunction1()
private:
void irrelevantFunction()
public:
//! this function will _not_ be documented
void undocumentedFunction1()
};
最初の公開セクションがなくても、2 番目の公開セクションはまだ文書化されていません。
doxylog.txt レポート:
警告: ドキュメント化された関数 `Brg:: undocumentedFunction1' は宣言または定義されていません
# ドクシーファイル 1.5.2
#------------------------------------------------- --------------------------
# プロジェクト関連の設定オプション
#------------------------------------------------- --------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "何とか"
プロジェクト番号 =
OUTPUT_DIRECTORY = ./gen_docs/
CREATE_SUBDIRS = いいえ
OUTPUT_LANGUAGE = 英語
BRIEF_MEMBER_DESC = はい
REPEAT_BRIEF = はい
ABBREVIATE_BRIEF =
常に_詳細_秒 = いいえ
INLINE_INHERITED_MEMB = いいえ
FULL_PATH_NAMES = いいえ
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = いいえ
JAVADOC_AUTOBRIEF = いいえ
MULTILINE_CPP_IS_BRIEF = いいえ
DETAILS_AT_TOP = いいえ
INHERIT_DOCS = はい
SEPARATE_MEMBER_PAGES = いいえ
TAB_SIZE = 4
エイリアス =
OPTIMIZE_OUTPUT_FOR_C = いいえ
OPTIMIZE_OUTPUT_JAVA = いいえ
BUILTIN_STL_SUPPORT = いいえ
CPP_CLI_SUPPORT = いいえ
DISTRIBUTE_GROUP_DOC = いいえ
サブグループ化 = はい
#------------------------------------------------- --------------------------
# 関連する設定オプションを構築する
#------------------------------------------------- --------------------------
EXTRACT_ALL = はい
EXTRACT_PRIVATE = いいえ
EXTRACT_STATIC = はい
EXTRACT_LOCAL_CLASSES = いいえ
EXTRACT_LOCAL_METHODS = いいえ
HIDE_UNDOC_MEMBERS = いいえ
HIDE_UNDOC_CLASSES = はい
HIDE_FRIEND_COMPOUNDS = いいえ
HIDE_IN_BODY_DOCS = いいえ
INTERNAL_DOCS = いいえ
CASE_SENSE_NAMES = はい
HIDE_SCOPE_NAMES = いいえ
SHOW_INCLUDE_FILES = はい
INLINE_INFO = はい
SORT_MEMBER_DOCS = はい
SORT_BRIEF_DOCS = いいえ
SORT_BY_SCOPE_NAME = いいえ
GENERATE_TODOLIST = はい
GENERATE_TESTLIST = はい
GENERATE_BUGLIST = はい
GENERATE_DEPRECATEDLIST=はい
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = はい
SHOW_DIRECTORIES = はい
ファイル_バージョン_フィルター =
#------------------------------------------------- --------------------------
# 警告と進行状況メッセージに関連する設定オプション
#------------------------------------------------- --------------------------
静かな = いいえ
警告 = はい
WARN_IF_UNDOCUMENTED = はい
WARN_IF_DOC_ERROR = はい
WARN_NO_PARAMDOC = いいえ
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE = doxylog.txt
#------------------------------------------------- --------------------------
# 入力ファイルに関連する設定オプション
#------------------------------------------------- --------------------------
入力 = 。\
..\コード
IMAGE_PATH = .
入力_エンコード = UTF-8
ファイル_パターン = *.cpp \
*.cc \
*.h \
*.hpp\
*。TXT
例_パス = . \
..\コード\
EXAMPLE_PATTERNS = *.lua \
*.h
例_再帰 = はい
再帰 = はい
除外 =
EXCLUDE_SYMLINKS = いいえ
除外パターン =
EXCLUDE_SYMBOLS =
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = いいえ
#------------------------------------------------- --------------------------
# ソース閲覧に関する設定オプション
#------------------------------------------------- --------------------------
SOURCE_BROWSER = いいえ
INLINE_SOURCES = いいえ
STRIP_CODE_COMMENTS = はい
REFERENCED_BY_RELATION = はい
REFERENCES_RELATION = はい
REFERENCES_LINK_SOURCE = はい
USE_HTAGS = いいえ
VERBATIM_HEADERS = はい
#------------------------------------------------- --------------------------
# アルファベット順のクラス インデックスに関連する設定オプション
#------------------------------------------------- --------------------------
ALPHABETICAL_INDEX = いいえ
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#------------------------------------------------- --------------------------
# HTML 出力に関連する設定オプション
#------------------------------------------------- --------------------------
GENERATE_HTML = はい
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = はい
GENERATE_HTMLHELP = はい
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = はい
BINARY_TOC = いいえ
TOC_EXPAND = いいえ
DISABLE_INDEX = いいえ
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = いいえ
TREEVIEW_WIDTH = 250
#------------------------------------------------- --------------------------
# LaTeX 出力に関連する設定オプション
#------------------------------------------------- --------------------------
GENERATE_LATEX = いいえ
LATEX_OUTPUT = ラテックス
LATEX_CMD_NAME = ラテックス
EXTRA_PACKAGES = アムスマス
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = いいえ
PAPER_TYPE = a4ワイド
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = はい
USE_PDFLATEX = はい
LATEX_BATCHMODE = いいえ
LATEX_HIDE_INDICES = いいえ
#------------------------------------------------- --------------------------
# RTF 出力に関連する設定オプション
#------------------------------------------------- --------------------------
GENERATE_RTF = いいえ
RTF_OUTPUT = rtf
COMPACT_RTF = いいえ
RTF_HYPERLINKS = いいえ
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
#------------------------------------------------- --------------------------
# man ページの出力に関連する設定オプション
#------------------------------------------------- --------------------------
GENERATE_MAN = いいえ
MAN_OUTPUT = 男
MAN_EXTENSION = .3
MAN_LINKS = いいえ
#------------------------------------------------- --------------------------
# XML 出力に関連する設定オプション
#------------------------------------------------- --------------------------
GENERATE_XML = いいえ
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = はい
#------------------------------------------------- --------------------------
# AutoGen Definitions 出力の構成オプション
#------------------------------------------------- --------------------------
GENERATE_AUTOGEN_DEF = いいえ
#------------------------------------------------- --------------------------
# Perl モジュール出力に関連する設定オプション
#------------------------------------------------- --------------------------
GENERATE_PERLMOD = いいえ
PERLMOD_LATEX = いいえ
PERLMOD_PRETTY = はい
PERLMOD_MAKEVAR_PREFIX =
#------------------------------------------------- --------------------------
# プリプロセッサに関連する設定オプション
#------------------------------------------------- --------------------------
ENABLE_PREPROCESSING = はい
MACRO_EXPANSION = いいえ
EXPAND_ONLY_PREDEF = いいえ
SEARCH_INCLUDES = はい
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
定義済み =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = はい
#------------------------------------------------- --------------------------
# Configuration::外部参照に関連する追加
#------------------------------------------------- --------------------------
TAGFILES = ../ExternalModule/ExternalModule.tag=../../../ExternalModule/Docs/html
GENERATE_TAGFILE = モジュール名.tag
ALLEXTERNALS = いいえ
外部グループ = はい
PERL_PATH = /usr/bin/perl
#------------------------------------------------- --------------------------
# dot ツールに関連する設定オプション
#------------------------------------------------- --------------------------
CLASS_DIAGRAMS = はい
MSCGEN_PATH =
HIDE_UNDOC_RELATIONS = はい
HAVE_DOT = はい
クラス_グラフ = はい
コラボレーション_グラフ = はい
GROUP_GRAPHS = はい
UML_LOOK = いいえ
テンプレート_関係 = はい
INCLUDE_GRAPH = はい
INCLUDED_BY_GRAPH = はい
CALL_GRAPH = いいえ
CALLER_GRAPH = いいえ
GRAPHICAL_HIERARCHY = はい
ディレクトリ_グラフ = はい
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
DOT_GRAPH_MAX_NODES = 50
DOT_TRANSPARENT = いいえ
DOT_MULTI_TARGETS = いいえ
GENERATE_LEGEND = はい
DOT_CLEANUP = はい
#------------------------------------------------- --------------------------
# Configuration::検索エンジン関連の追加
#------------------------------------------------- --------------------------
検索エンジン = いいえ