From a8e929cb270a0b4ae18d1b5874a56378aa3c12eb Mon Sep 17 00:00:00 2001 From: William Miceli Date: Sat, 30 Jan 2021 17:05:46 -0500 Subject: [PATCH] Added note about not putting anything into the `/Documentation` folder --- Meta/Documentation Guide.markdown | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Meta/Documentation Guide.markdown b/Meta/Documentation Guide.markdown index a8a3a38..7e7c738 100644 --- a/Meta/Documentation Guide.markdown +++ b/Meta/Documentation Guide.markdown @@ -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.