Updated README, add script cleanup step, added comments

Signed-off-by: chanmosq <[email protected]>

tools/o3de-doxygen/README.md

@@ -81,9 +81,11 @@ The C++ API reference generation scripts run Doxygen on your local `o3de` clone.
 
 1. Edit `config.sh` in the `o3de-doxygen` directory and set the following variables:
 
-   - `O3DE_PATH`: Path to your local o3de clone  (e.g. $HOME/o3de)
+   - `O3DE_PATH`: Path to your local o3de clone  (e.g. `O3DE_PATH=$HOME/o3de`)
 
-   - `O3DEORG_PATH`: Path to your local o3de.org clone (e.g. $HOME/o3de.org)
+   - `O3DEORG_PATH`: Path to your local o3de.org clone (e.g. `O3DEORG_PATH=$HOME/o3de.org`)
+   
+   - `PROJECT_NUMBER`: The O3DE version that of this API reference  (e.g. `PROJECT_NUMBER=23.05.0`)
 
     The C++ API reference generation scripts read from `O3DE_PATH` and write to `O3DEORG_PATH`. 
 

tools/o3de-doxygen/config.sh

@@ -5,3 +5,6 @@ O3DE_PATH=
 
 # Path to user's local o3de.org repository (e.g. $HOME/o3de.org)
 O3DEORG_PATH=
+
+# O3DE version number, passed to Doxygen configuration
+PROJECT_NUMBER=

tools/o3de-doxygen/core-api-doxygen.config

@@ -32,13 +32,13 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "Open 3D Engine Frameworks API Reference"
+PROJECT_NAME           =  # Handled by script, o3de-doxygen tool
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "2305.0"
+PROJECT_NUMBER         =  # Handled by script, o3de-doxygen tool
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -58,7 +58,7 @@ PROJECT_LOGO           = "logo-placeholder-text"
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = ./build
+OUTPUT_DIRECTORY       =  # Handled by script, o3de-doxygen tool
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
@@ -170,7 +170,7 @@ FULL_PATH_NAMES        = YES
 # will be relative from the directory where doxygen is started.
 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
 
-STRIP_FROM_PATH        = 
+STRIP_FROM_PATH        =  # Handled by script, o3de-doxygen tool
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
 # path mentioned in the documentation of a class, which tells the reader which
@@ -825,7 +825,7 @@ WARN_LOGFILE           = doxygen-err.log
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = 
+INPUT                  =  # Handled by script, o3de-doxygen tool
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1139,7 +1139,7 @@ GENERATE_HTML          = YES
 # The default directory is: html.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_OUTPUT            = ./build/html
+HTML_OUTPUT            =  # Handled by script, o3de-doxygen tool
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 # generated HTML page (for example: .htm, .php, .asp).

tools/o3de-doxygen/o3de-framework-apis.sh

@@ -58,6 +58,7 @@ for framework_path in `ls -1d ${FRAMEWORKS}/*/ `; do
 
     cat $main_config >> $config_file
     echo PROJECT_NAME=\"Open 3D Engine ${framework} API Reference\" >> $config_file
+    echo PROJECT_NUMBER=${PROJECT_NUMBER} >> $config_file
     echo OUTPUT_DIRECTORY=${OUTPUT_DIRECTORY} >> $config_file
     echo INPUT=${framework_path} ${index} >> $config_file
     echo HTML_OUTPUT=${framework} >> $config_file
@@ -70,4 +71,5 @@ for framework_path in `ls -1d ${FRAMEWORKS}/*/ `; do
     
     generate_toc "${OUTPUT_DIRECTORY}/${framework}" "${framework}"
 
-done
+done
+

tools/o3de-doxygen/o3de-gem-apis.sh

@@ -57,6 +57,7 @@ for gem_path in `ls -1d ${GEMS}/*/`; do
 
     cat $main_config >> $config_file
     echo PROJECT_NAME=\"Open 3D Engine ${gem} Gem API Reference\" >> $config_file
+    echo PROJECT_NUMBER=${PROJECT_NUMBER} >> $config_file
     echo OUTPUT_DIRECTORY=${OUTPUT_DIRECTORY} >> $config_file
     echo INPUT=$(fd -t d -X echo {} \; -- Include ${gem_path}) $index >> $config_file
     echo HTML_OUTPUT=${gem} >> $config_file
@@ -71,4 +72,7 @@ for gem_path in `ls -1d ${GEMS}/*/`; do
     API_PATH=build/gems/${gem}
     API_NAME=${gem}
     generate_toc "${OUTPUT_DIRECTORY}/${gem}" "${gem}"
-done
+done
+
+## cleanup
+rm ${index}