Skip to content

Commit

Permalink
Add some documentation about generating the doxygen documentation (#1496
Browse files Browse the repository at this point in the history
)

* Add some documentation about generating the doxygen documentation

* Trying this

* Restyled by prettier-markdown

Co-authored-by: Justin Wood <[email protected]>
Co-authored-by: Restyled.io <[email protected]>
  • Loading branch information
3 people authored Jul 9, 2020
1 parent efa630b commit dd62545
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .restyled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ request_review: none
# Patterns to exclude from all Restylers
exclude:
- ".github/workflows/**/*" # https://github.com/restyled-io/restyler/issues/73
- ".github/workflows/*" # https://github.com/restyled-io/restyler/issues/73
- ".github/**/*" # https://github.com/restyled-io/restyler/issues/73
- ".github/*" # https://github.com/restyled-io/restyler/issues/73
- "third_party/**/*"
- "third_party/**"
- "third_party/*"
Expand Down
26 changes: 25 additions & 1 deletion docs/BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ make pretty

- [x] **Build documentation distribution from code headers**

To build the documentation bundle using doxygen, run the following:
To build the documentation bundle using Doxygen, run the following:

```
make docdist
Expand Down Expand Up @@ -275,6 +275,30 @@ export ANDROID_NDK_HOME=~/Library/Android/sdk/ndk/21.0.6113669
make -f Makefile-Android
```

### Generate the documentation

The Doxygen documentation is generated automatically if Doxygen is detected on
the system. The generated documentation can be found into
`${top_builddir}/docs/html` where `${top_builddir}` varies depending on how the
project was built.

#### How to install Doxygen on Linux

On Debian-based Linux distributions such as Ubuntu, Doxygen can be installed
with the following:

```
sudo apt-get install doxygen
```

#### How to install Doxygen on macOS

On macOS, Doxygen can be installed and satisfied using [Brew](https://brew.sh/):

```
brew install doxygen
```

## Maintaining CHIP

If you want to maintain, enhance, extend, or otherwise modify CHIP, it is likely
Expand Down

0 comments on commit dd62545

Please sign in to comment.