Documentation

 

Home
Documentation
Download
Snapshots

 

bulletRead Me - Setup instructions

1.Download plugin (copyrightcomment.zip file) from Download page .
2.Unzip copyrightcomment.zip .
3.Copy plugin/net.sourceforge.sourcecopyright_x.x.x.jar to your eclipse's plugin folder.
4.Restart Eclipse.
5.Start using plugin. For more information refer "How to use" document from documentation page.

 

bulletPlugin Setup/Configuration  -Configure plugin and its preferences

1.Create your copyright file. Let say created copyright file with name "mycopyrights" under c:\
2.Copy copyright comment text to the file and save it.
Suppose we want to use following text as copy right comment

/*******************************************************************************
* All Right Reserved. Copyright (c) 2007 Rutvij Shah
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public
License v1.0 *
******************************************************************************/
You can use your copyright comment text and save this text to created file in our case c:\mycopyrights

3.Open your eclipse.
4.Open Window > Preferences ... > Copyright Comment
5.Select your copyright file by clicking browse button and selecting the file from location.
6.Click Apply.
7.Click Ok.

 

bulletUsing plugin - Plugin usecases.

With Copyright plugin developer can add copyright comment to their source files any stage of development life cycle.

There are several ways developer can add copyright comment .


1.Adding copyright comment to Java file Open file in Editor.

Right click on file in Editor. In Popup menu select " Copyright comment ". Save file. You can also add comment to java file without open it. For that open Window > Show View > Navigator.

In Navigator right click to the file and in popup menu select " Copyright " > "Comment ".


2.Adding copyright comment to other (non java) file.

open Window > Show View > Navigator. In Navigator right click to the file and in popup menu select " Copyright " > "Comment ".


3.Adding copyright to whole project/directory.

open Window > Show View > Navigator. In Navigator right click to the project/directory and in popup menu select " Copyright " > "Comment ". It will open dialog box to specify file extension to apply this comment.


It has 3 options :

1.All : Copyright comment will be added to all files within the project/directory regardless of their type.

2.Java : Copyright comment will be added to only java files within the project/directory.

3.Others : If developer want to specify other file extension. i.e developer want to add copyright comment to xml file only then he can mention "xml" extension. Note here user should not give ".xml" or "*.xml" or anything .He must give valid extension type only.


By using this option (3rd one) Within a click user can add copyright comment to whole project.
 

Home | Documentation | Download | Snapshots