Code

Improve developer documentation#2732

Code

Merged

peterschrammel merged 14 commits intodiffblue:developdiffblue/cbmc:developfrom

owen-mc-diffblue:owen-jones-diffblue/document-documentationowen-mc-diffblue/cbmc:owen-jones-diffblue/document-documentationCopy head branch name to clipboard

Aug 21, 2018

Commits

Commits on Aug 13, 2018

• Describe the aim of the documentation marked as "For contributors"

  

  Owen

  committed
  dfcb7cd

  Copy full SHA for dfcb7cd

• Move "Tutorial" section to the right place

  

  Owen

  committed
  2ea73b8

  Copy full SHA for 2ea73b8

• Improve how a sentence reads

  

  Owen

  committed
  37128c0

  Copy full SHA for 37128c0

• Move two items out of list

  

  Owen

  committed
  2034faf

  Copy full SHA for 2034faf

• Add links to module level documentation

  

  Owen

  committed
  c423bb6

  Copy full SHA for c423bb6

Commits on Aug 14, 2018

• Fix "#" being converted to "::" in doxygen

  

  Owen Jones

  committed
  90e43d9

  Copy full SHA for 90e43d9

• Fix apostrophe

  

  Owen Jones

  committed
  3b74238

  Copy full SHA for 3b74238

• Add in empty lines after headings

  Show description for d924247
  

  Owen Jones

  committed
  d924247

  Copy full SHA for d924247

• Add references to class-level documentation

  

  Owen Jones

  committed
  3eee998

  Copy full SHA for 3eee998

• Add header for orphaned diagram

  

  Owen Jones

  committed
  147c5d9

  Copy full SHA for 147c5d9

• Move docs from guide to module-level docs

  Show description for 35e278e
  

  Owen Jones

  committed
  35e278e

  Copy full SHA for 35e278e

• Fix minor typos

  

  Owen Jones

  committed
  96dc0a3

  Copy full SHA for 96dc0a3

• Combined many pages of developer docs into one

  Show description for 124d012
  

  Owen Jones

  committed
  124d012

  Copy full SHA for 124d012

• Switch one file from ## to using sections

  Show description for 0695df6
  

  Owen Jones

  committed
  0695df6

  Copy full SHA for 0695df6