[rules-dev] Javadoc 6.0.0 Beta 3

[Wolfgang Laun]

(1)
org.kie.api.builder Interface Include

Invites the simple question: why is it here?

=*=*=
(2)
org.kie.api.builder Interface KieFileSystem

in memory => memory-resident

=*=*=
(3)
org.kie.api.builder Interface ReleaseId

 convetions => conventions

=*=*=
(4)
org.kie.api.builder.model Interface KieBaseModel

Here "package pattern" or "package (pattern)" occurs repeatedly.
"Pattern" according to which definition of "pattern"...?

=*=*=
(5)
org.kie.api.builder.model Interface KieSessionModel

(a)
ClockTypeOption getClockType()
    Returns the EqualityBehavior of this KieSessionModel
=>
    ... ClockTypeOption ...

(b)
KieSessionModel setClockType(ClockTypeOption clockType)
    Sets the EqualityBehavior for this KieSessionModel. Default is realtime
=>
    ... ClockTypeOption ...

(c)
and add it to
=>
and adds it to
(2 times)

=*=*=
(6)
org.kie.api.command Interface KieCommands

Typically more than one Command will want to be executed, where is where
the BatchExecution comes in, which takes a List of commands, think of it
as CompositeCommand.
 =>
The entire sentence ought to be rewritten without bloopers by someone
who knows what's going on.

=*=*=
(7)
org.kie.api.conf Enum EqualityBehaviorOption

public static final String PROPERTY_NAME

    The property name for the sequential mode option
=>
    The property name for the equality behavio(u)r option

=*=*=
(8)
org.kie.api.conf Enum EventProcessingOption

(a)
drools.eventProcessingMode = <identity|equality>
=>
  ??? (but certainly NOT identity, equality)

(b)
  reasoning over absence of events (NOT CE), automatically adds an
appropriate duration attribute to the rule in order to avoid early
rule firing.
 memory management techniques may be employed when an event no longer
can match other events due to session clock continuous increment.
=>
  Please, please, have someone who can express the consequences lucidly
  rewrite this - it's too important.

(c)
public static final String PROPERTY_NAME

    The property name for the sequential mode option
=>
    ...event processing option

=*=*=
(9)
org.kie.api.conf Enum MBeansOption

option. kie.mbeans = <enabled|disabled>  DEFAULT = false
=>
  DEFAULT = ...???

=*=*=
(10)
org.kie.api.event.kiebase Interface KieBaseEventListener

beforeProcessAdded

void beforeProcessAdded(BeforeProcessAddedEvent event)

    Method called before a process is removed from the knowledge base
=>
    added

afterProcessAdded

void afterProcessAdded(AfterProcessAddedEvent event)

    Method called after a function is removed from the knowledge base
=>
    process is added

beforeProcessRemoved

void beforeProcessRemoved(BeforeProcessRemovedEvent event)

    Method called before a function is removed from the knowledge base
=>
    process

afterProcessRemoved

void afterProcessRemoved(AfterProcessRemovedEvent event)

    Method called after a function is removed from the knowledge base
=>
    process

=*=*=
(11)

org.kie.api.event.kiebase Class DefaultKieBaseEventListener

  see (10), probably just "inherited"