diff options
Diffstat (limited to 'docs/UseDoxygen.md')
| -rw-r--r-- | docs/UseDoxygen.md | 36 |
1 files changed, 0 insertions, 36 deletions
diff --git a/docs/UseDoxygen.md b/docs/UseDoxygen.md deleted file mode 100644 index 1b016c0ec..000000000 --- a/docs/UseDoxygen.md +++ /dev/null @@ -1,36 +0,0 @@ -# How to generate documentation from source code using doxygen - -## Install doxygen - -If you want to use doxygen to generate documentation on Ubuntu, please install packages - -``` -$ sudo apt install doxygen -``` - -## Generate documentation - -### Pre-defined configuration - -You can find pre-defined configuration at `infra/doxygen/Doxyfile` - -### Option 1: Use pre-defined configuration - -You can use pre-defined configuration directly at nnas's root path - -``` -<nnas-root-path>$ doxygen infra/doxygen/Doxyfile -``` - -Generated documentation html is in `doxygen/html` - -### Option 2: Use nnas command (recommand) - -You can use nnas command `doxygen` - -``` -$ <nnas-root-path>/nnas doxygen -``` - -Generated documentation html is in your workspace directory: `<NNAS_WORKSPACE>/doxygen/html` -Default workspace directory is `build` |