nagbalae/dunst
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: internal: Add note about the way tests are being compiled

Browse Source
This commit is contained in:
fwsmit 2021-04-15 18:35:37 +02:00
parent c4e428e9d5
commit 75af42c83a
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
HACKING.md
View File

@ -15,6 +15,10 @@
- Add the comments to the prototype. Doxygen will merge the protoype and implementation documentation anyways. - Add the comments to the prototype. Doxygen will merge the protoype and implementation documentation anyways.
Except for **static** methods, add the documentation header to the implementation and *not to the prototype*. Except for **static** methods, add the documentation header to the implementation and *not to the prototype*.
- Member documentation should happen with `/**<` and should span to the right side of the member - Member documentation should happen with `/**<` and should span to the right side of the member
- Test files that have the same name as a file in src/\* can include the
associated .c file. This is because they are being compiled INSTEAD of the src
file.
## Log messages ## Log messages