[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Undocumented internal function
|
From: |
John W. Eaton |
|
Subject: |
Undocumented internal function |
|
Date: |
Tue, 31 Aug 2010 16:07:15 -0400 |
On 31-Aug-2010, Jordi Gutiérrez Hermoso wrote:
| This phrase is a little silly. It's ok if functions are internal, but
| that's no excuse to not document them, even if briefly. Can we
| deprecate this practice?
No.
Actually, there can be documentation for the internal functions in the
form of comments in the code, but I don't think it should be printed
by the help function.
| I also have grand dreams of using Doxygen to actually document the C++
| API, but I'm not sure how that would fit in with all the TeXinfo
| already in place.
What API?
jwe