To develop an analyzing routine at least for python and java that will find all documentation strings in a file, parse them into specific groups and check them against a specified documentation style given by the user. The functionality can be extended so that the analyzing routine provides a patch that re-formats the documentation correctly, checks for grammatical errors (eg: checking parameter’s description for imperative present tense) and perform other aesthetical fixes (i.e capitalization, sentence termination with a period).

Organization

Student

Saurav Singh

Mentors

  • SanketDG
  • Niklas Meinzer
close

2017