Ticket #5233 (closed enhancement: fixed)
update.php documentation
| Reported by: |
|
Owned by: |
|
|---|---|---|---|
| Priority: | normal | Milestone: | 2.5 |
| Component: | Optimization | Version: | 2.5 |
| Severity: | normal | Keywords: | phpdoc documentation has-patch |
| Cc: |
Description
I went ahead and documented update.php with the lone function. It was easy and should at least help move any additional functions forward for additional phpdoc documentation.
Attachments
Change History
darkdragon — 4 years ago
-
attachment
update.phpdoc.diff
added
I think that the documentation in the code should describe the purpose of the function and it's arguments and returns to enable it to be called.
Any extra information like how to disable a feature should not be in the documentation.
That kind of information is better stored in the codex.
comment:2
darkdragon — 4 years ago
Thanks. I'll remove it. The plugin is available in plain sight so yeah, it would be unbiased to remove that text. I'll clean up the rest of it and submit a new patch.
comment:3
darkdragon — 4 years ago
Finished with Westi suggestion and added patch.
- Owner changed from anonymous to westi
- Status changed from new to assigned

update.php documentation which adds phpdoc