Skip to content

Conversation

@slinkydeveloper
Copy link
Member

@slinkydeveloper slinkydeveloper commented Nov 27, 2020

This PR contains a lot of new javadocs for api and core

Also:

  • added the missing module-name in amqp module which was preventing the javadocs compilation
  • updates the javadoc plugin to latest version
  • exclude some modules from javadoc build

Signed-off-by: Francesco Guardiani francescoguard@gmail.com

@slinkydeveloper slinkydeveloper added this to the 2.0.0.RC2 milestone Nov 27, 2020
@slinkydeveloper slinkydeveloper mentioned this pull request Nov 27, 2020
24 tasks
@slinkydeveloper slinkydeveloper force-pushed the fixing_javadocs_external_links branch from 573b60d to 18945ab Compare November 30, 2020 15:24
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>

/**
* Visit the message as structured encoded event using the provided visitor
* Read the message as structured encoded message using the provided reader
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above.

@slinkydeveloper slinkydeveloper force-pushed the fixing_javadocs_external_links branch from 5362f88 to 362e1bd Compare December 1, 2020 16:34
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
<T> T read(StructuredMessageWriter<T> visitor) throws CloudEventRWException, IllegalStateException;
<R> R read(StructuredMessageWriter<R> writer) throws CloudEventRWException, IllegalStateException;

default CloudEvent toEvent() throws CloudEventRWException, IllegalStateException {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see these two methods are documented in extending interface. Why?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean the toEvent() methods.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I expect the user to look in this interface for this method, not in StructuredMessageReader. Does that makes sense?

Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
@slinkydeveloper slinkydeveloper merged commit f5d9b47 into cloudevents:master Dec 9, 2020
@slinkydeveloper slinkydeveloper deleted the fixing_javadocs_external_links branch December 9, 2020 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants