#418 closed enhancement (fixed)
some psMetadata* need better parameter documentation
| Reported by: | jhoblitt | Owned by: | |
|---|---|---|---|
| Priority: | normal | Milestone: | |
| Component: | docs | Version: | unspecified |
| Severity: | minor | Keywords: | |
| Cc: |
Description
I've come across several psMetadata* functions, notably psMetadataAdd(), that
don't document the fact that the location parameter can accept the PS_LIST_*
value. I'm concerned that this maybe confusion to end users new to psLib.
Eg. Some say (good):
location index number, PS_LIST_HEAD, or PS_LIST_TAIL
Some say (psMetadataAdd):
location Location to be added.
Perhaps a discussion of this feature can be added to the top of the doxygen page?
Change History (5)
comment:1 by , 21 years ago
comment:2 by , 21 years ago
| Owner: | changed from to |
|---|
comment:3 by , 21 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
I have made the documentation for the function arguments more consistent.
Note:
See TracTickets
for help on using tickets.
Please excuse the grammar in that comment...