Commit Graph

41 Commits

Author SHA1 Message Date
26510f4c90 Merge pull request #55609 from rcorre/doc-scroll 2021-12-13 15:21:50 +01:00
9d04086451 Document how to autoscroll ScrollContainer.
It is not uncommon to want to scroll to the most recently added child of
a ScrollContainer (e.g. a chat box or activity log). This is a little
tricky, since `ensure_control_visible` will not work on a node on the
same frame as you add it. Let's at least document that you need to wait
until the next frame.

Relates to https://github.com/godotengine/godot-proposals/issues/3629.

Co-authored-by: Yuri Sizov <pycbouh@users.noreply.github.com>
2021-12-12 07:55:01 -05:00
841a9ef820 ScrollContainer's scrollbar visibility is now enum 2021-12-07 18:27:12 +01:00
b3992f7e6e Make overridden properties link to parent definition
Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-03 17:47:22 +03:00
07725b611b Add warnings to methods that give access to internal nodes 2021-10-10 22:57:58 +03:00
d54f2ad7ca Don't generate empty doc sections and reduce code duplication 2021-09-20 20:59:33 -05:00
bf2839ea3e Add theme item descriptions to the online documentation 2021-08-04 22:27:10 +03:00
7adf4cc9b5 doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
2021-07-30 15:29:52 +02:00
6d5b5ba89f ScrollContainer: Expose _ensure_focused_visible to the API
Was renamed to `ensure_control_visible`
2021-05-31 17:14:57 -10:00
bb6bdcee1a Add the ability to hide scrollcontainer's scrollbars 2021-04-28 09:28:31 -06:00
4e226dc0d6 Docs: Improved wording and added links
- Added missing links to the Control node in BoxContainer
- Added Oxford commas in BoxContainer and CanvasItem
- Clarified ambiguous boolean wording in BoxContainer
- Improved paragraphing in ScrollContainer's description
- Simplified ControlPicker description
2020-02-26 14:47:06 +11:00
57e27683ba Update docs to version 4.0 2020-01-31 17:15:41 -08:00
21dd35b611 Document theme_items of multiple classes 2020-01-27 02:15:37 +01:00
2d20fc39aa doc: Drop unused 'category' property from header
We already removed it from the online docs with #35132.

Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.

We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
2020-01-26 16:02:39 +01:00
4f0401d05d Update ScrollContainer.xml
Add missing descriptions to ScrollContainer documentation
2020-01-24 17:21:53 +01:00
a18909f945 doc: Sync classref with current source 2020-01-03 15:09:09 +01:00
cc72885107 Make new ScrollContainer focus behavior optional 2019-12-30 16:40:02 +01:00
a7ac8ec876 doc: Fix parsing of self-closing XML tags
Follow-up to #31925, `<member />` tags just before `</members>` would cause
a parsing issue, and we'd never notice that we're no longer parsing members.

Also added space before closing `/>`.
2019-09-24 13:34:05 +02:00
b397bcf4a1 Run doctool after overridden properties changes 2019-09-04 15:26:08 +03:00
c6cea6e9b3 doc: Add default values to all properties
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-30 13:58:07 +02:00
f7f6115f76 Proofread and improve the whole class reference
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
  and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
2019-06-27 22:30:19 +02:00
6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
cab790a49d Update ScrollContainer description to be less ambiguous. 2019-02-27 12:24:56 -05:00
26fddb77be doc: Fix wrong references found by new makerst.py
Thanks @PJB3005
2019-01-07 10:06:12 +01:00
eaac1e3b81 [Docs] Remove double-spaces from descriptions, as well a couple other small fixes 2018-09-23 16:13:30 -04:00
d5bb6faac7 -Make sure that ProjectSettings are properly dumped when dumping docs.
-Documented all properties of project settings

Update documentation for ProjectSettings
2018-06-11 13:41:16 -03:00
4c5dd51eb9 Sync classref with current source
Also fix binding of Basis.slerp
2018-05-28 14:53:15 +02:00
40ec56801b Fix Error in the ScrollContainer Tooltips 2018-05-12 03:45:56 -05:00
0dd526e062 Docs update for several classes
Namely: Dictionary, GraphEdit, Object, TileMap, Script, ScollBar,
ScrollContainer and SplitContainer
2018-04-19 21:09:53 +02:00
cb7fe2c793 doc: Sync classref with current source 2018-04-10 10:12:42 +02:00
3fa77b3172 doc: Remove status from hardcoded version string
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-27 13:40:49 +01:00
3c7a39b40c doc: Update version string in header 2018-02-19 10:46:33 +01:00
d516aab8fa doc: Sync with current source
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018
and fix the version tag in all files (not really stable yet, but it makes no sense
to hardcode rc3 at this stage).
2018-01-25 08:50:56 +01:00
e28cdc4654 doc: Update version string in XML 2018-01-13 11:43:42 +01:00
ad79c70300 Update docs
[ci skip]
2018-01-12 00:58:22 +02:00
92f07fefcd doc: Remove setters and getters now exposed via properties/members 2017-11-24 18:10:32 +01:00
bc75fae579 doc: Update header version for 3.0-beta 2017-11-24 09:16:52 +01:00
967bfb0c4a doc: Remove revision.module_config from version string
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00
a4005221f5 doc: Sync classref with current source
[ci skip]
2017-09-13 08:53:01 +02:00
4f929a0fdf Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
recognize them.
2017-09-12 17:45:41 -03:00