+pro #17611 add perl script to find javadoc errors

This commit is contained in:
Konrad Malawski 2015-06-22 17:26:49 +02:00
parent 7e86dac542
commit c34914a4fe
3 changed files with 21 additions and 5 deletions

View file

@ -158,7 +158,7 @@ class Persistence(val system: ExtendedActorSystem) extends Extension {
private val snapshotPluginExtensionId = new AtomicReference[Map[String, ExtensionId[PluginHolder]]](Map.empty)
/**
* Returns an [[EventAdapters]] object which serves as a per-journal collection of bound event adapters.
* Returns an [[akka.persistence.journal.EventAdapters]] object which serves as a per-journal collection of bound event adapters.
* If no adapters are registered for a given journal the EventAdapters object will simply return the identity
* adapter for each class, otherwise the most specific adapter matching a given class will be returned.
*/
@ -183,7 +183,7 @@ class Persistence(val system: ExtendedActorSystem) extends Extension {
/**
* INTERNAL API
* Looks up [[EventAdapters]] by journal plugin's ActorRef.
* Looks up [[akka.persistence.journal.EventAdapters]] by journal plugin's ActorRef.
*/
private[akka] final def adaptersFor(journalPluginActor: ActorRef): EventAdapters = {
journalPluginExtensionId.get().values collectFirst {

View file

@ -44,9 +44,10 @@ abstract class EventAdapter {
* Convert a event from its journal model to the applications domain model.
*
* One event may be adapter into multiple (or none) events which should be delivered to the [[akka.persistence.PersistentActor]].
* Use the specialised [[EventSeq.single]] method to emit exactly one event, or [[EventSeq.empty]] in case the adapter
* is not handling this event. Multiple [[EventAdapter]] instances are applied in order as defined in configuration
* and their emitted event seqs are concatenated and delivered in order to the PersistentActor.
* Use the specialised [[akka.persistence.journal.EventSeq#single]] method to emit exactly one event,
* or [[akka.persistence.journal.EventSeq#empty]] in case the adapter is not handling this event. Multiple [[EventAdapter]] instances are
* applied in order as defined in configuration and their emitted event seqs are concatenated and delivered in order
* to the PersistentActor.
*
* @param event event to be adapted before delivering to the PersistentActor
* @param manifest optionally provided manifest (type hint) in case the Adapter has stored one for this event, `""` if none

15
scripts/find-javadoc-error.pl Executable file
View file

@ -0,0 +1,15 @@
#!/usr/bin/perl
use strict;
use warnings;
my $active = 0;
my $print = 0;
while (<>) {
$active = 1, next if /Generating.*\.html/;
$active = 0, next if /Genjavadoc Java API documentation successful\./;
$print = 1 if /^\[error].*error:/;
$print = 0 if /warning:/;
print if $active && $print;
}