There are some @todo docblocks in the config system that have yet to be filled in.
| Comment | File | Size | Author |
|---|---|---|---|
| #1 | 1516472-1.config-api-doc.patch | 12.29 KB | ksenzee |
There are some @todo docblocks in the config system that have yet to be filled in.
| Comment | File | Size | Author |
|---|---|---|---|
| #1 | 1516472-1.config-api-doc.patch | 12.29 KB | ksenzee |
Comments
Comment #1
ksenzeeI guess this should probably be filed under documentation.
Comment #2
jhodgdonThis looks great! A couple of things I wasn't sure of or that need to be fixed:
a)
Should it be more specific about which exception(s) it throws? There are a couple of other @throws Exception lines too... Maybe at least put in a @todo that says "figure out which specific exceptions can be thrown"?
b)
Function name needs () after it in @see to turn into a link.
Comment #3
jhodgdonFixing these two items would be a good Novice project... maybe we can get this done?
Comment #4
sunNot particularly novice, I think. AFAICS, most of the changes in #1 should be obsolete or done by now already.
I'd suggest to leave this issue open, but postpone it to later, since the config system is still undergoing massive changes.
Comment #5
jhodgdonThese particular ToDo items have all vanished. I don't see any docs ToDos in the Config system right now. Closing this issue.