Opened 7 years ago

Closed 5 years ago

#6716 closed enhancement (wontfix)

specify [out] for output parms with doxygen

Reported by: Kurt Schwehr Owned by: Kurt Schwehr
Priority: lowest Milestone: closed_because_of_github_migration
Component: default Version: unspecified
Severity: minor Keywords:
Cc:

Description

In the would be nice some day catagory.

https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdparam

/*!
 * Copies bytes from a source memory area to a destination memory area,
 * where both areas may not overlap.
 * @param[out] dest The memory area to copy to.
 * @param[in]  src  The memory area to copy from.
 * @param[in]  n    The number of bytes to copy
 */
void memcpy(void *dest, const void *src, size_t n);

Change History (3)

comment:1 by Even Rouault, 7 years ago

In 36141:

Doxygen: experiment with [in] [in,out] tags (refs #6716)

comment:2 by Even Rouault, 7 years ago

I've done a little experiment above. I think we should only tag non-obvious/ambiguous parameters, ie pointers or C++ reference types. For straight int, double, etc, it is obvious that it is [in]

comment:3 by Even Rouault, 5 years ago

Milestone: closed_because_of_github_migration
Resolution: wontfix
Status: newclosed

This ticket has been automatically closed because Trac is no longer used for GDAL bug tracking, since the project has migrated to GitHub. If you believe this ticket is still valid, you may file it to https://github.com/OSGeo/gdal/issues if it is not already reported there.

Note: See TracTickets for help on using tickets.