Overview

All developers currently use Eclipse 3.2.2 to develop this project.

If you want to help with QifCon, feel free to use any editor, however the project has been built with Eclipse and it would be easier to get support/help if you are also using Eclipse.

Also be aware that the GUI is based upon Eclipse RCP and you can only make modifications to the GUI with Eclipse.

You will need to download and install Eclipse SDK 3.2.2, if you don't already have it.

Setup

Eclipse Preferences

General -> Editors -> Text Editors

  • "Displayed Tab Width" is "2"

Java -> Code Style -> Code Templates

  • Comments -> Overriding Methods: change to
     /**
  * {@inheritDoc}
  */
  • Comments -> Types change to
     /**
  * ${todo} Class documentation.
  *
  * @author <a href="mailto:YOUR_EMAIL@ADDRESS.COM">YOUR NAME</a>
  * @version TODO
  */
  • "Comments -> File" change to
    /*
 * Copyright 2007 QifCon
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
  • Code Style -> Formatter click "Import" and select "eclipse-codestyle.xml" from the QifCon project root.

Additional Plugins

Eclipse-CS

Install the Eclipse Checkstyle plugin and configure it:

Create a new "Project Relative" Check Configuration named "QifCon", whose location is "/qifcon/checkstyle.xml".

There will be additional properties that are unresolved, click on the "Additional properties..." button, and then "Find unresolved properties".

There should be two unresolved properties, set their values to the following:

  • checkstyle.header.file = $workspace_loc /qifcon/checkstyle-header.txt
  • checkstyle.suppressions.file = $workspace_loc /qifcon/checkstyle-suppressions.xml

The Eclipse Checkstyle plugin is automatically setup and attached to the projects via Maven as part of the "mvn eclipse:eclipse" step. Nothing more needs to be done here.

AnyEdit

Install the AnyEdit plugin and configure it:

Auto - Convert

  • Enable "Convert tabs - spaces", and set "Default convert mode on save" to "Tabs to spaces".

Misc

  • "Tab width/number of spaces for tab" set to "2"
  • Enable "Replace all tabs (not only leading) while convert tabs to spaces action"