Граф коммитов

39 Коммитов

Автор SHA1 Сообщение Дата
卜部昌平 d4b662d6f8 template/Doxyfile.tmpl: modernise
applied doxygen -g for Doxygen 1.9.7.
2023-06-29 09:27:12 +09:00
Takashi Kokubun 23ec248e48 s/mjit/rjit/ 2023-03-06 23:44:01 -08:00
Takashi Kokubun 2e875549a9 s/MJIT/RJIT/ 2023-03-06 23:44:01 -08:00
卜部昌平 940b3170c1 document for commit 5bbba76489 [ci skip] 2022-12-07 15:09:12 +09:00
卜部昌平 5112a54846 include/ruby/encoding.h: convert macros into inline functions
Less macros == huge win.
2021-10-05 14:18:23 +09:00
卜部昌平 789232f9fd template/Doxyfile.tmpl: modernise
applied doxygen -g for Doxygen 1.9.3.
2021-09-15 09:25:23 +09:00
卜部昌平 679f4b895b template/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]
2021-09-10 20:00:06 +09:00
sonots 0e3dae78b3 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]
2021-09-10 20:00:06 +09:00
卜部昌平 bbe7049813 template/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]
2021-09-10 20:00:06 +09:00
卜部昌平 809138fe4b include/ruby/io.h: add doxyen
Must not be a bad idea to improve documents. [ci skip]
2021-09-10 20:00:06 +09:00
卜部昌平 0ea157136f postscript about rb_mutex_sleep
Asked ko1 about the design.  [ci skip]
2021-09-10 20:00:06 +09:00
卜部昌平 4881a3ed38 include/ruby/internal/fl_type.h: add doxygen
Must not be a bad idea to improve documents. [ci skip]
2021-09-10 20:00:06 +09:00
卜部昌平 c3c0bf6823 include/ruby/internal/rgengc.h: add dosygen
Must not be a bad idea to improve documents. [ci skip]
2021-09-10 20:00:06 +09:00
卜部昌平 e2a441bdd4 include/ruby/internal/value_type.h: add doxygen
Must not be a bad idea to improve documents. [ci skip]
2021-09-10 20:00:06 +09:00
卜部昌平 28b7b0e13e include/ruby/internal/xmalloc.h: add doxygen
Must not be a bad idea to improve documents. [ci skip]
2021-09-10 20:00:06 +09:00
卜部昌平 b6469c3aaf template/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]
2021-09-10 20:00:06 +09:00
卜部昌平 a08163fb24 template/Doxyfile.tmpl: use of += operator
It is easier to maintain (e.g. sort them). [ci skip]
2021-09-10 20:00:06 +09:00
卜部昌平 f9af5c9542 template/Doxyfile.tmpl: quote spaces
The new Doxyfile.tmpl says:

> # Values that contain spaces should be placed between quotes (\" \").

[ci skip]
2021-09-10 20:00:06 +09:00
卜部昌平 85a737a1f9 template/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]
2021-09-10 20:00:06 +09:00
卜部昌平 c9753f3f91 template/Doxyfile.tmpl: delete commented-out settings
Let our VCS manage old contents. [ci skip]
2021-09-10 20:00:06 +09:00
卜部昌平 aa5dc3e297 template/Doxyfile.tmpl: modernize
Didn't question the current settings.  This changeset just re-applied
`doxygen -g` against:

doxygen 1.9.0 (1e72202d8fa0e9d2b3f2a29c88ec4f5790a0a4e2)

[ci skip]
2021-09-10 20:00:06 +09:00
卜部昌平 21b3bc10d3 DEPRECATED_TYPE: is deprecated
Nobody uses this macro any longer.
2020-08-27 15:02:52 +09:00
卜部昌平 9e6e39c351
Merge pull request #2991 from shyouhei/ruby.h
Split ruby.h
2020-04-08 13:28:13 +09:00
卜部昌平 3b69552a5c add 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.
2020-02-06 11:46:51 +09:00
Nobuyoshi Nakada 8bfc46a9a3
Fixed wrong usage of file2lastrev.rb 2019-09-07 11:59:19 +09:00
卜部昌平 a569bc09e2 add 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-09-06 15:50:58 +09:00
卜部昌平 48131a4673 rb_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.
2019-08-26 13:01:58 +09:00
svn 22224a45df * remove trailing spaces.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59390 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-07-22 06:30:54 +00:00
yugui 7b19e6f3fd Add documents
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59389 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-07-22 06:30:53 +00:00
nobu 792f7969bb Doxyfile.tmpl: exclude ccan
* 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
2014-05-17 07:46:05 +00:00
takano32 ae114a8ee6 * template/Doxyfile.tmpl: remove SHOW_DIRECTORIES and
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-10-05 08:20:34 +00:00
nobu cfcc9b53c2 * template/Doxyfile.tmpl (EXCLUDE_PATTERNS): exclude files only for tests.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@35526 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-05-03 14:56:36 +00:00
nobu f959f2afdd * template/Doxyfile.tmpl: exclude generated files.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@35525 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-05-03 14:05:34 +00:00
nobu b2c44e7af5 * template/Doxyfile.tmpl (INCLUDE_PATH): add srcdir and include.
[ruby-core:40843] [Bug #5597]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@33683 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2011-11-09 02:40:39 +00:00
naruse b5dc2576cc * ext/mkext.rb: remove purelib, fixes a bug in r28440, r28441.
* 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
2010-08-03 05:48:05 +00:00
usa af424b17a0 * template/Doxyfile.tmpl: RbConfig::CONFIG['DOT'] is sometimes nil.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@24946 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-09-16 04:16:19 +00:00
yugui 2d42e704f4 Doxy-comments.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@23902 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-06-29 16:39:28 +00:00
yugui d154bc4c7d * Doxyfile.in: removed. merged into template/Doxyfile.template
* 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-06-29 15:34:05 +00:00
nobu 42e0d76c25 * common.mk (Doxyfile): moved from Makefile.in.
* template/Doxyfile.tmpl: split from Doxyfile.in.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@21987 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-02-02 23:10:28 +00:00