summaryrefslogtreecommitdiff
path: root/template/Doxyfile.tmpl
Commit message (Collapse)AuthorAgeFilesLines
* s/mjit/rjit/Takashi Kokubun2023-03-061-1/+1
|
* s/MJIT/RJIT/Takashi Kokubun2023-03-061-4/+4
|
* document for commit 5bbba76489628f450949 [ci skip]卜部昌平2022-12-071-0/+1
|
* include/ruby/encoding.h: convert macros into inline functions卜部昌平2021-10-051-0/+1
| | | | Less macros == huge win.
* template/Doxyfile.tmpl: modernise卜部昌平2021-09-151-112/+138
| | | | applied doxygen -g for Doxygen 1.9.3.
* template/Doxyfile.tmpl: EXTRACT_ALL=NO卜部昌平2021-09-101-1/+1
| | | | | | 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]
* template/Doxyfile.tmpl: EXTRACT_STATIC: YES [Bugs #14037]sonots2021-09-101-1/+1
| | | | | | | | | 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]
* template/Doxyfile.tmpl: rethink about exclusions卜部昌平2021-09-101-3/+1
| | | | | | | 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]
* include/ruby/io.h: add doxyen卜部昌平2021-09-101-0/+1
| | | | Must not be a bad idea to improve documents. [ci skip]
* postscript about rb_mutex_sleep卜部昌平2021-09-101-0/+1
| | | | Asked ko1 about the design. [ci skip]
* include/ruby/internal/fl_type.h: add doxygen卜部昌平2021-09-101-0/+2
| | | | Must not be a bad idea to improve documents. [ci skip]
* include/ruby/internal/rgengc.h: add dosygen卜部昌平2021-09-101-0/+1
| | | | Must not be a bad idea to improve documents. [ci skip]
* include/ruby/internal/value_type.h: add doxygen卜部昌平2021-09-101-0/+1
| | | | Must not be a bad idea to improve documents. [ci skip]
* include/ruby/internal/xmalloc.h: add doxygen卜部昌平2021-09-101-0/+1
| | | | Must not be a bad idea to improve documents. [ci skip]
* template/Doxyfile.tmpl: add alias卜部昌平2021-09-101-0/+1
| | | | | This enables me to write `@shyouhei` in C comments without complained by doxygen that @shyouhei is an unknown special command. [ci skip]
* template/Doxyfile.tmpl: use of += operator卜部昌平2021-09-101-45/+77
| | | | It is easier to maintain (e.g. sort them). [ci skip]
* template/Doxyfile.tmpl: quote spaces卜部昌平2021-09-101-1/+1
| | | | | | | | The new Doxyfile.tmpl says: > # Values that contain spaces should be placed between quotes (\" \"). [ci skip]
* template/Doxyfile.tmpl: increase DOT_GRAPH_MAX_NODES卜部昌平2021-09-101-1/+1
| | | | | | | | `make capi` warned: > warning: Included by graph for 'dllexport.h' not generated, too many nodes (85) [ci skip]
* template/Doxyfile.tmpl: delete commented-out settings卜部昌平2021-09-101-99/+0
| | | | Let our VCS manage old contents. [ci skip]
* template/Doxyfile.tmpl: modernize卜部昌平2021-09-101-29/+2445
| | | | | | | | | Didn't question the current settings. This changeset just re-applied `doxygen -g` against: doxygen 1.9.0 (1e72202d8fa0e9d2b3f2a29c88ec4f5790a0a4e2) [ci skip]
* DEPRECATED_TYPE: is deprecated卜部昌平2020-08-271-1/+0
| | | | Nobody uses this macro any longer.
* Merge pull request #2991 from shyouhei/ruby.h卜部昌平2020-04-081-8/+8
| | | Split ruby.h
* add predefined macros for Doxygen卜部昌平2020-02-061-3/+43
| | | | | | | 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.
* Fixed wrong usage of file2lastrev.rbNobuyoshi Nakada2019-09-071-1/+1
|
* add include/ruby/backward/cxxanyargs.hpp卜部昌平2019-09-061-1/+1
| | | | | | | | | | | | | | 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.
* rb_mjit_header.h is not worth documenting [ci skip]卜部昌平2019-08-261-1/+1
| | | | | This is an auto-generated header file that does not include anything interesting. Should skip generating CAPI documents.
* * remove trailing spaces.svn2017-07-221-34/+34
| | | | git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59390 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
* Add documentsyugui2017-07-221-3/+3
| | | | git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59389 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
* Doxyfile.tmpl: exclude ccannobu2014-05-171-1/+1
| | | | | | * 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
* * template/Doxyfile.tmpl: remove SHOW_DIRECTORIES andtakano322012-10-051-2/+0
| | | | | | | | 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
* * template/Doxyfile.tmpl (EXCLUDE_PATTERNS): exclude files only for tests.nobu2012-05-031-2/+2
| | | | git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@35526 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
* * template/Doxyfile.tmpl: exclude generated files.nobu2012-05-031-2/+2
| | | | git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@35525 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
* * template/Doxyfile.tmpl (INCLUDE_PATH): add srcdir and include.nobu2011-11-091-6/+6
| | | | | | [ruby-core:40843] [Bug #5597] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@33683 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
* * ext/mkext.rb: remove purelib, fixes a bug in r28440, r28441.naruse2010-08-031-1/+1
| | | | | | | | * 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
* * template/Doxyfile.tmpl: RbConfig::CONFIG['DOT'] is sometimes nil.usa2009-09-161-1/+1
| | | | git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@24946 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
* Doxy-comments.yugui2009-06-291-3/+3
| | | | git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@23902 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
* * Doxyfile.in: removed. merged into template/Doxyfile.templateyugui2009-06-291-5/+250
| | | | | | | | | | | | * 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
* * common.mk (Doxyfile): moved from Makefile.in.nobu2009-02-021-0/+22
* template/Doxyfile.tmpl: split from Doxyfile.in. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@21987 b2dd03c8-39d4-4d8f-98ff-823fe69b080e