mirrors/SDL
0
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2024-11-23 02:43:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

README-documentation-rules.md: Mention not listing types in param/returns docs.

Browse Source
This commit is contained in:
Ryan C. Gordon 2024-11-20 23:58:37 -05:00
parent fef001cb48
commit a0591ec4a3
No known key found for this signature in database
GPG Key ID: FA148B892AB48044
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/README-documentation-rules.md
View File

@ -242,6 +242,15 @@ wikiheaders will complain loudly if you don't do this, and exit with an
error message. error message.
## Don't repeat type names in `\param` and `\returns` sections.
Wikiheaders will explicitly mention the datatype for each parameter and the
return value, linking to the datatype's wikipage. Users reading the headers
can see the types in the function signature right below the documentation
comment. So don't mention the type a second time in the documentation if
possible. It looks cluttered and repetitive to do so.
## Code examples go in the wiki. ## Code examples go in the wiki.
We don't want the headers cluttered up with code examples. These live on the We don't want the headers cluttered up with code examples. These live on the