This prevents file-static functions/variables be listed in the CAPI
documents. An entity shall be placed inside of a file that contains
`@file` doxygen comment, in order for it to be documented. [ci skip]
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]
I guess we don't want documents for C API of extension libraries? They
are never intended to provide C APIs anyways.
We could revisit this decision later. [ci skip]
Didn't question the current settings. This changeset just re-applied
`doxygen -g` against:
doxygen 1.9.0 (1e72202d8fa0e9d2b3f2a29c88ec4f5790a0a4e2)
[ci skip]
Predefined macros are practices not very well recommended, but can be
better than having no documents at all. Without those predefined
macros, Doxygen confused for instace PUREFUNC(int foo()) to be a
declaration of PUREFUNC, not foo.
Compilation of extension libraries written in C++ are reportedly
broken due to https://github.com/ruby/ruby/pull/2404
The root cause of this issue was that the definition of ANYARGS
differ between C and C++, and that of C++ is incompatible with the
updated ones.
We are using the incompatibility against itself. In C++ two distinct
function prototypes can be overloaded. We provide the old, ANYARGSed
prototypes in addition to the current granular ones; and let the
older ones warn about types.
HTML_ALIGN_MEMBERS lines. They have been obsolete in
Doxygen version 1.8.2.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@37095 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
* configure.in: new checking for dot and doxygen.
* template/Doxyfile.template: merged with Doxyfile.in.
configured some options.
* common.mk (capi): use $(DOXYGEN) instead of "doxygen".
(Doxyfile): removed a duplicate entry in the dependency.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@23895 b2dd03c8-39d4-4d8f-98ff-823fe69b080e