Developers information

maven targets, profiles, variables

As the staticwiki site already uses staticwiki to generate its contents, some tricks have been applied to assure it all works.
To build the site, you have to use the following commands


mvn install
mvn -Dsite site

The first (install) will build all modules, including the staticwiki-site-plugin.
The second target disables the staticwiki-site-plugin as module, but enables it as library for the maven-site-plugin. This way, circular dependencies are avoided.

Coding style

In staticwiki we use a coding style which prefers easy reading above displaying a lot of information. Most of the features should be clear in the following piece of code.


@Annotation( param1 = "value1", param2 = "value2" )
public class Foo
{
int[] X = new int[] { 1, 3, 5, 6, 7, 87, 1213, 2 };

public void foo( int x, int y )
{
for ( int i = 0; i < x ; i++ )
{
y += ( y ^ 0x123 ) << 2;
}
do
{
try
{
if ( 0 < x && x < 10 )
{
while ( x != y )
{
x = f( x * 3 + 5 );
}
}
else
{
synchronized ( this )
{
switch ( e.getCode() )
{
//...
}
}
}
}
catch ( MyException e )
{}
finally
{
int[] arr = (int[]) g( y );
x = y >= 0 ? arr[ y ] : -1;
}
}
while ( true );
}
}

The code is written with the right margin at 120 characters and lines should not be longer than that if possible.
An indentation is 4 spaces, tabs should not be used.
Class, method and variable names should follow the standard java naming convention.