Skip to content

Constructor documentation is ignored unless description or @param is included #33

@afsmith92

Description

@afsmith92

I ran into this issue where @example tags on class docs get ignored if a description (tagless description or @description -- not @classdesc) is not included.

Based on this line the following tags on class docs are associated to the constructor:

  • description
  • params
  • examples
  • returns
  • exceptions

However, on this line a constructor is only output if it has a description or params. Would it make sense to update this to check for examples, returns, and exceptions as well?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions