Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add more Doxygen information to Developer Notes #14832

Merged
merged 1 commit into from Jan 4, 2019

Conversation

Projects
None yet
3 participants
@ch4ot1c
Copy link
Contributor

commented Nov 28, 2018

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.

@ch4ot1c

This comment has been minimized.

Copy link
Contributor Author

commented Nov 28, 2018

Also, make docs could be made to fail immediately if those dependencies are missing.

@fanquake fanquake added the Docs label Nov 29, 2018

Show resolved Hide resolved doc/developer-notes.md Outdated
Show resolved Hide resolved doc/developer-notes.md Outdated

@ch4ot1c ch4ot1c force-pushed the ch4ot1c:improvement/doxygen-docs branch to a62e667 Nov 29, 2018

@fanquake

This comment has been minimized.

Copy link
Member

commented Jan 4, 2019

utACK a62e667 This seems like an improvement.

screen shot 2019-01-04 at 6 46 32 pm

MarcoFalke added a commit to MarcoFalke/bitcoin that referenced this pull request Jan 4, 2019

Merge bitcoin#14832: docs: Add more Doxygen information to Developer …
…Notes

a62e667 docs: Add more Doxygen information to Developer Notes (Jon Layton)

Pull request description:

  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`.

Tree-SHA512: 5d77ee83e1b96fde036482b502f676a90a56f3f667753545a7cfba5c2e3b825644bb4cf0f8a84b7f9ba92fa5f2e1cd6ef1e27a94277f43d012355df741f7dd2f

@MarcoFalke MarcoFalke merged commit a62e667 into bitcoin:master Jan 4, 2019

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.