Documenting only public methods

The interaction between classes provides often a good overview of the functionality. Add the 'public-only' parameter to the sequence diagram tag to trace only public method calls during the test execution and to add only the public methods to the generated sequence diagram.

Example

Given the class net.sf.jsequnit.example.SequenceSample containing a method onlyIncludePublicMethodCalls that consecutively calls public and private methods of:

  • net.sf.jsequnit.example.SequenceSample
  • net.sf.jsequnit.example.foo.Foo

where the JavaDoc of the method contains a sequence diagram tag with the public-only parameter: 

      @sequence.diagram
	    test=net.sf.jsequnit.example.SequenceSampleTest#testOnlyIncludePublicMethodCalls()
	    public-only

we get a sequence diagram containing the calls to the public methods SequenceSample.publicMethod and Foo.publicMethod but no references to the method calls SequenceSample.privateMethod and Foo.privateMethod.