Skip to content

False undocumented methods, mangled parameters. #1101

@woodruffw

Description

@woodruffw

I'm having problems with my yardoc generated documentation in a particular file, which you can find here:

https://github.com/woodruffw/kbsecret/blob/945ee8ebc8d7d44580aaf3585bb744ce1037293a/lib/kbsecret/record/abstract.rb

Steps to reproduce

$ git clone https://github.com/woodruffw/kbsecret && cd kbsecret
$ yard

You can also see this bug in the rubydoc.info generated page.

Actual Output

The load!, initialize, and initialize_from_hash methods have their parameter lists mangled:

Furthermore, the actual documentation detail is missing for each (except for @note and @api private tags):



yard stats --list-undoc also incorrectly shows these methods as undocumented:

Files:          13
Modules:         2 (    0 undocumented)
Classes:        12 (    0 undocumented)
Constants:       4 (    0 undocumented)
Attributes:     10 (    0 undocumented)
Methods:        58 (    4 undocumented)
 95.35% documented

Undocumented Objects:

(in file: lib/kbsecret/record/abstract.rb)
KBSecret::Record::Abstract.load!
KBSecret::Record::Abstract#initialize_from_hash
KBSecret::Record::Abstract#data_fields
KBSecret::Record::Abstract#sensitive?

Expected Output

Expected: correctly presented parameter names, full documentation detail under each method, and each method recognized as documented.

Environment details:

  • OS: Linux (Ubuntu LTS 16.04)
  • Ruby version (ruby -v): ruby 2.4.1p111 (2017-03-22 revision 58053) [x86_64-linux-gnu]
  • YARD version (yard -v): yard 0.9.9

I have read the Contributing Guide.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions