Project

General

Profile

Misc #14037

Writing doxygen document comments to static functions

Added by sonots (Naotoshi Seo) about 2 years ago. Updated about 2 years ago.

Status:
Open
Priority:
Normal
Assignee:
-
[ruby-core:83433]

Description

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.

Also available in: Atom PDF