Add full documentation to the reference.conf file
#300
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
LukaszKontowski
added
the
documentation
LukaszKontowski
commented
Oct 25, 2022
Comment on lines
-9
to
-10
| // the `ext` field (file extension) must be an Option[String] and not a String for the ExistingIntelliJ usage | ||
| // inside the `org.virtuslab.ideprobe.dependencies.IntelliJVersionResolver` object |
There was a problem hiding this comment.
unrelated - deleted outdated invalid code comment
PawelLipski
reviewed
Oct 25, 2022
PawelLipski
reviewed
Oct 25, 2022
PawelLipski
reviewed
Oct 25, 2022
PawelLipski
reviewed
Oct 25, 2022
PawelLipski
reviewed
Oct 25, 2022
PawelLipski
reviewed
Oct 25, 2022
PawelLipski
reviewed
Oct 25, 2022
PawelLipski
reviewed
Oct 25, 2022
PawelLipski
reviewed
Oct 25, 2022
PawelLipski
reviewed
Oct 25, 2022
PawelLipski
reviewed
Oct 25, 2022
PawelLipski
reviewed
Oct 25, 2022
PawelLipski
reviewed
Oct 25, 2022
PawelLipski
reviewed
Oct 25, 2022
PawelLipski
reviewed
Oct 25, 2022
lukaszwawrzyk
approved these changes
Oct 28, 2022
Thanks for suggestion - I will check that if there references to files that I deleted before merging. If they do exist - I will fix README in a separate PR soon. |
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.
Closes #254
Closes #262
Closes #265
Adds full documentation to the
reference.conf.4 files from
docs/directory are deleted as their content (more or less modified) is now available in thereference.confconfig comments.One thing still missing is a description with example for usage of
org.virtuslab.ideprobe.dependencies.Plugin.FromSourceswhich could be used inprobe.intellij.pluginsarray. The reason is that for now this one is not clear to me and I did not manage to find a single example of usage for this type ofPlugin. Moreover, it looks likeFromSourcesusage is dedicated to users, who interact with ide-probe rather by direct code calls (and not by the.conffile), because it requires the user to have a custom implementation ofDependencyBuilderand register it by usingorg.virtuslab.ideprobe.dependencies.DependencyProvider#registerBuilder...If you have some suggestions / advice about it, that would be nice. Otherwise - I can create a separate issue for adding a proper comment for this one missing element.