Skip to content
This repository has been archived by the owner on Jan 29, 2020. It is now read-only.

Add clear docblock to all classes and interfaces #297

Open
fadoe opened this issue Dec 28, 2017 · 4 comments
Open

Add clear docblock to all classes and interfaces #297

fadoe opened this issue Dec 28, 2017 · 4 comments

Comments

@fadoe
Copy link

fadoe commented Dec 28, 2017

Many classes and interfaces don't have docblocks. A developer and the IDE is not able to know which data should returned. Best example is the TableGatewayInterface.

Can I send an PR for this?

@fadoe fadoe changed the title Add clear docblock to all methods Add clear docblock to all classes and interfaces Dec 28, 2017
@froschdesign
Copy link
Member

@fadoe
That would be great!

@fadoe
Copy link
Author

fadoe commented Dec 28, 2017

I created a PR, but it is not completed now. I have for example a question about the StatementContainerInterface. Where is the best place for this questions? This issue or the pull request?

@fadoe
Copy link
Author

fadoe commented Dec 29, 2017

I have a question to the DriverFeatureInterface.

The addFeature in the interface describes the feature as mixed, in Driver\Pdo\Pdo as AbstractFeature. getFeature returns in Driver\Pdo\Pdo AbstractFeature or false (see docblock). Is this a difference between the interface and the extended Pdo class? I think in the DriverFeatureInterface should it also AbstractFeature.

@michalbundyra
Copy link
Member

This repository has been closed and moved to laminas/laminas-db; a new issue has been opened at laminas/laminas-db#58.

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

No branches or pull requests

3 participants