[#83107] Alias Enumerable#include? to Enumerable#includes? — Alberto Almagro <albertoalmagro@...>

Hello,

9 messages 2017/10/04

[ruby-core:83433] [Ruby trunk Misc#14037] Writing doxygen document comments to static functions

From: sonots@...
Date: 2017-10-21 07:46:21 UTC
List: ruby-core #83433
Issue #14037 has been reported by sonots (Naotoshi Seo).

----------------------------------------
Misc #14037: Writing doxygen document comments to static functions
https://bugs.ruby-lang.org/issues/14037

* Author: sonots (Naotoshi Seo)
* Status: Open
* Priority: Normal
* Assignee: 
----------------------------------------
I often feel that C API documents are lacked in C source codes, especially for `static` functions.

With https://bugs.ruby-lang.org/issues/904, `make install-capi` target was introduced to generate c api documents using Doxygen.
However, I feel that it is not utilized among C Ruby developers.

I propose to turn `EXTRACT_STATIC = YES` flag of Doxygen to YES, and write document comments for static functions as much as possible.



-- 
https://bugs.ruby-lang.org/

Unsubscribe: <mailto:ruby-core-request@ruby-lang.org?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>

In This Thread

Prev Next