Developer Documentation

These pages provide project archive and documentation for the design and implementation of the COMTOR system. Student work blogs maintain the details of students working on the system. Additionally, development tutorials are always under development.

Development Practices

 * Getting started with OKRs

Fall 2011

 * Kevin Coughlin (F'11)
 * Michael Glinski (F'11)
 * Michael Gruber (F'11)
 * John Lueck (F'11)

Spring 2012

 * Kevin Coughlin (S'12)
 * Michael Murphy (S'12)
 * Teddy Sudol (S'12)
 * Michael Glinski (S'12)

Spring 2012

 * Kevin Coughlin (F'12)

2006 - 2007 Academic Year

 * Fall 2006 - Joseph Brigandi, Development of a Framework for Automated Java Source Code Comment Analysis, [[Media:2006-Fall-Brigandi-J-498-PD.pdf | PDF file]]
 * Spring 2007 - Joseph Brigandi, Continued Development of a Framework for the Analysis of Java Source Code Comments, [[Media: 2007-Spring-Brigandi-J-499-PD.pdf | PDF file]]

2007 - 2008 Academic Year

 * Spring 2008 - Autumn Breese, Source Code Structure Analysis Module for COMTOR, [[Media:2008-Spring-Breese-A-498-PD.pdf | PDF file]]

2008 - 2009 Academic Year

 * Fall 2008 - Autumn Breese, Applying Natural Language Processing Techniques to the Analysis of Software Documentation, [[Media:2008-Fall-Breese-A-499-PD.pdf | PDF File]]
 * Fall 2008 - Ruth Dannenfelser, COMTOR: Evolving the User Interface of a Computer Science Educational Tool, [[Media:2008-Fall-Dannenfelser-R-498-PD.pdf | PDF file]]
 * Fall 2008 - Stephen Sigwart, Enhancing the Web Interface and Developing Modules for COMTOR: A Source Code Comment Analysis, [[Media:2008-Fall-Sigwart-S-498-PD.pdf | PDF file]]
 * Spring 2009 - Autumn Breese, Just Determining Readability Statistics of Software Documentation, [[Media:2009-Spring-Breese-A-499-PD.pdf | PDF file]]
 * Spring 2009 - Ruth Dannenfelser, Additional Enhancements for a Computer Science Educational Tool, [[Media:2009-Spring-Dannenfelser-R-499-PD.pdf | PDF file]]
 * Spring 2009 - Stephen Sigwart, Installing, Unit Testing, and Enhancing the Web Interface for COMTOR: A Source Code Comment Analysis System, [[Media:2009-Spring-Sigwart-S-499-PD.pdf | PDF file]]
 * Spring 2009 - Autumn Breese and Ruth Dannenfelser, COMTOR: A Source Code Comment Mentoring System (final report for Collaborative Research Experience for Undergraduates program), [[Media:2009-Spring-CREU-Report.pdf‎ | PDF file]]

2009 - 2010 Academic Year

 * Fall 2009 - Matthew Tom-Wolverton, Improved Installation and Upgrade System for COMTOR, [[Media:2009-Fall-TomWoverton-M-499-PD.pdf | PDF file]]
 * Spring 2010 - James Sant'Angelo, Reporting Enhancement and Development Resources for a Comment Mentoring System, [[Media:2010-Spring-SantAngelo-J-499-PD.pdf | PDF file]]

2010 - 2011 Academic Year
No student research performed

2011 - 2012 Academic Year
(Coming soon...)

COMTOR Beginners Tutorial

 * Student Beginner Tutorial - How to start using the web application, signing up registering for a class and submitting work.

COMTOR Analysis Modules

 * How Analysis Modules Work - If you are just getting started on the project, specifically learning how the system is built or are starting to work on your own analysis modules, this is the place to start
 * Writing Your Own Module - Here we walk through the process of writing a new module step-by-step. The testing of your module will be explained in a separate page (to be created).

Executing the Stand-Alone Version

 * Executing COMTOR as a stand-alone application - A step-by-step guide to compiling the COMTOR stand-alone software and executing it on a local machine. The stand-alone client may utilize the web for resource files, but does not use a backend database for storage, nor does it output the results in an HTML format (as we do on the web version).

Design Documentation

 * The COMTOR Architecture -Trying to understand it all? Here's how it is all put together.
 * COMTOR Technologies - We're using popular, open source (or freely available) software to make COMTOR do its thing. This page contains a list as a starting point for the various products in use.

Development

 * Ubuntu Linux
 * Git source code control
 * Sourceforge project management
 * Apache
 * Apache Tomcat
 * Apache HTTP Server
 * Apache ANT
 * Java
 * Java SE
 * Java EE

Deployment

 * VMWare - we use the VMWare Fusion / Workstation software to host our development instances of Ubuntu Linux. We also use this to establish the images of the server to deploy on AWS (below)
 * Amazon Web Services (AWS) - Soon to be hosting COMTOR in the cloud!

Examples

 * Sample report as property list - A sample representation of a COMTOR analysis report (as a property list).