Skip to content

C Extension Documentation not Parsed #543

@zhangsu

Description

@zhangsu

It seems that the documentations for methods and constants in this file are not getting parsed by YARD even though they are valid RDoc markups. I use the following command to generate the docs from the project root directory:

yardoc 'src/rubyext.c'

and I got:

Files:           1
Modules:         0 (    0 undocumented)
Classes:         8 (    0 undocumented)
Constants:       0 (    0 undocumented)
Methods:         0 (    0 undocumented)
 100.00% documented

So apparently only the RDoc Document-class directives are parsed.

Tested using YARD 0.8.1.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions