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

phpdox generates HTML documentation without method descriptions #87

Closed
svscorp opened this issue Feb 8, 2013 · 6 comments
Closed

phpdox generates HTML documentation without method descriptions #87

svscorp opened this issue Feb 8, 2013 · 6 comments

Comments

@svscorp
Copy link

svscorp commented Feb 8, 2013

Hi.

This is the result of PHPDox generating of documentation:

3

But I could not find a description of parameters, return etc... Here is like it written in code:

/**
* Retrieve network usage ...
*
* @param string $cloudStackSetup
* @param date $fromDate start date
* @param date $toDate end date
*
* @return Array
* @todo refactor returned data - it is not HTML
* @secure(roles="ROLE")
*/

@svscorp
Copy link
Author

svscorp commented Feb 8, 2013

I have updated the version to the last and I got the same:
4

@svscorp
Copy link
Author

svscorp commented Feb 8, 2013

No description about param...

@theseer
Copy link
Owner

theseer commented Feb 8, 2013

This is clearly a problem in the (reworked) templates.
The xml data is collected correctly, so it's only lacking in proper rendering.
I'll try to fix the rendering problems over the weekend.

@svscorp
Copy link
Author

svscorp commented Feb 8, 2013

Thanks for the quick answer. Looking forward for this fix!

@svscorp
Copy link
Author

svscorp commented Feb 11, 2013

Hello. Have you found some time to take a look on this issue this weekend, Arne?

@svscorp
Copy link
Author

svscorp commented Feb 20, 2013

Here is the result:
x

p.s. sorry for use 'marker', it's a some kind of policy.

fxstein pushed a commit to fxstein/phpdox that referenced this issue Sep 5, 2015

Unverified

This user has not yet uploaded their public signing key.
…rts of method docblock: param, return, throws
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

2 participants