Download Latest Version V0.3.1-run.tar.xz (10.2 MB)
Email in envelope

Get an email when there's a new version of Document

Home
Name Modified Size InfoDownloads / Week
Version 0.3 2016-06-30
Version 0.2 2016-06-27
Version 0.1 2016-06-23
README.md 2016-06-26 1.3 kB
Totals: 4 Items   1.3 kB 0

Document-

A program to help you document your source code cleanly and efficiently.

The program has accomplished the following:

Create GUI; Choose input file; Choose output directory; Read source code; Determine the type of source code it's dealing with; Specify comments to look out for in the file; Print only the comments; Look out for shebangs; Use the shebangs to determine what to write out to file; Write out to file; Neatly organise the type of shebangs into main headings; Be able to document entire snippets of code, not just one line; Add more shebang types like date, author, and references.

Version 0.1 of my project is done. It is now full functioning.

Version 0.2 of my project is done. it is now full functioning. However, version 0.3 needs to accomplish the following:

Be able to handle exceptions like file not found errors and write out errors; Be able to catch out errors in the documentation, such as shebangs where they are not supposed to be; ensure shebangs are complete before doing the documentation

Version 0.4 needs to accomplish the following:

Support nested shebangs Remove comments and indent commments Support more source code Allow documentation in HTML

Version 0.5 needs to accomplish the following:

Show license Include internal documentation

Source: README.md, updated 2016-06-26