summaryrefslogtreecommitdiff
path: root/template/Doxyfile.tmpl
diff options
context:
space:
mode:
authorsonots <sonots@gmail.com>2017-10-21 16:38:32 +0900
committer卜部昌平 <shyouhei@ruby-lang.org>2021-09-10 20:00:06 +0900
commit0e3dae78b31fbb86233aac80668a06d9930ca47f (patch)
tree333f8edc9e56e9dcc5b749b690902317d9904109 /template/Doxyfile.tmpl
parentbbe70498135c880fbece705b5962c3a9381857aa (diff)
template/Doxyfile.tmpl: EXTRACT_STATIC: YES [Bugs #14037]
I often feel that C API documents are lacked in C source codes, especially for static functions. I propose to turn EXTRACT_STATIC = YES flag of Doxygen to YES, and write document comments for static functions as much as possible. * template/Doxyfile.tmpl: EXTRACT_STATIC: YES [Bugs #14037]
Notes
Notes: Merged: https://github.com/ruby/ruby/pull/4815
Diffstat (limited to 'template/Doxyfile.tmpl')
-rw-r--r--template/Doxyfile.tmpl2
1 files changed, 1 insertions, 1 deletions
diff --git a/template/Doxyfile.tmpl b/template/Doxyfile.tmpl
index 3860bab3e3..529e7f2563 100644
--- a/template/Doxyfile.tmpl
+++ b/template/Doxyfile.tmpl
@@ -520,7 +520,7 @@ EXTRACT_PACKAGE = NO
# included in the documentation.
# The default value is: NO.
-EXTRACT_STATIC = NO
+EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,