Skip to content

Add Kotlin to API documentation 2.0#38

Merged
emdobrin merged 9 commits intoadobe:dev-v2.0.0from
timkimadobe:kotlin-api-doc-2.0
Jan 31, 2023
Merged

Add Kotlin to API documentation 2.0#38
emdobrin merged 9 commits intoadobe:dev-v2.0.0from
timkimadobe:kotlin-api-doc-2.0

Conversation

@timkimadobe
Copy link
Copy Markdown
Contributor

@timkimadobe timkimadobe commented Jan 31, 2023

Description

This PR updates:

  1. API documentation with Kotlin syntax and examples
  2. Some grammar/styling

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@codecov
Copy link
Copy Markdown

codecov bot commented Jan 31, 2023 •
edited
Loading

Codecov Report

Merging #38 (d9433bc) into dev-v2.0.0 (fb47439) will not change coverage.
The diff coverage is n/a.

@@              Coverage Diff              @@
##             dev-v2.0.0      #38   +/-   ##
=============================================
  Coverage         83.28%   83.28%           
  Complexity          367      367           
=============================================
  Files                29       29           
  Lines              1555     1555           
  Branches            219      219           
=============================================
  Hits               1295     1295           
  Misses              161      161           
  Partials             99       99
Flag Coverage Δ
functional-tests 65.85% <ø> (ø)
unit-tests 79.16% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

addb
addb reviewed Jan 31, 2023
View reviewed changes
Documentation/api-reference.md
##### Example
```java
import com.adobe.marketing.mobile.Edge
import com.adobe.marketing.mobile.Edge;
Copy link
Copy Markdown
Contributor

@addb addb Jan 31, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Let's remove the imports from all the samples. We have that in getting started.

Copy link
Copy Markdown
Contributor

@kevinlind kevinlind Jan 31, 2023

Choose a reason for hiding this comment

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

The documentation for the other extensions do include the import statement just for the registerExtension API, so I think we can leave it here as well.

Copy link
Copy Markdown
Contributor Author

@timkimadobe timkimadobe Jan 31, 2023

Choose a reason for hiding this comment

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

Ok I will keep it in this example and make sure to remove it elsewhere

addb
addb reviewed Jan 31, 2023
View reviewed changes
emdobrin
emdobrin reviewed Jan 31, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@emdobrin emdobrin left a comment

Choose a reason for hiding this comment

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

Looks great, few small comments below

timkimadobe
timkimadobe commented Jan 31, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor Author

@timkimadobe timkimadobe left a comment

Choose a reason for hiding this comment

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

Thanks for the review @emdobrin , @addb , @kevinlind ! I've updated according to the feedback, ready for followup review

Documentation/api-reference.md
##### Example
```java
import com.adobe.marketing.mobile.Edge
import com.adobe.marketing.mobile.Edge;
Copy link
Copy Markdown
Contributor Author

@timkimadobe timkimadobe Jan 31, 2023

Choose a reason for hiding this comment

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

Ok I will keep it in this example and make sure to remove it elsewhere

emdobrin
emdobrin approved these changes Jan 31, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@emdobrin emdobrin left a comment

Choose a reason for hiding this comment

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

let's :shipit:

@emdobrin emdobrin merged commit 5de9ec1 into adobe:dev-v2.0.0 Jan 31, 2023
@timkimadobe timkimadobe deleted the kotlin-api-doc-2.0 branch February 1, 2023 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@addb addb addb left review comments

@emdobrin emdobrin emdobrin approved these changes

@kevinlind kevinlind Awaiting requested review from kevinlind

@cacheung cacheung Awaiting requested review from cacheung

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@timkimadobe @addb @emdobrin @kevinlind