search

fennb / phirehose

PHP interface to Twitter Streaming API
709 stars 189 forks source link

Why is Oauthphirehose labeled as internal? #104

Closed codedge closed 8 years ago

codedge commented 8 years ago

The class Oauthphirehose has @interal docblock. Nevertheless this is the class I normally need to extend, to pass in the consumerKey and consumerSecret, right?

DarrenCook commented 8 years ago

@internal is used for comments only of interest to developers modifying that code (rather than something to be exported to the public API docs). That javadoc tag is not labelling the class.

https://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.internal.pkg.html