Improve developer documentation #2732
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 14 commits
August 13, 2018 15:34
I don't think this changes the output, it just makes the source easier to read
Also added a lot of \refs and merged in the small amount of documentation that was already there.
Also started using \section, \subsection etc instead of #, ## and ###
Two functional differences: * you can now link to these sections * on the website the sections and subsections appear in the hierarchy and can be viewed on their own
owen-mc-diffblue
requested review from
chrisr-diffblue,
kroening,
pkesseli,
smowton and
tautschnig
as code owners
owen-mc-diffblue
deleted the
owen-jones-diffblue/document-documentation
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR does more than one thing - my apologies. The main thrust is editing the developer documentation so that it links to module-level documentation where possible. This left many pages with very little content in them, so I have combined them in one page, called Code Walkthrough. I also fixed up some of the documentation while moving it around.
Reminder of how to compile the doxygen: in
srcrundoxygen. Then open 'doc/html/index.html'.