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

PHP Documentation #14

Open
jakerella opened this issue Jan 7, 2013 · 3 comments
Open

PHP Documentation #14

jakerella opened this issue Jan 7, 2013 · 3 comments

Comments

@jakerella
Copy link

Adding standard PHPdoc method comments will help with some IDEs and their ability to autocomplete code. Adding it here as an enhancement opportunity.

Example:

/**
 * Looks up an HTTP status code (by the code number) and gives back a textual description
 * @param string $lookUpCide string The HTTP status code to look up
 * @return string A string representation (with status code) of the response status
 */
public function lookupHttpCode($lookUpCode = "")
{ ... }
@jwoodcock
Copy link
Owner

This would be great to add. Are you offering to write these or just making a recommendation?

@jakerella
Copy link
Author

:) Well... it's an open enhancement suggestion - for anyone who wants to take it. I may try to later this week, I'll let you know. Also, doesn't look like I can label issues, so you may want to slap that on here.

@jwoodcock
Copy link
Owner

I might take a stab as well if I have time open up for it. Just because I've not really done the PHPdoc stuff. If not, feel free to do it, or whom ever wants to.

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

No branches or pull requests

2 participants