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

Apigen error reported, what am I missing? #203

Closed
harikt opened this issue Nov 12, 2012 · 9 comments
Closed

Apigen error reported, what am I missing? #203

harikt opened this issue Nov 12, 2012 · 9 comments
Assignees

Comments

@harikt
Copy link

harikt commented Nov 12, 2012

HelloWorld.php

<?php
/**
 *
 * Some stuffs that work
 *
 * @package Hello.World
 *
 * @author Hari K T
 *
 * @since 13-11-2012
 *
 */
class HelloWorld
{
    /**
     * 
     * Short description
     *
     * Long description
     *
     */
    public function __construct()
    {
    }

    /**
     *
     * Short greet
     *
     * Long greet
     *
     * @return string A string
     *
     */
    public function greet()
    {
        return "Hello World";
    }
}

Error reported as xml is

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="1.3.0">
    <file name="/media/Linux/test/apigen/HelloWorld.php">
        <error severity="error" line="2" message="Missing description of class HelloWorld" source="ApiGen.Documentation.Documentation"/>
        <error severity="error" line="15" message="Missing documentation of method HelloWorld::__construct()" source="ApiGen.Documentation.Documentation"/>
        <error severity="error" line="26" message="Missing description of method HelloWorld::greet()" source="ApiGen.Documentation.Documentation"/>
    </file>
</checkstyle>

What am I missing ?

@kukulich
Copy link
Contributor

Description should be on the first line of documentation.

@harikt
Copy link
Author

harikt commented Nov 12, 2012

Is it really the first line? I wonder.

@harikt
Copy link
Author

harikt commented Nov 12, 2012

I feel for many of the @auraphp classes starts with a blank line . And I didn't noticed phpdocumentator throwing any errors for this. And if we want to switch to apigen , I feel its hard then for rewriting all those stuffs.

@kukulich
Copy link
Contributor

Hmm, I will look at it.

@ghost ghost assigned kukulich Nov 12, 2012
@harikt
Copy link
Author

harikt commented Nov 13, 2012

Thank you.

marian-r added a commit to marian-r/apigen that referenced this issue May 31, 2014
TomasVotruba pushed a commit that referenced this issue Sep 1, 2014
Missing documentation reported only when longDescription is missing (closes #203)
@TomasVotruba
Copy link
Contributor

This should be fixed by now

@kukulich kukulich reopened this Nov 15, 2014
@kukulich
Copy link
Contributor

The fix is wrong.

@marian-r
Copy link
Contributor

I don't have time at the moment, maybe during the week. @kukulich, if you have time, you can look at it.

@TomasVotruba
Copy link
Contributor

@kukulich Linked fix is not relevant nor used anymore. Generation works properly for code mentioned above, thus issue is solved.

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

No branches or pull requests

4 participants