Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ignored classes are still compiled into docs #1959

Open
robertmain opened this issue Feb 27, 2018 · 4 comments
Open

Ignored classes are still compiled into docs #1959

robertmain opened this issue Feb 27, 2018 · 4 comments
Assignees

Comments

@robertmain
Copy link

When adding the @ignore annotation to classes, the annotation is ignored and documentation is generated for them anyway.

One workaround seems to be to add @internal which hides them from the docs - but that seems like a bit of a cheat.

Expected Behavior

The class should be omitted from the documentation

Actual Behavior

The class appears in the documentation

Steps to Reproduce the Problem

  1. Create a class with docblocks
  2. Add @ignore to the class
  3. The class appears in the documentation anyway

Your environment

Include as many relevant details about the environment you experienced the bug in and how to reproduce it.
Since many issue might only occur on a specific code base it would be very helpful if you link to your project
or add any code that is involved in to the issue.

@jaapio jaapio added this to Needs triage in Issue Triage Jun 15, 2019
@alddesign
Copy link

alddesign commented Aug 13, 2019

I can confirm this.
And i wonder why nobody needed this (very urgent like me)

@ssilviogit
Copy link

Hi guys, problem is still present.
Documentor v.2.9.1, PHP v7.1.7.
Someone can suggest a workaround?

@eli-darkly
Copy link

@ssilviogit The only workaround I know of is currently to add manual <ignore> directives in phpdoc.dist.xml for every source file or source directory that I don't want to document.

@mvriel
Copy link
Member

mvriel commented Oct 29, 2020

This issue should be resolved in phpDocumentor v3. I haven't had time yet to verify your specific example against it; help there is much appreciated. I will keep the issue open to verify this later; I am currently doing triage on open items

@mvriel mvriel self-assigned this Oct 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Needs triage
Issue Triage
  
Needs triage
Development

No branches or pull requests

5 participants