[MOB-9676] docs and doc generator #610
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ackage.json for documentation generation; make properties in IterableInAppMessage optional for better flexibility.
…; update ESLint configuration to include TSDoc syntax rule
…and to package.json; enhance Iterable class documentation and export additional types for improved type safety.
…ing; update README and configuration files accordingly.
…config.mjs with updated settings; enhance README and add comments to IterableAuthResponseResult enum
… improve usability and clarity
…p descriptions and examples for IterableInbox, IterableInboxEmptyState, IterableInboxMessageCell, IterableInboxMessageDisplay, and IterableInboxMessageList to improve clarity and usability.
…n hooks: add detailed comments, examples, and interface definition for better clarity and usability.
…ions and comments for IterableInboxImpressionRowInfo, IterableInboxRowViewModel, and IterableInboxCustomizations interfaces to improve clarity and usability.
…classes: add detailed descriptions, constructor comments, and improve clarity for properties. Update IterableInboxImpressionRowInfo interface documentation.
…bleLogger, and IterableUtil classes: add detailed descriptions, constructor comments, and examples to improve clarity and usability.
…e class: add detailed descriptions, constructor comments, and examples to improve clarity and usability. Documentation based on iterable public documentation.
…ep linking examples, and update parameter descriptions for better understanding.
…d update Iterable example formatting
… descriptions, clarify usage, and improve overall clarity and usability.
…or IterableInAppTrigger, IterableInAppContentType, IterableInAppTriggerType, and IterableInAppContent; update package.json for simplified docs command.
…ndleAuthFailureCalled description
…prove usability, and remove TODOs for better understanding.
|
…et notDocumented to true
…0.0-alpha/MOB-9676-new-doc-generator
…0.0-alpha/MOB-9676-new-doc-generator
…0.0-alpha/MOB-9676-new-doc-generator
Base automatically changed from
2.0.0-alpha/MOB-10141-make-lint-rules-stricter
to
2.0.0-alpha/master
December 13, 2024 21:01
evantk91
reviewed
Dec 18, 2024
| saveToInbox: boolean; | ||
| inboxMetadata: { | ||
| createdAt?: number; | ||
| expiresAt?: number; |
There was a problem hiding this comment.
In the android SDK, createdAt, expiresAt, customPayload, and priorityLevel are non null. We need to think about if we want to make these optional.
There was a problem hiding this comment.
GREAT point. Let me think about it. I'll likely change.
| type IterableInboxCustomizations, | ||
| type IterableInboxEmptyStateProps, | ||
| type IterableInboxImpressionRowInfo, | ||
| type IterableInboxMessageCellProps, | ||
| type IterableInboxProps, |
There was a problem hiding this comment.
Strange why were all these imports added here?
There was a problem hiding this comment.
These were needed for the docs generator. It will only document public components.
typedoc.json
Outdated
| "excludeReferences": false, | ||
| "includeFolders": false | ||
| }, | ||
| } |
There was a problem hiding this comment.
This is configuration for the documentation generator
| @@ -115,7 +115,7 @@ export class IterableInAppManager { | |||
| * If set to false, the SDK will immediately retrieve and process in-app messages from the message queue. | |||
| * The default value of isAutoDisplayPaused is false (in the native code). | |||
| * | |||
| * @param {boolean} paused whether the automatic displaying should be paused | |||
There was a problem hiding this comment.
Is there a reason all the types were removed from description?
There was a problem hiding this comment.
They're meant to be left out in typescript -- the doc generator adds them automatically
evantk91
reviewed
Dec 18, 2024
evantk91
approved these changes
Dec 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🔹 JIRA Ticket(s) if any
✏️ Description
Added documentation and a doc generator (though we're not currently serving the docs anywhere)