mirror/oot
1
0
Fork 0
mirror of https://github.com/zeldaret/oot.git synced 2025-07-16 12:54:40 +00:00
Code Issues Projects Releases Wiki Activity

Whitespace (#1112)

Browse source 
* remove trailing whitespaces

* minor docs tweaks

* some more trailing whitespaces

* few more tweaks
This commit is contained in:
playerskel 2022-01-24 00:09:02 +01:00 • committed by GitHub
parent f344fe648b
commit f4a72303cb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
150 changed files with 493 additions and 494 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/Documenting.md
View file

@ -4,9 +4,9 @@
This project uses [Doxygen](https://www.doxygen.nl/index.html) to generate documentation pages from comments found in the source files. This guide focuses on writing compatible comments and ensuring consistency across the codebase.
```diff
- Note -
As the codebase is constantly changing, only document what is complete, well-understood and not
As the codebase is constantly changing, only document what is complete, well-understood and not
already covered by good naming. This is especially true for function parameters and return values.
Also note that there is no obligation to completing the documentation steps for functions you
Also note that there is no obligation to completing the documentation steps for functions you
work on if you do not want to at the time.
```
To generate a doxygen manual for the project, ensure you have doxygen installed and then cd into the project root directory and run `doxygen Doxyfile`.
@ -97,4 +97,4 @@ For centered rendering on a separate line:
/**
* \f[ \textrm{Your LaTeX Here} \f]
*/
```
```