William/Senior-Design-Project_WMU-Sunseeker_Altium-Designer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added note about not putting anything into the /Documentation folder

Browse Source
This commit is contained in:
William Miceli
2021-01-30 17:05:46 -05:00
parent 138e4fd890
commit a8e929cb27
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
Meta/Documentation Guide.markdown
View File

@@ -22,13 +22,14 @@ You need to have installed the program from either the GitHub page or website, t
- Make sure that the `/Doxyfile` stays where it's at! It should be kept at the root directory (just to keep things simple)
- Make sure you use RELATIVE paths when changing configurations, or else when someone else tries running the `/Doxyfile`, they'll have to re-do all of them in order for it to start functioning again.
- **DO NOT** put any files into the `/Documentation` folder manually, as they **WILL BE DELETED** when doxygen is run.
## For Consistency
- Please make sure the internal names of files are using "camelCase"
- Please make sure the internal names ("tags") of files are using "camelCase"
- Example: for "@page documentationGuide Documentation Guide"
"documentationGuide" is the name used internally by doxygen.
"documentationGuide" is the name/tag used internally by doxygen.
"Documentation Guide" is what shows up on the output documentation.