Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Papyrus/Papyrus Developer Guide"
(→Papyrus Code Standards) |
m (→Papyrus Code Standards) |
||
Line 30: | Line 30: | ||
== Papyrus Code Standards == | == Papyrus Code Standards == | ||
* Java Doc - every method and field including private ones should be documented with Java Doc | * Java Doc - every method and field including private ones should be documented with Java Doc | ||
− | * No | + | * No abbreviations - the methods and variables should have full names |
− | * Formatting - the code | + | * Formatting - the code should be formatted iun accordance with format templates |
− | * Compile - the | + | * Compile - the modified code and other plugins should be compilable. Check other plugins that could be incluenced before commiting! |
== Papyrus Log == | == Papyrus Log == |
Revision as of 08:58, 25 May 2010
Contents
Development Environment
To ease the development on Papyrus, each member of the team works with basically the same configuration :
- [1] Eclipse Modelling 3.6M5 . GMF needs to be install on top of this release.
- [2] ANTLR 3.0.0. Download this plug-in and put it into the dropins folder.
- [3] SVN Subversive (or Subclipse)
- [4] CheckStyle
- [5] JAutoDoc
Development Plan
Specifications
The specifications are available here : http://wiki.eclipse.org/Papyrus_Developer_Guide/Specifications
Getting the code
Connecting to the svn
The code is available under svn at this location http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/
Retrieve code
PSF Files can be found here (in the plugin org.eclipse.mdt.papyrus.releng under the folder psf).
Check out this project, and import the "Papyrus-ALL-pserver.psf".
Retrieve configuration files
The Papyrus Code Templates and Java Formatter files are available under the Papyrus repository in the plugin org.eclipse.papyrus.doc under the folder "templates"
FAQ How do I control the Java formatter
FAQ How can templates make me the fastest coder ever
Checkstyle : available soon
A note is also available to explain how to install the templates in your environment.
Papyrus Generation
- Papyrus generation mechanism is explained here : Papyrus Developer Guide/Papyrus diagram generation
Papyrus Code Standards
- Java Doc - every method and field including private ones should be documented with Java Doc
- No abbreviations - the methods and variables should have full names
- Formatting - the code should be formatted iun accordance with format templates
- Compile - the modified code and other plugins should be compilable. Check other plugins that could be incluenced before commiting!
Papyrus Log
- Papyrus Log is explained here Papyrus Developer Guide/Papyrus Log
Papyrus Build Process
- Papyrus build process on Athena is explained here Papyrus Developer Guide/Build Process