Skip to content

Commit

Permalink
mention documentation in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tsche committed Feb 5, 2024
1 parent 438b9b4 commit 05ac014
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# doxygen-utils

This repository contains various useful helpers for doxygen.
This repository contains various useful helpers for doxygen. Please refer to the [documentation](https://tsche.github.io/doxygen-utils/) for examples and usage.

Currently there is various extensions for doxygen-awesome:
- [doxygen-awesome-alerts](docs/alerts.md) to support GitHub's alert markers (ie. [!WARNING])
Expand All @@ -10,6 +10,7 @@ Currently there is various extensions for doxygen-awesome:
There is also a hook to clean up dot output.
- [patch_dot](docs/dependency.md)


## License

These utilities are provided under the [MIT License](LICENSE). Feel free to use and modify it in your projects.
Expand Down

0 comments on commit 05ac014

Please sign in to comment.