summaryrefslogtreecommitdiff
path: root/template/Doxyfile.tmpl
AgeCommit message (Collapse)Author
2024-03-24Remove never used macros related to RJIT [ci skip]Nobuyoshi Nakada
These macros have not been used since the commit "Stop exporting symbols for MJIT" 233ddfac541749a0da80ea27913dc1ef4ea700bb, and renamed as RJIT.
2024-03-19[DOC] Unify Doxygen formats (#10285)Takashi Kokubun
2023-06-29template/Doxyfile.tmpl: modernise卜部昌平
applied doxygen -g for Doxygen 1.9.7. Notes: Merged: https://github.com/ruby/ruby/pull/7986
2023-03-06s/mjit/rjit/Takashi Kokubun
Notes: Merged: https://github.com/ruby/ruby/pull/7462
2023-03-06s/MJIT/RJIT/Takashi Kokubun
Notes: Merged: https://github.com/ruby/ruby/pull/7462
2022-12-07document for commit 5bbba76489628f450949 [ci skip]卜部昌平
2021-10-05include/ruby/encoding.h: convert macros into inline functions卜部昌平
Less macros == huge win. Notes: Merged: https://github.com/ruby/ruby/pull/4909
2021-09-15template/Doxyfile.tmpl: modernise卜部昌平
applied doxygen -g for Doxygen 1.9.3. Notes: Merged: https://github.com/ruby/ruby/pull/4835
2021-09-10template/Doxyfile.tmpl: EXTRACT_ALL=NO卜部昌平
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] Notes: Merged: https://github.com/ruby/ruby/pull/4815
2021-09-10template/Doxyfile.tmpl: EXTRACT_STATIC: YES [Bugs #14037]sonots
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: Merged: https://github.com/ruby/ruby/pull/4815
2021-09-10template/Doxyfile.tmpl: rethink about exclusions卜部昌平
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] Notes: Merged: https://github.com/ruby/ruby/pull/4815
2021-09-10include/ruby/io.h: add doxyen卜部昌平
Must not be a bad idea to improve documents. [ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/4815
2021-09-10postscript about rb_mutex_sleep卜部昌平
Asked ko1 about the design. [ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/4815
2021-09-10include/ruby/internal/fl_type.h: add doxygen卜部昌平
Must not be a bad idea to improve documents. [ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/4815
2021-09-10include/ruby/internal/rgengc.h: add dosygen卜部昌平
Must not be a bad idea to improve documents. [ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/4815
2021-09-10include/ruby/internal/value_type.h: add doxygen卜部昌平
Must not be a bad idea to improve documents. [ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/4815
2021-09-10include/ruby/internal/xmalloc.h: add doxygen卜部昌平
Must not be a bad idea to improve documents. [ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/4815
2021-09-10template/Doxyfile.tmpl: add alias卜部昌平
This enables me to write `@shyouhei` in C comments without complained by doxygen that @shyouhei is an unknown special command. [ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/4815
2021-09-10template/Doxyfile.tmpl: use of += operator卜部昌平
It is easier to maintain (e.g. sort them). [ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/4815
2021-09-10template/Doxyfile.tmpl: quote spaces卜部昌平
The new Doxyfile.tmpl says: > # Values that contain spaces should be placed between quotes (\" \"). [ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/4815
2021-09-10template/Doxyfile.tmpl: increase DOT_GRAPH_MAX_NODES卜部昌平
`make capi` warned: > warning: Included by graph for 'dllexport.h' not generated, too many nodes (85) [ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/4815
2021-09-10template/Doxyfile.tmpl: delete commented-out settings卜部昌平
Let our VCS manage old contents. [ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/4815
2021-09-10template/Doxyfile.tmpl: modernize卜部昌平
Didn't question the current settings. This changeset just re-applied `doxygen -g` against: doxygen 1.9.0 (1e72202d8fa0e9d2b3f2a29c88ec4f5790a0a4e2) [ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/4815
2020-08-27DEPRECATED_TYPE: is deprecated卜部昌平
Nobody uses this macro any longer. Notes: Merged: https://github.com/ruby/ruby/pull/3341
2020-04-08Merge pull request #2991 from shyouhei/ruby.h卜部昌平
Split ruby.h Notes: Merged-By: shyouhei <shyouhei@ruby-lang.org>
2020-02-06add predefined macros for Doxygen卜部昌平
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. Notes: Merged: https://github.com/ruby/ruby/pull/2885
2019-09-07Fixed wrong usage of file2lastrev.rbNobuyoshi Nakada
2019-09-06add include/ruby/backward/cxxanyargs.hpp卜部昌平
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.
2019-08-26rb_mjit_header.h is not worth documenting [ci skip]卜部昌平
This is an auto-generated header file that does not include anything interesting. Should skip generating CAPI documents.
2017-07-22* remove trailing spaces.svn
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59390 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-07-22Add documentsyugui
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59389 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2014-05-17Doxyfile.tmpl: exclude ccannobu
* template/Doxyfile.tmpl (EXCLUDE): exclude ccan. [ruby-core:62557] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@45972 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-10-05* template/Doxyfile.tmpl: remove SHOW_DIRECTORIES andtakano32
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
2012-05-03* template/Doxyfile.tmpl (EXCLUDE_PATTERNS): exclude files only for tests.nobu
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@35526 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-05-03* template/Doxyfile.tmpl: exclude generated files.nobu
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@35525 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2011-11-09* template/Doxyfile.tmpl (INCLUDE_PATH): add srcdir and include.nobu
[ruby-core:40843] [Bug #5597] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@33683 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2010-08-03* ext/mkext.rb: remove purelib, fixes a bug in r28440, r28441.naruse
* spec/default.mspec: ditto. * template/Doxyfile.tmpl: ditto. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@28843 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-09-16* template/Doxyfile.tmpl: RbConfig::CONFIG['DOT'] is sometimes nil.usa
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@24946 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-06-29Doxy-comments.yugui
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@23902 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-06-29* Doxyfile.in: removed. merged into template/Doxyfile.templateyugui
* 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
2009-02-02* common.mk (Doxyfile): moved from Makefile.in.nobu
* template/Doxyfile.tmpl: split from Doxyfile.in. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@21987 b2dd03c8-39d4-4d8f-98ff-823fe69b080e