Browse Source

Apply suggestions from code review

Co-authored-by: Willow Hayward <[email protected]>
Signed-off-by: chanmosq <[email protected]>
chanmosq 2 years ago
parent
commit
2bfe8a8f22
2 changed files with 9 additions and 9 deletions
  1. 7 7
      tools/o3de-doxygen/README.md
  2. 2 2
      tools/o3de-doxygen/core-api-doxygen.config

+ 7 - 7
tools/o3de-doxygen/README.md

@@ -79,13 +79,13 @@ The C++ API reference generation scripts runs Doxygen on your local `o3de` clone
 
 ### Prepare scripts
 
-1. In `config.sh` set the following variables:
+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)
 
    - `O3DEORG_PATH`: Path to your local o3de.org clone (e.g. $HOME/o3de.org)
 
-    The C++ API reference generation scripts read from `o3de` and write to `o3de.org`. 
+    The C++ API reference generation scripts read from `O3DE_PATH` and write to `O3DEORG_PATH`. 
 
 1. If this is your first time running the script, you may need to enable permissions to execute the program. In the `o3de-doxygen` directory, run the following: 
 
@@ -106,7 +106,7 @@ In the `o3de-doxygen` directory, run the script:
 ./o3de-framework-apis.sh
 ```
 
-This generates the following files in `o3de.org`: 
+This generates the following files in `O3DEORG_PATH`: 
  - `content/docs/api/frameworks/_index.md`
  - `static/docs/api/frameworks/*`
 
@@ -120,7 +120,7 @@ In the `o3de-doxygen` directory, run the script:
 ./o3de-gem-apis.sh
 ```
 
-This generates the following files in `o3de.org`: 
+This generates the following files in `O3DEORG_PATH`: 
   - `content/docs/api/gems/_index.md`
   - `static/docs/api/gems/*`
 
@@ -152,13 +152,13 @@ To generate API References for Gems outside of `o3de`:
 
 ## Customizing the API's main page
 
-The main page is the first page you see when you open a framework or Gem's Doxygen-generated API reference. For example, open any [framework](https://www.o3de.org/docs/api/frameworks/) or [Gem](https://www.o3de.org/docs/api/gems/) in the API docs. The contents of the main page is either automatically generated, or specified by the developer by using the Doxygen command, [/mainpage](https://doxygen.nl/manual/commands.html#cmdmainpage), in the code's comments.
+The main page is the first page you see when you open a framework or Gem's Doxygen-generated API reference. For example, open any [framework](https://www.o3de.org/docs/api/frameworks/) or [Gem](https://www.o3de.org/docs/api/gems/) in the API docs. The contents of the main page is either automatically generated, or specified by the developer by using the Doxygen command, [\mainpage](https://doxygen.nl/manual/commands.html#cmdmainpage), in the code's comments.
 
-By default, if `/mainpage` is not specified, an API's main page includes a brief introduction and a table of contents, like the following: 
+By default, if `\mainpage` is not specified, an API's main page includes a brief introduction and a table of contents, like the following: 
 
 ![Default mainpage example](files/default-mainpage-example.png)
 
-If a developer documents the API using `/mainpage`, it will replace the default introduction. However, you may still insert the table of contents by adding `o3de-doxygen-insert-table` to your `/mainpage` comment block. For example, this comment block in the AQtComponents's source code generates the following main page. 
+If a developer documents the API using `/mainpage`, it will replace the default introduction. However, you may still insert the table of contents by adding `o3de-doxygen-insert-table` to your `/mainpage` comment block. For example, this comment block in the AzQtComponents's source code generates the following main page. 
 
 ```
 /**

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

@@ -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        = C:\Users\stramer\src\lyengine\
+STRIP_FROM_PATH        = 
 
 # 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                  = X:\o3de\Code\Framework
+INPUT                  = 
 
 # 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