Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
godot
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
community
godot
Commits
5ce02b1b
Unverified
Commit
5ce02b1b
authored
Jun 16, 2020
by
Rémi Verschelde
Committed by
GitHub
Jun 16, 2020
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #38917 from bruvzg/in_editor_docs_style
Change in-editor documentation style to match online docs.
parents
4b5b60de
1e3c02d5
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
27 additions
and
9 deletions
+27
-9
editor_help.cpp
editor/editor_help.cpp
+27
-9
No files found.
editor/editor_help.cpp
View file @
5ce02b1b
...
...
@@ -243,6 +243,9 @@ void EditorHelp::_add_method(const DocData::MethodDoc &p_method, bool p_overview
if
(
p_overview
)
{
class_desc
->
push_cell
();
class_desc
->
push_align
(
RichTextLabel
::
ALIGN_RIGHT
);
}
else
{
static
const
CharType
prefix
[
3
]
=
{
0x25CF
/* filled circle */
,
' '
,
0
};
class_desc
->
add_text
(
String
(
prefix
));
}
_add_type
(
p_method
.
return_type
,
p_method
.
return_enum
);
...
...
@@ -378,7 +381,6 @@ void EditorHelp::_update_doc() {
class_desc
->
push_color
(
title_color
);
class_desc
->
push_font
(
doc_font
);
class_desc
->
add_text
(
TTR
(
"Inherits:"
)
+
" "
);
class_desc
->
pop
();
String
inherits
=
cd
.
inherits
;
...
...
@@ -393,6 +395,7 @@ void EditorHelp::_update_doc() {
}
class_desc
->
pop
();
class_desc
->
pop
();
class_desc
->
add_newline
();
}
...
...
@@ -401,13 +404,12 @@ void EditorHelp::_update_doc() {
bool
found
=
false
;
bool
prev
=
false
;
class_desc
->
push_font
(
doc_font
);
for
(
Map
<
String
,
DocData
::
ClassDoc
>::
Element
*
E
=
doc
->
class_list
.
front
();
E
;
E
=
E
->
next
())
{
if
(
E
->
get
().
inherits
==
cd
.
name
)
{
if
(
!
found
)
{
class_desc
->
push_color
(
title_color
);
class_desc
->
push_font
(
doc_font
);
class_desc
->
add_text
(
TTR
(
"Inherited by:"
)
+
" "
);
class_desc
->
pop
();
found
=
true
;
}
...
...
@@ -419,6 +421,7 @@ void EditorHelp::_update_doc() {
prev
=
true
;
}
}
class_desc
->
pop
();
if
(
found
)
{
class_desc
->
pop
();
...
...
@@ -758,6 +761,8 @@ void EditorHelp::_update_doc() {
signal_line
[
cd
.
signals
[
i
].
name
]
=
class_desc
->
get_line_count
()
-
2
;
//gets overridden if description
class_desc
->
push_font
(
doc_code_font
);
// monofont
class_desc
->
push_color
(
headline_color
);
static
const
CharType
prefix
[
3
]
=
{
0x25CF
/* filled circle */
,
' '
,
0
};
class_desc
->
add_text
(
String
(
prefix
));
_add_text
(
cd
.
signals
[
i
].
name
);
class_desc
->
pop
();
class_desc
->
push_color
(
symbol_color
);
...
...
@@ -835,10 +840,10 @@ void EditorHelp::_update_doc() {
for
(
Map
<
String
,
Vector
<
DocData
::
ConstantDoc
>>::
Element
*
E
=
enums
.
front
();
E
;
E
=
E
->
next
())
{
enum_line
[
E
->
key
()]
=
class_desc
->
get_line_count
()
-
2
;
class_desc
->
push_font
(
doc_code_font
);
class_desc
->
push_color
(
title_color
);
class_desc
->
add_text
(
"enum "
);
class_desc
->
pop
();
class_desc
->
push_font
(
doc_code_font
);
String
e
=
E
->
key
();
if
((
e
.
get_slice_count
(
"."
)
>
1
)
&&
(
e
.
get_slice
(
"."
,
0
)
==
edited_class
))
{
e
=
e
.
get_slice
(
"."
,
1
);
...
...
@@ -851,6 +856,8 @@ void EditorHelp::_update_doc() {
class_desc
->
push_color
(
symbol_color
);
class_desc
->
add_text
(
":"
);
class_desc
->
pop
();
class_desc
->
add_newline
();
class_desc
->
add_newline
();
class_desc
->
push_indent
(
1
);
...
...
@@ -869,6 +876,8 @@ void EditorHelp::_update_doc() {
class_desc
->
push_font
(
doc_code_font
);
class_desc
->
push_color
(
headline_color
);
static
const
CharType
prefix
[
3
]
=
{
0x25CF
/* filled circle */
,
' '
,
0
};
class_desc
->
add_text
(
String
(
prefix
));
_add_text
(
enum_list
[
i
].
name
);
class_desc
->
pop
();
class_desc
->
push_color
(
symbol_color
);
...
...
@@ -880,15 +889,16 @@ void EditorHelp::_update_doc() {
class_desc
->
pop
();
if
(
enum_list
[
i
].
description
!=
""
)
{
class_desc
->
push_font
(
doc_font
);
//class_desc->add_text(" ");
class_desc
->
push_indent
(
1
);
class_desc
->
push_color
(
comment_color
);
static
const
CharType
dash
[
6
]
=
{
' '
,
' '
,
0x2013
/* en dash */
,
' '
,
' '
,
0
};
class_desc
->
add_text
(
String
(
dash
));
_add_text
(
DTR
(
enum_list
[
i
].
description
));
class_desc
->
pop
();
class_desc
->
pop
();
class_desc
->
pop
();
// indent
if
(
DTR
(
enum_list
[
i
].
description
).
find
(
"
\n
"
)
>
0
)
{
class_desc
->
add_newline
();
}
}
class_desc
->
add_newline
();
}
...
...
@@ -931,6 +941,9 @@ void EditorHelp::_update_doc() {
class_desc
->
add_text
(
String
(
prefix
));
class_desc
->
pop
();
}
}
else
{
static
const
CharType
prefix
[
3
]
=
{
0x25CF
/* filled circle */
,
' '
,
0
};
class_desc
->
add_text
(
String
(
prefix
));
}
class_desc
->
push_color
(
headline_color
);
...
...
@@ -946,14 +959,16 @@ void EditorHelp::_update_doc() {
class_desc
->
pop
();
if
(
constants
[
i
].
description
!=
""
)
{
class_desc
->
push_font
(
doc_font
);
class_desc
->
push_indent
(
1
);
class_desc
->
push_color
(
comment_color
);
static
const
CharType
dash
[
6
]
=
{
' '
,
' '
,
0x2013
/* en dash */
,
' '
,
' '
,
0
};
class_desc
->
add_text
(
String
(
dash
));
_add_text
(
DTR
(
constants
[
i
].
description
));
class_desc
->
pop
();
class_desc
->
pop
();
class_desc
->
pop
();
// indent
if
(
DTR
(
constants
[
i
].
description
).
find
(
"
\n
"
)
>
0
)
{
class_desc
->
add_newline
();
}
}
class_desc
->
add_newline
();
}
...
...
@@ -987,6 +1002,9 @@ void EditorHelp::_update_doc() {
class_desc
->
push_cell
();
class_desc
->
push_font
(
doc_code_font
);
static
const
CharType
prefix
[
3
]
=
{
0x25CF
/* filled circle */
,
' '
,
0
};
class_desc
->
add_text
(
String
(
prefix
));
_add_type
(
cd
.
properties
[
i
].
type
,
cd
.
properties
[
i
].
enumeration
);
class_desc
->
add_text
(
" "
);
class_desc
->
pop
();
// font
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment