-
Notifications
You must be signed in to change notification settings - Fork 86
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
Add docblock to segment getter/setter methods #115
base: master
Are you sure you want to change the base?
Add docblock to segment getter/setter methods #115
Conversation
Thank you for your contribution! Much appreciated! For example,
/**
* Set Resource QuantityUnits (OBR.7)
*
* @param string|int|array|null $value
* @param int $position Defaults to 7
*
* @return bool
*
*/
public function setResourceQuantityUnits($value, int $position = 7): bool
Since these days the IDEs are powerful enough to show documentation of a method from its signature on-the-fly, we may do away with the static docs at some point. That's part of the reason these are not always updated. Just curious, can you please let me know which IDE do you use, and do you use the static docs for some reason? |
Yes, I can work to split these into smaller PRs. I usually use vim, and ALE gives it sufficient autocomplete and some method signature when I'm typing a method name, etc. Other people on our team use emacs, vscode, and probably more. But what t I've needed is when someone says that a certain date is in OBR.7, I don't have a way to find the corresponding method name for that field without going into the code. Having a reference that maps between SEG.# and method names will be helpful. |
That does make sense. Thank you for sharing. |
This adds docblock to all of the segment getter/setter methods, primarily so that pages like this include the field numbers that they use.
I used this sed script to generate them:
(Then did some extra touch ups after that)