Skip to content

arnabsinha4u/in-line-code-documentation-demo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

In-line code documentation demo for DevOps Days Amsterdam, 2017

Slideshare Link:

https://www.slideshare.net/ArnabSinha36/inline-code-documentation

This repository has 4 branches:

  • master - Baseline for the demo
  • documentation_improvement_1
    • Documentation improved in only one Javascript (fibonacci_generic.js) thus partial improvement in Documentation coverage and maturity status
    • Build breaks due to non-compliance of Documentation vs Code ratio
  • documentation_improvement_2
    • Documentation improved in two more Javascripts (fibonacci_recursive.js & tower_of_hanoi_generic.js) thus improvement reported in Documentation coverage and maturity status
    • Build still breaks due to non-compliance of Documentation vs Code ratio
  • documentation_improvement_3
    • Documentation improved further one final Javascript (tower_of_hanoi_recursive.js) which is reflected in the Documentation coverage as complete and high maturity status
    • Build also passes as Documentation vs Code ratio is achieved

Documentation Status

Inline docs

Build Status - Build Breaker based on Documentation vs Code ratio

Build Status