Feature/live documentation #626
Conversation
…4c4732067886b82b8814f7d25b40" This reverts commit 31615fe5db34a8646b437f81843607ede2838c87.
The resize behavour of the Class member list was changed.
This reverts commit da2d5de.
Instead an error message is shown
There was a problem hiding this comment.
I started to review this PR but ran into too many violations of our coding style. Please read our style guide, fix your code accordingly, and let me know when you are done.
Also, I noticed a compiler error:
Assets\SEE\Utils\LiveDocumentation\CSharpExtractor.cs(122,25): error CS0103: The name 'ProcessReturnTag' does not exist in the current context
Always make sure your code compiles before creating a pull request.
Assets/SEE/Game/UI/LiveDocumentation/Buffer/LiveDocumentationBuffer.cs
Outdated
Show resolved
Hide resolved
Assets/SEE/Game/UI/LiveDocumentation/Buffer/LiveDocumentationBuffer.cs
Outdated
Show resolved
Hide resolved
Assets/SEE/Game/UI/LiveDocumentation/Buffer/LiveDocumentationBuffer.cs
Outdated
Show resolved
Hide resolved
Assets/SEE/Game/UI/LiveDocumentation/Buffer/LiveDocumentationBuffer.cs
Outdated
Show resolved
Hide resolved
Assets/SEE/Game/UI/LiveDocumentation/Buffer/LiveDocumentationBuffer.cs
Outdated
Show resolved
Hide resolved
|
@hlkuss @KritikoAlex There are too many instances of trailing whitespace in your code. Do not use trailing whitespace at the end of a line. Trailing whitespace is unnecessary and is a source of potential merge conflicts and superflous code differences. There is a plug-in for visual studio named RemoveTrailingWhitespaces that removes trailing whitespace when a file is saved. Our CI pipeline will check violations of this rule and then complain. |
This reverts commit ce55f15fe9beee62a095f8e8935b17e796fcee48.
This reverts commit 58d656ad72eab7e4b34f19a091e0a082bee235af.
This reverts commit 99f4781dae6b7c0460267528435d6d13bca52487.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Assets/SEE/Game/UI/LiveDocumentation/Buffer/ILiveDocumentationBufferItem.cs
Outdated
Show resolved
Hide resolved
Assets/SEE/Game/UI/LiveDocumentation/Buffer/LiveDocumentationBuffer.cs
Outdated
Show resolved
Hide resolved
Assets/SEE/Game/UI/LiveDocumentation/Buffer/LiveDocumentationClassMemberBuffer.cs
Outdated
Show resolved
Hide resolved
Assets/SEE/Game/UI/LiveDocumentation/Buffer/LiveDocumentationLink.cs
Outdated
Show resolved
Hide resolved
Assets/SEE/Game/UI/LiveDocumentation/LiveDocumentationWindow.cs
Outdated
Show resolved
Hide resolved
Assets/SEE/Game/UI/LiveDocumentation/LiveDocumentationWindowType.cs
Outdated
Show resolved
Hide resolved
|
I've resolved the issues. Please apologize for the inconvenience, I've totally forgotten about the style guide. |
Thanks for the moment. I will take a look when I am back home again. |
|
We will not merge this PR in the master. Our new LSP integration will supersede it. |
LiveDocumentation is a feature which allows SEE to display the documentation of classes and methods.
Links in the documentation are also represented as clickable links in the LiveDocumentation which opens the corresponding class.