Two questions: class diagram and getters and setters

195 views
Skip to first unread message

Ernesto Carrea

unread,
Jul 29, 2014, 10:30:22 AM7/29/14
to phpdoc...@googlegroups.com

Hi, I'm using phpdoc to generate documentation for a couple of Symfony 2 bundles. I have two issues:

1) I want the class diagram for my projects only, but phpdoc searches the class hierarchy all the way up and ends up generating a diagram of the entire Symfony framework along with my project. How can I fix this?

2) I have a getter and a setter for every private member in entity classes, like this:

private $name;

public function getName() { ... }
public function setName($name) { ... }

I keep auto generated getters and setters at the bottom of every file and care very little about them, they're just a requirement for Doctrine ORM. So, I just want to document the "name" property, and skip superfluous documentation of the getters and setters.
Can I have phpdoc completely ignore all getters and setters in my project?

Thanks in advance,
Ernesto.

Mike van Riel

unread,
Jul 29, 2014, 10:49:19 AM7/29/14
to phpdoc...@googlegroups.com
Hello Ernesto,

There are no options to limit the Graph generation at current. If this is desirable I can recommend opening a ticket with what you would expect it to do so that we can implement it. I must admit however that there are a fair number of feature requests and although we try to implement most we will not be able to do this in a short timeframe.
Contributions are welcome and will certainly help speed things up :)

Regarding getters and setters; there is no automated way but you can use the @internal or @ignore tags on your getters/setters to omit them from the generated documentation.

If you have any other questions, let me know.

Mike
--
You received this message because you are subscribed to the Google Groups "phpDocumentor" group.
To unsubscribe from this group and stop receiving emails from it, send an email to phpdocumento...@googlegroups.com.
To post to this group, send email to phpdoc...@googlegroups.com.
To view this discussion on the web, visit https://groups.google.com/d/msgid/phpdocumentor/f956088a-8521-4a9e-8584-d07102d0b885%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply all
Reply to author
Forward
0 new messages