Skip to content

Conversation

@phiggins
Copy link
Contributor

(My C knowledge is rusty, so prototype might not be the right term. My apologies).

When looking into why Zlib and WIN32OLE methods showed up on the missing documentation list when they had valid docs, I found that rdoc couldn't find documentation for C methods that had a prototype.

For example, with a recent checkout of ruby's trunk, running:

rdoc --encoding=UTF-8 -C ext/zlib/zlib.c

Outputs:

<snip>
Methods:     95 ( 83 undocumented)

Total:      150 (126 undocumented)
 16.00% documented

If I then open ext/zlib/zlib.c and delete lines 59-228 and rerun the above command, I get this output:

<snip>
Methods:     95 ( 1 undocumented)

Total:      150 (44 undocumented)
 70.67% documented

phiggins added 2 commits May 12, 2011 23:55
This was causing rdoc to miss documentation on some parts of ruby
implemented in C, for example zlib.c and win32ole.c.
drbrain added a commit that referenced this pull request May 13, 2011
Failing test case for Rdoc::Parser::C for C methods with a prototype
@drbrain drbrain merged commit c5d048d into ruby:master May 13, 2011
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants