Opened 16 years ago
Closed 16 years ago
#5233 closed enhancement (fixed)
update.php documentation
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 2.5 | Priority: | normal |
Severity: | normal | Version: | 2.5 |
Component: | Optimization | Keywords: | phpdoc documentation has-patch |
Focuses: | 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 (2)
Change History (7)
#1
@
16 years ago
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.
Note: See
TracTickets for help on using
tickets.
update.php documentation which adds phpdoc