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

FIXME marker not being reported when inside a comment block #2060

Open
Tilogorn opened this issue Jan 29, 2019 · 1 comment
Open

FIXME marker not being reported when inside a comment block #2060

Tilogorn opened this issue Jan 29, 2019 · 1 comment

Comments

@Tilogorn
Copy link

Expected Behavior

I expect markers to be reported when they are used within /* ... */ syntax.

/**
 * Does stuff
 * FIXME: Adapt to new API
 * 
 * @param int $age Age of the user
 *
 * @return void
 */
public function myFunction($age)
{
    // FIXME: Has to be implemented
    /* FIXME: Has to be documented */
}

Actual Behavior

The first marker gets ignored, the second works, the third gets ignored

Steps to Reproduce the Problem

  1. Install phpDocumentor
  2. Create a file with the code from the example
  3. Run phpDocumentor
  4. The first marker gets ignored

Your environment

  • Version used: 2.9.0 and 3.0.0-alpha3
  • PHAR-File
  • PHP 7.2.10
  • Linux Mint 19

Although the documentation says "In short, a Marker is a single-line inline comment that starts with a single, identifying, word and has a description." (link) I find it useful to include /* ... */ makers as well.

@mvriel
Copy link
Member

mvriel commented Jun 15, 2019

Thank you for reporting your feature request; at this point, we are focusing on fixing issues that prevent us from launching phpDocumentor v3. As soon as that is done we can prioritize this request. Of course, we appreciate contributions if someone would like to try and resolve this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants