Skip to content

CAMEL-17792: Add documentation about the message headers (P-Q)#7349

Merged
essobedo merged 8 commits intomainfrom
CAMEL-17792/doc-message-headers
Apr 4, 2022
Merged

CAMEL-17792: Add documentation about the message headers (P-Q)#7349
essobedo merged 8 commits intomainfrom
CAMEL-17792/doc-message-headers

Conversation

@essobedo
Copy link
Contributor

@essobedo essobedo commented Apr 4, 2022

https://issues.apache.org/jira/browse/CAMEL-17792

Motivation

It is now possible to document a message header using annotations, let's leverage it to document the headers of the components.

Modifications

For all the components whose name starts with a P or Q

  • Document the messages headers using the annotations
  • Migrate the existing documentation of message headers to use the annotations instead
  • Move constants corresponding to headers to the headers class.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 4, 2022

⚠️ This PR changes Camel components and will be tested automatically.

@davsclaus
Copy link
Contributor

You are getting closer to Z ;)

@github-actions
Copy link
Contributor

github-actions bot commented Apr 4, 2022

🚫 There are too many components to be tested in this PR, components were removed or the code needs a rebase: (12 likely to be tested)

@essobedo
Copy link
Contributor Author

essobedo commented Apr 4, 2022

You are getting closer to Z ;)

I hope, I will be able to finish this week. It is a very long and laborious task. I'm looking forward finishing it to be able to do something else 😄

BTW, for some components, I moved directly the constants from other classes (like the for example the EntryPoint class) to the Constants class while maybe the proper way was to duplicate the constants and mark the constants defined in other classes as deprecated, WDYT?

@essobedo essobedo merged commit 92e85ae into main Apr 4, 2022
@essobedo essobedo deleted the CAMEL-17792/doc-message-headers branch April 4, 2022 14:51
@davsclaus
Copy link
Contributor

yes this is good

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.

3 participants