rdoc icon indicating copy to clipboard operation
rdoc copied to clipboard

Convention to include non-ASCII characters in C comments

Open duerst opened this issue 9 years ago • 1 comments

For some classes and methods, it would be great if non-ASCII characters could be included in rdoc documentation. One example would be String#upcase/downcase/swapcase/capitalize, which newly work for all of Unicode.

For Ruby files, this should already work, because these files are UTF-8 by default nowadays.

However, for C source, there is a problem: There are still C compilers that bark at non-ASCII characters/bytes in C source. This would mean that we need some kind of escaping convention. One obvious choice would be HTML/XML escapes (ü).

If there's already a solution for this, I'd appreciate to know. If not, I'll be glad to contribute.

duerst avatar Jun 06 '16 05:06 duerst

As a workaround you can use :include:, see the documentation here: http://docs.seattlerb.org/rdoc/RDoc/Markup.html#class-RDoc::Markup-label-Other+directives

zzak avatar Sep 09 '16 07:09 zzak