phpDoc in Laravel

Use PhpStorm, you can generate docblocks :)

@icsbcn I second @malfait.robin's PhpStorm answer, and here's how.

PhpStorm is free for students too, see here

Note that any and all keyboard shortcuts are customisable too!

Hello @malfait.robin and @mstnorris ,

Thank you so much for your responses! My problem isn't with the generation of documentation blocks. What I want is: In a Laravel project with all documentation blocks already written in different scripts php, create useful HTML documentation for developers... something similiar to: http://laravel.com/api/5.0/

Best regards, Iban Cardona.

Ahh ok, I see, then it is phpDocumentor that you want or something similar.

@icsbcn ApiGen looks nice.

Hello @mstnorris,

Yes! I think that phpDocumentor is a good option but I think that isn't integrated with Laravel, is it?

Best regards, Iban Cardona.

@icsbcn you don't need it to be integrated, phpDocumentor will just parse the docblocks.

Have you tried it? Are you having any issues? What is it that you wish to accomplish?

Hello @mstnorris,

Yes. I tried it with Laravel 4.2. The HTML pages were created correctly but I had problems with url in that pages... I mean:

• I created all phpDocumentor inside .../public/phoDocumentor
• The problem is that all url in the HTML are like this: /css/some.css and I'd like url to my "site" like this http://mysite/public/phpDocumentor/css/some.css

Best regards, Iban Cardona.

@icsbcn I'm sure you can change that

Check out the configuratin docs

Hello @mstnorris,

I thought I could find, but it wasn't... I created new issue in phpDocumentor forum: https://groups.google.com/forum/#!topic/phpdocumentor/HferQfprLLM

Best regards, Iban Cardona.

@icsbcn why not try ApiGen then?

Hey guys, I'm ApiGen maintainer and saw some links on Twitter. I'll try to help you the best I can.

If I understand this correctly, you need to use your own .css style?

Hi @mstnorri,

Why yes? I mean, I read this post that says that phpDocumentor is best option: http://www.charlestonsw.com/apigen-versus-phpdoc/

Best regards, Iban Cardona.

@TomasVotruba no, from @icsbcn original post, I think they want to use the full URL within the generated docs

@TomasVotruba Yes, @mstnorris is right.

Hello @TomasVotruba,

I used ApiGen and I liked it! In Laravel 4.2, I used this command to generate code: apigen generate --source ./app --exclude=*/commands/*,*/config/*,*/database/*,*/lang/*,*/start/*,*/storage/*,*/views/*,filters.php,routes.php --destination ./public/api --no-source-code

Result here: http://ibancardonasubiela.tk/public/api/index.html

Best regards, Iban Cardona.

Laravel uses https://github.com/fabpot/sami if that's what you're asking.

There's a link at the bottom of the page ;)

https://github.com/fabpot/sami

Has anyone been able to get phpdocumentor to work with a Laravel 5.1 project?

Seems to work fine for Laravel 4.2, but when I run this in a Laravel 5.1 project, it's not parsing any of my files. It can be reproduced on a new Laravel project.

When I view the debug output, I'm seeing:

  In the ProjectDescriptor are:         
  19 files
  0 top-level namespaces
  0 unresolvable parent classes
  1 phpDocumentor\Descriptor\NamespaceDescriptor elements  [] []

The "0 top level namespaces" tells me it's not finding anything.

I suspect that it has something to do with nikic/php-parser, since it is a different version on a L4.2 project vs. a L5.1 project. psy/psysh seems to want a specific version of nikic/php-parser.

any documentation for configuring Apigen?

I could not find any other than whats on README.

@MSTNORRIS - But ApiGen is used for generating API documentation, like swagger. phpDocumentor is used for generating code documentation out of code blocks

There seems to be an issue with symphony and phpDocs though. I cannot get it do anything but tell me no.

I am using netbeans + phpDocumentor mostly in some project