Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: use apidoc for most classes #1002

Merged
merged 2 commits into from
Dec 12, 2019
Merged

Docs: use apidoc for most classes #1002

merged 2 commits into from
Dec 12, 2019

Conversation

ennru
Copy link
Member

@ennru ennru commented Dec 4, 2019

Purpose

Use the fact that @apidoc now supports inner classes to make the documentation easier to read and write in raw markdown.

seglo
seglo approved these changes Dec 11, 2019
View reviewed changes
Copy link
Contributor

@seglo seglo left a comment

Choose a reason for hiding this comment

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

LGTM. I noticed you truncated some of the FQCNs so I highlighted types that were fully qualified. Not sure if they were left that way for a reason.

docs/src/main/paradox/producer.md Outdated Show resolved Hide resolved
docs/src/main/paradox/producer.md Outdated Show resolved Hide resolved
docs/src/main/paradox/producer.md Outdated Show resolved Hide resolved
docs/src/main/paradox/transactions.md Outdated Show resolved Hide resolved
@ennru @seglo
Less qualification
4d80ba0 
Co-Authored-By: Sean Glover <sean@seanglover.com>
@ennru ennru merged commit 8de08dd into akka:master Dec 12, 2019
@ennru ennru deleted the apidoc-for-inner-classes branch December 12, 2019 09:03
@ennru ennru added this to the 2.0.0 milestone Dec 12, 2019
@ennru ennru mentioned this pull request Dec 16, 2019
Merged
@ennru
Copy link
Member Author

ennru commented Dec 16, 2019

Those qualifications were necessary... #1008

@seglo
Copy link
Contributor

seglo commented Dec 16, 2019

You're right, oops.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@seglo seglo seglo approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
2.0.0-RC1
Development

Successfully merging this pull request may close these issues.
2 participants
@ennru @seglo