GitXplorerGitXplorer
e

header-generator

public
2 stars
1 forks
1 issues

Commits

List of commits on branch master.
Unverified
fd31284f170151916988fbb45677c7de55eaf810

Adding Recursive configuration search

committed 10 years ago
Unverified
b59e9c4ea279d1b555ec7231b01921ab9c189bc1

Prints current date using localtime

committed 10 years ago
Unverified
d8fd2b7e730b1ba89e50d154fab3703b5534cc0a

Bugfix: Fixed database update issue

committed 10 years ago
Unverified
ddb1dc827e898606f0bb1f117ee75587ca7c4fc0

Commit May 1 2014

committed 10 years ago
Unverified
56f155c33fd233f1ca857fd0d0078ce8cba8af82

Commit Apr 30 2014

committed 10 years ago
Unverified
74d26d39e0258761a0ff83ea4bd42c94569e45db

Alpha 0.1 Release:

committed 10 years ago

README

The README file for this repository.

Source Code Header Generator

Author: Evan Wilde etcwilde@uvic.ca Start Date: April 6 2014 Version: 0.1

=== Description ===

This program will apply user templates to create uniform header documentation for each source file specified. It uses the file extension to map to a given template file, so it can support any language.

=== Program Usage ===

usage: license.py [-h] [-u USERNAME] [-e EMAIL] [-t TEMPLATE_DIR] [--version] files [files ...] -h: Help -u: Specify a username for the copyright. This will require an email be passed as well. -e: Specify an email address for the user -t: Specify a directory containing the template files. --version: prints the version of the program

files: The list of files that need to have a header appended to them.

=== Template Keywords ===

Template Keyword Definitions:

TYPE Defines the type of file that this template header applies to. This is case sensitive, so "C" and "c" are different file types.

---START Defines the start of the template that will be written to the source file.

---END Defines the end of the template that will be written to the source file.

The name of the file with the file extensions. The full file path to the file, with file extensions. The name of the file without file extensions. The name of the user who created the file. The email of the user who created the file. The date the file was modified. If the file has never been modified, this is the creation date. Where the include statements will be placed, relative to the header

INCTYPE How external libraries are included in a source file. e.g. for java it is "INCTYPE:import"

=== Template samples ===

This example template is for "java" files.

AUTH:Evan Wilde DATE:April 6 2014 TYPE:java INCTYPE:import

---START /*

  • File:
  • Auth:
  • Date: */ ---END

This example template is for ".c", ".cpp", ".C", and ".h" files.

AUTH:Evan Wilde DATE:April 6 2014 INCTYPE:#include TYPE:c TYPE:cpp TYPE:C TYPE:h

---START /** * * File: * Auth: * Date: */ ---END