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: EXPOSED-159 Add KDocs for EntityClass reference functions #1848

Merged
merged 1 commit into from
Aug 29, 2023
Merged

docs: EXPOSED-159 Add KDocs for EntityClass reference functions #1848

merged 1 commit into from
Aug 29, 2023

Conversation

bog-walk
Copy link
Member

Add KDocs with test samples to EntityClass infix reference functions.

Edit docs to match updated Wiki.

@bog-walk
docs: EXPOSED-159 Add KDocs for EntityClass reference functions
6df57b2 
Add KDocs to EntityClass infix reference functions

Edit website docs to match updated Wiki
@bog-walk bog-walk linked an issue Aug 29, 2023 that may be closed by this pull request
Difference between backReferencedOn and referrersOn #583
Closed
@bog-walk bog-walk requested review from e5l and joc-a August 29, 2023 01:52
@bog-walk bog-walk linked an issue Aug 29, 2023 that may be closed by this pull request
backReferencedOn documentation #1015
Closed
e5l
e5l approved these changes Aug 29, 2023
View reviewed changes
Copy link
Member

@e5l e5l left a comment

Choose a reason for hiding this comment

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

We also could have a small snippet of code in KDoc, so it will give a usage sample in the ide help prompt on f1

@bog-walk
Copy link
Member Author

@e5l Using @sample in KDocs shows the referenced code snippet when you hover the mouse over the code element.

I've also just confirmed that placing the caret at the function and using the shortcut for Quick Documentation (F1 | Ctrl+Q) also opens the code snippet in either a pop-up or the documentation window 🎉

@bog-walk bog-walk merged commit cb721fe into main Aug 29, 2023
3 checks passed
@bog-walk bog-walk deleted the bog-walk/add-reference-kdocs branch August 29, 2023 13:31
saral pushed a commit to saral/Exposed that referenced this pull request Oct 3, 2023
@bog-walk @saral
docs: EXPOSED-159 Add KDocs for EntityClass reference functions (JetB…
f21e01d 
…rains#1848)

Add KDocs to EntityClass infix reference functions

Edit website docs to match updated Wiki
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joc-a joc-a joc-a approved these changes

@e5l e5l e5l approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

backReferencedOn documentation Difference between backReferencedOn and referrersOn
3 participants
@bog-walk @e5l @joc-a