Recent changes to feature-requests

Documentation files are duplicated

Henrik Arro — Sat, 18 Oct 2008 21:24:09 -0000

The documentation files used to be stored only as html in the docs directory, but to make the Mave site target work smoothly, I had to make a duplicate in src/site/apt/docs. I think we should make the src/site/apt/docs files the master, and generate the html documentation to use in the delivery zip file from the APT files.

Update license agreement

Henrik Arro — Mon, 18 Aug 2008 19:13:17 -0000

The JSeq license agreement should be updated to LGPL. A copyright notice should be included in all relevant files.

Increase test coverage

Henrik Arro — Mon, 18 Aug 2008 18:01:51 -0000

When building JSeq with Maven, e.g., with the command "mvn site", we see in the Cobertura report that only about 42% of the code is run through by the unit tests.

Test code coverage should be increased to at least 85%.

Remove Checkstyle and PMD warnings

Henrik Arro — Mon, 18 Aug 2008 17:59:24 -0000

When building JSeq using Maven, e.g., with the command "mvn site", we see that there are a whole lot of Checkstyle errors, and some PMD warnings.

The code should be improved to remove these warnings.

Add support for building with Maven 2

Henrik Arro — Sun, 17 Aug 2008 14:03:28 -0000

We should add support for building JSeq using Maven 2. There are several reasons for this:

- It makes it easy to run and generate reports for tools such as CheckStyle, Cobertura, PMD, etc.

- It can be used to create a project site, which can be uploaded to jseq.sourceforge.net.

- Since I will probably be using Maven 2 in an upcoming project, I need the practice. :-)

Add an -include argument

Henrik Arro — Sun, 17 Aug 2008 10:04:51 -0000

We should add an -include command-line argument to JSeq which allows us to create a diagram containing only the specified classes.

The semantics should be as follows:

- Simple wildcards are allowed, with a * at the beginning or the end. For example, "foo.bar.*", *.MyTest".

- If several -include arguments are given, the union of all matched classes shall be traced. For example, "-include foo.bar.* -include foo.baz.*" will include all classes in foo.bar and foo.baz.

- If -include is used together with -exclude, it should be taken to mean that all classes that match -include are traced, except the ones matching -exclude. For example "-include foo.bar.* -exclude foo.bar.MyTest" will include all classes in foo.bar except MyTest.

There should be a start script for Linux

Henrik Arro — Fri, 15 Aug 2008 18:35:58 -0000

Currently, the JSeq bin directory only contains a jseq.bat file for Windows. There should also be a start script that can be used in Linux / *nix.

It should be easy to call JSeq from another program

Henrik Arro — Mon, 11 Aug 2008 13:54:54 -0000

The only way right now to use JSeq to create a sequence diagram from another program i to call Main.main with a number of command-line arguments. The diagram is always written to a file.

We should make it easier to JSeq from another program, by providing set methods for all command-line arguments, and by making it possible to return the diagram as an object, not only through files.

JSeq should use a logging framework

Henrik Arro — Mon, 11 Aug 2008 13:42:09 -0000

Currently, all logging in JSeq is done using System.out and System.err. This is not very flexible, and it causes problems if someone wants to use JSeq embedded in another program.

We should switch to use a real logging framework. For flexibility, it may be a good idea to use Commons Logging -- it is then easy to use different underlying logging packages.

To reduce the number of dependencies on other packages, the default implementation should probably use java.util.logging as log implementation.

Killing JSeq should still generate a diagram

Henrik Arro — Wed, 06 Aug 2008 21:21:31 -0000

It should be possible to generate diagrams for part of the execution of long-running processes.

This can be very useful when working with web applications, for example, where we want to create a sequence diagram that shows how a certain request is handled.

Currently, this can be done by attaching to the long-running process, but then that process must be killed for JSeq to generate a diagram. If JSeq is killed with Ctrl-C, no diagram is generated.

I think that JSeq should generate a diagram even when it is interrupted with Ctrl-C.