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

C#: Dereference editor types in core documentation #80632

Merged
merged 1 commit into from
Sep 2, 2023
Merged

C#: Dereference editor types in core documentation #80632

merged 1 commit into from
Sep 2, 2023

Conversation

Repiteo
Copy link
Contributor

@Repiteo Repiteo commented Aug 14, 2023

Extracted from #79475

  • Handles CS1574 by changing core documentation wrappers from <cref> to <c> when referencing editor types

@Repiteo Repiteo requested a review from a team as a code owner August 14, 2023 16:47
@Repiteo Repiteo mentioned this pull request Aug 14, 2023
Closed
@raulsntos raulsntos added this to the 4.2 milestone Aug 14, 2023
@Repiteo Repiteo force-pushed the C#-editor-docstring branch from 7f813ad to 1c44c42 Compare August 14, 2023 20:13
@YuriSizov YuriSizov requested a review from raulsntos August 31, 2023 17:57
raulsntos
raulsntos reviewed Sep 1, 2023
View reviewed changes
Copy link
Member

@raulsntos raulsntos left a comment

Choose a reason for hiding this comment

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

The change makes sense. We could consider removing those references or rewording them, but I think they are useful in some cases. I also can't think of a better solution.

For the record, here's the list of references as of c495eb5:

  • EditorInspector in @GlobalScope (6 times)
  • EditorDebuggerPlugin in EngineProfiler
  • EditorImportPlugin in ImageTexture
  • EditorPlugin in InputMap
  • EditorPlugin in InputMapInstance
  • EditorPlugin in OS (4 times)
  • EditorScript in OS (4 times)
  • EditorPlugin in OSInstance (4 times)
  • EditorScript in OSInstance (4 times)
  • EditorImportPlugin in ResourceFormatLoader
  • EditorImportPlugin in ResourceImporter
  • ResourceImporterWAV in ResourceImporterMP3
  • ResourceImporterWAV in ResourceImporterOggVorbis
  • EditorScenePostImport in SkeletonProfile
  • EditorPlugin in UndoRedo
  • EditorUndoRedoManager in UndoRedo

modules/mono/editor/bindings_generator.cpp Outdated Show resolved Hide resolved
modules/mono/editor/bindings_generator.cpp Outdated Show resolved Hide resolved
@Repiteo Repiteo force-pushed the C#-editor-docstring branch from 1c44c42 to cbf17b5 Compare September 1, 2023 20:18
raulsntos
raulsntos approved these changes Sep 2, 2023
View reviewed changes
Copy link
Member

@raulsntos raulsntos left a comment

Choose a reason for hiding this comment

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

LGTM.

@akien-mga akien-mga merged commit 2e71e55 into godotengine:master Sep 2, 2023
@akien-mga
Copy link
Member

Thanks!

@Repiteo Repiteo deleted the C#-editor-docstring branch September 2, 2023 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AThousandShips AThousandShips AThousandShips left review comments

@raulsntos raulsntos raulsntos approved these changes

Assignees
No one assigned
Labels
enhancement topic:buildsystem topic:dotnet
Projects
None yet
Milestone
4.2
Development

Successfully merging this pull request may close these issues.
4 participants
@Repiteo @akien-mga @raulsntos @AThousandShips