Bug #2059

Marking internal functions as internal

Added by yugui (Yuki Sonoda) over 2 years ago. Updated about 1 year ago.

Status:Rejected Start date:09/07/2009
Priority:Normal Due date:
Assignee:- % Done:

0%
Category:-
Target version:1.9.2
ruby -v:-

Description

All internal (extern) functions should be marked as internal in Doxygen comments before 1.9.2's release.

History

#1
Updated by mame (Yusuke Endoh) about 2 years ago

  • Status changed from Open to Rejected
Hi,

> All internal (extern) functions should be marked as internal
> in Doxygen comments before 1.9.2's release.

I strongly object.  If a function has no document, it should be
considered as function just for internal, by default.  We cannot
guarantee compatibility of non-documented functions completely.
Authors of ext library must use them at the risk.

Indeed, many functions have no document, even if the function is
really needed (and actually used) by many ext library. The fact
is unfortunate.
We should respect compatiblity of "behavior" as far as possible.

However, undocumented function is undocumented function.


Anyway, this is never a bug.  So I reject this ticket.


Ruby's C API should be reorganized and documented, towards 2.0.
Welcome volunteers.

-- 
Yusuke Endoh <mame@tsg.ne.jp>

Also available in: Atom PDF