ruby.git/template/Doxyfile.tmpl, branch v3_2_11 The Ruby Programming Language document for commit 5bbba76489628f450949 [ci skip] 2022-12-07T06:09:12+00:00 卜部昌平 shyouhei@ruby-lang.org 2022-07-21T09:00:04+00:00 940b3170c1fb51e31fa3396f0a71fc8db9ac096c 






include/ruby/encoding.h: convert macros into inline functions
2021-10-05T05:18:23+00:00

卜部昌平
shyouhei@ruby-lang.org

2021-09-29T03:58:26+00:00

5112a548467e04ebdb386f0cc7bacb29f38d3fd2

Less macros == huge win.





Less macros == huge win.







template/Doxyfile.tmpl: modernise
2021-09-15T00:25:23+00:00

卜部昌平
shyouhei@ruby-lang.org

2021-09-13T07:53:52+00:00

789232f9fde3c8956397778b30b98d7e18361bed

applied doxygen -g for Doxygen 1.9.3.





applied doxygen -g for Doxygen 1.9.3.







template/Doxyfile.tmpl: EXTRACT_ALL=NO
2021-09-10T11:00:06+00:00

卜部昌平
shyouhei@ruby-lang.org

2021-01-11T08:40:38+00:00

679f4b895b683430c49f0014ac885eb9291d59e9

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]





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]
2021-09-10T11:00:06+00:00

sonots
sonots@gmail.com

2017-10-21T07:38:32+00:00

0e3dae78b31fbb86233aac80668a06d9930ca47f

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 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-10T11:00:06+00:00

卜部昌平
shyouhei@ruby-lang.org

2021-01-12T08:19:48+00:00

bbe70498135c880fbece705b5962c3a9381857aa

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]





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-10T11:00:06+00:00

卜部昌平
shyouhei@ruby-lang.org

2021-07-08T03:48:32+00:00

809138fe4bb4e72b9c790de794b6ca50b8586291

Must not be a bad idea to improve documents. [ci skip]





Must not be a bad idea to improve documents. [ci skip]







postscript about rb_mutex_sleep
2021-09-10T11:00:06+00:00

卜部昌平
shyouhei@ruby-lang.org

2021-03-24T00:21:58+00:00

0ea157136f1b255321722db1acd0be3c6229a77a

Asked ko1 about the design.  [ci skip]





Asked ko1 about the design.  [ci skip]







include/ruby/internal/fl_type.h: add doxygen
2021-09-10T11:00:06+00:00

卜部昌平
shyouhei@ruby-lang.org

2021-01-20T01:18:13+00:00

4881a3ed38dca132ae85878d40ad79b8f4aa5e55

Must not be a bad idea to improve documents. [ci skip]





Must not be a bad idea to improve documents. [ci skip]







include/ruby/internal/rgengc.h: add dosygen
2021-09-10T11:00:06+00:00

卜部昌平
shyouhei@ruby-lang.org

2021-01-07T01:27:53+00:00

c3c0bf6823ed86981235b71b83cb420d272532cb

Must not be a bad idea to improve documents. [ci skip]





Must not be a bad idea to improve documents. [ci skip]