Update information about Doxygen in doc/developer-notes.md.
Alternatively, this could have its own file (like doc/web-documentation.md), since there are installation steps included.
For example, I had to run:
brew install doxygen graphviz
on MacOS, otherwise failures occurred.
This information could also be linked to the doc/release-process.md.
Also, make docs could be made to fail immediately if those dependencies are missing.
180 | @@ -174,15 +181,15 @@ Not OK (used plenty in the current source, but not picked up): 181 | // 182 | ``` 183 | 184 | -A full list of comment syntaxes picked up by doxygen can be found at http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html, 185 | -but if possible use one of the above styles. 186 | - 187 | -Documentation can be generated with `make docs` and cleaned up with `make clean-docs`. 188 | +A full list of comment syntaxes picked up by Doxygen can be found at http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html,
Can be https
193 | +Documentation can be generated with `make docs` and cleaned up with `make clean-docs`. The resulting files are located in `doc/doxygen/html`; open `index.html` to view the homepage. 194 | 195 | -Refer to [/test/functional/README.md#style-guidelines](/test/functional/README.md#style-guidelines). 196 | +Before running `make docs`, you will need to install dependencies `doxygen` and `dot`. For example, on MacOS via Homebrew: 197 | +``` 198 | +brew install doxygen graphviz
This could be brew install doxygen --with-graphviz
utACK a62e667 This seems like an improvement.
<img width="922" alt="screen shot 2019-01-04 at 6 46 32 pm" src="https://user-images.githubusercontent.com/863730/50684595-160f2f00-1051-11e9-9e37-9b5a2b709286.png">