cheng/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document that 3rd person verb forms should be used in the manual

Browse Source 
See https://github.com/wxWidgets/wxWidgets/pull/1473
This commit is contained in:
Vadim Zeitlin 2019-08-20 17:16:53 +02:00
parent fbe651731c
commit 72272f5901
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/contributing/how-to-add-class-documentation.md
View File

@ -58,6 +58,10 @@ Important Dos and Don'ts
DO: DO:
- use present tense verbs in 3rd person singular form to describe functions,
i.e. write "Returns the answer to life, universe and everything", rather than
the imperative mood used in Git commit message ("Return the answer ...").
- Doxygen supports both commands in the form \command and @command; - Doxygen supports both commands in the form \command and @command;
all wxWidgets documentation uses the @command form. all wxWidgets documentation uses the @command form.
Follow strictly this rule. Follow strictly this rule.