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

GDScript(2.0) Documentation generation system #41095

Merged
merged 2 commits into from
Dec 2, 2020
Merged

GDScript(2.0) Documentation generation system #41095

merged 2 commits into from
Dec 2, 2020
+1,315 −226

Conversation

ThakeeNathees
Copy link
Contributor

@ThakeeNathees ThakeeNathees commented Aug 7, 2020 •
edited by Calinou
Loading

Suppression of my initial pr(#39359). Refactored with GDScript 2.0

new-doc

Bugsquad edit: This closes godotengine/godot-proposals#993.

@ThakeeNathees ThakeeNathees mentioned this pull request Aug 7, 2020
Closed
@pouleyKetchoupp pouleyKetchoupp added this to the 4.0 milestone Aug 7, 2020
@ThakeeNathees ThakeeNathees force-pushed the GDScript-Documentation branch 2 times, most recently from 69133d9 to 4e6a799 Compare August 7, 2020 23:12
@AndreaCatania
Copy link
Contributor

Good job. If it's not too difficult, would be nice highlight the comment, like happens with syntax """ Comment """.

@ThakeeNathees
Copy link
Contributor Author

@AndreaCatania IMO, making the comments/documentations less visible from the source is easy to read the code,

here is a side by side comparison
Screenshot (38)

@AndreaCatania
Copy link
Contributor

Usually the documenting code is marked with a different colour. Probably that yellow is wrong and too strong for its purpose.

@dalexeev
Copy link
Member

dalexeev commented Aug 8, 2020

Perhaps a dark purple or dark green color will work. They are not used.

@ThakeeNathees ThakeeNathees mentioned this pull request Aug 11, 2020
Merged
@ThakeeNathees ThakeeNathees mentioned this pull request Aug 12, 2020
Closed
vnen
vnen reviewed Aug 13, 2020
View reviewed changes
modules/gdscript/gdscript_tokenizer.cpp Show resolved Hide resolved
modules/gdscript/gdscript_tokenizer.cpp Show resolved Hide resolved
modules/gdscript/gdscript_parser.h Outdated Show resolved Hide resolved
modules/gdscript/gdscript_tokenizer.h Outdated Show resolved Hide resolved
modules/gdscript/gdscript_parser.h Outdated Show resolved Hide resolved
modules/gdscript/gdscript_parser.cpp Show resolved Hide resolved
modules/gdscript/gdscript_parser.cpp Outdated Show resolved Hide resolved
modules/gdscript/gdscript_parser.cpp Outdated Show resolved Hide resolved
modules/gdscript/gdscript_compiler.cpp Outdated Show resolved Hide resolved
editor/editor_file_system.cpp Outdated Show resolved Hide resolved
vnen
vnen requested changes Aug 13, 2020
View reviewed changes
Copy link
Member

@vnen vnen left a comment

Choose a reason for hiding this comment

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

Overall looks great, just a few things that needs to change.

@ThakeeNathees
Copy link
Contributor Author

@vnen completed!

@ThakeeNathees ThakeeNathees force-pushed the GDScript-Documentation branch 2 times, most recently from 044b618 to 8e55187 Compare August 14, 2020 10:52
@vnen vnen self-assigned this Aug 17, 2020
vnen
vnen requested changes Dec 1, 2020
View reviewed changes
Copy link
Member

@vnen vnen left a comment

Choose a reason for hiding this comment

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

Looks really good. Just a small thing that you missed.

modules/gdscript/gdscript_compiler.cpp Outdated Show resolved Hide resolved
modules/gdscript/gdscript_compiler.cpp Outdated Show resolved Hide resolved
vnen
vnen approved these changes Dec 2, 2020
View reviewed changes
Copy link
Member

@vnen vnen left a comment

Choose a reason for hiding this comment

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

LGTM. Great work!

@akien-mga akien-mga merged commit d1231be into godotengine:master Dec 2, 2020
@akien-mga
Copy link
Member

Thanks hugely for this amazing feature, and for following up on belated reviews after GSoC :)

This was referenced Dec 24, 2020
Closed
Closed
@astrale-sharp astrale-sharp mentioned this pull request Jan 3, 2021
Closed
@Calinou Calinou mentioned this pull request Jan 5, 2021
Open
daniel-mcclintock added a commit to daniel-mcclintock/Octree.gd that referenced this pull request Feb 7, 2021
@daniel-mcclintock
Add GDScript "docstrings"
be452ab 
 - see: godotengine/godot#41095
@Calinou Calinou mentioned this pull request Feb 19, 2021
Closed
@YuriSizov YuriSizov mentioned this pull request Mar 6, 2021
Closed
@arnaudvergnet arnaudvergnet mentioned this pull request Mar 24, 2021
Merged
@Calinou Calinou mentioned this pull request Jun 22, 2021
Closed
@Calinou Calinou mentioned this pull request Jul 18, 2021
Closed
@geekley
Copy link

geekley commented Oct 23, 2021

Is there a way to show these tooltips in C# ? Like an attribute or XML doc or similar?

@neikeq
Copy link
Contributor

neikeq commented Oct 23, 2021

Is there a way to show these tooltips in C# ? Like an attribute or XML doc or similar?

We can probably use the generated XML doc for this, but this PR is about GDScript only.

@h0lley h0lley mentioned this pull request Mar 18, 2022
Closed
@ithinkandicode
Copy link

Will this feature ever be available in 3.x?

@YuriSizov
Copy link
Contributor

@ithinkandicode That's unlikely, as this feature is built on top of the changes in master which are not compatible. Nothing is impossible, but that would require dedicated 3.x GDScript maintainers, and there is currently nobody interested in doing that work.

@the-eclectic-dyslexic
Copy link

I am noticing the tooltips don't update until restarting in 4 beta 11. Is this intended behaviour or am I missing an option to tell them to regenerate?

@akien-mga
Copy link
Member

That's a known issue / expected behavior for any change that impacts an already open inspector for the node you're editing. If you click another node and then back to this one, it should refresh.

@the-eclectic-dyslexic
Copy link

@akien-mga Thanks for the reply, that was helpful. Have a good one!

@Aristottle
Copy link

The tooltips don't seem to generate if the variable is within an export category

@EvanHecht
Copy link

The tooltips don't seem to generate if the variable is within an export category

Yeah can confirm this happening for me as well.

@YuriSizov
Copy link
Contributor

This is already properly reported: #64432

@godotengine godotengine locked as resolved and limited conversation to collaborators Jan 25, 2023
@vnen
Copy link
Member

vnen commented Jan 25, 2023

Not sure why this is receiving comments lately so I locked to avoid cluttering the discussion. If you have a problem with the feature then open an issue about it since comments in merged pull requests tend to be forgotten.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@akien-mga akien-mga akien-mga approved these changes

@neikeq neikeq neikeq left review comments

@vnen vnen vnen approved these changes

@reduz reduz reduz left review comments

@bojidar-bg bojidar-bg Awaiting requested review from bojidar-bg

Assignees

@vnen vnen

Labels
documentation enhancement topic:editor topic:gdscript
Projects
None yet
Milestone
4.0
Development

Successfully merging this pull request may close these issues.

Documentation generation for GDScript