Skip to content

Commit ea8961c

Browse files
defold-servicesdefold-services
committed
Site changes [skip-ci]
1 parent a406dc5 commit ea8961c

File tree

7 files changed

+74
-75
lines changed

7 files changed

+74
-75
lines changed

‎_data/ref/alpha/camera.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -613,7 +613,7 @@
613613
],
614614
"info": {
615615
"brief": "Camera API documentation",
616-
"description": "Camera functions, messages and constants.",
616+
"description": "Messages to control camera components and camera focus.",
617617
"file": "",
618618
"group": "COMPONENTS",
619619
"language": "",

‎_data/ref/alpha/dmGraphics.json

+5-6
Original file line numberDiff line numberDiff line change
@@ -2394,14 +2394,13 @@
23942394
}
23952395
],
23962396
"info": {
2397-
"brief": "SDK Graphics API documentation",
2398-
"description": "Platform specific native graphics functions.",
2399-
"file": "dmsdk/graphics/graphics_native.h",
2400-
"group": "DEFOLD SDK",
2397+
"brief": "Graphics API documentation",
2398+
"description": "<span class=\"file\"><dmsdk/graphics/graphics_opengl.h></span>\nGraphics OpenGL API",
2399+
"file": "",
24012400
"language": "",
2402-
"name": "Graphics",
2401+
"name": "Graphics OpenGL",
24032402
"namespace": "dmGraphics",
24042403
"notes": [],
2405-
"path": "engine/dlib/src/dmsdk/graphics/graphics_native.h"
2404+
"path": ""
24062405
}
24072406
}

‎_data/ref/alpha/dmMemory.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -101,14 +101,14 @@
101101
}
102102
],
103103
"info": {
104-
"brief": "SDK Memory API documentation",
105-
"description": "Memory allocation functions",
106-
"file": "dmsdk/dlib/memory.h",
104+
"brief": "SDK Alloca API documentation",
105+
"description": "Alloca functions.",
106+
"file": "dmsdk/dlib/dalloca.h",
107107
"group": "DEFOLD SDK",
108108
"language": "",
109-
"name": "Memory",
109+
"name": "Alloca",
110110
"namespace": "dmMemory",
111111
"notes": [],
112-
"path": "engine/dlib/src/dmsdk/dlib/memory.h"
112+
"path": "engine/dlib/src/dmsdk/dlib/dalloca.h"
113113
}
114114
}

‎_data/ref/alpha/dmResource.json

+47-47
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"description": "Adds a file to the resource system\nAny request for this path will go through any existing mounts first.\nIf you wish to provide file overrides, please use the LiveUpdate feature for that.\nThe file isn't persisted between sessions.",
66
"error": "",
77
"examples": "",
8-
"language": "",
8+
"language": "C++",
99
"members": [],
1010
"name": "AddFile",
1111
"notes": [],
@@ -14,7 +14,7 @@
1414
"doc": "Factory handle",
1515
"name": "factory",
1616
"types": [
17-
"dmResource::HFactory"
17+
"HResourceFactory"
1818
]
1919
},
2020
{
@@ -42,10 +42,10 @@
4242
"replaces": "",
4343
"returnvalues": [
4444
{
45-
"doc": "on success.",
46-
"name": "RESULT_OK",
45+
"doc": "RESULT_OK on success",
46+
"name": "result",
4747
"types": [
48-
"dmResource::Result"
48+
"ResourceResult"
4949
]
5050
}
5151
],
@@ -57,7 +57,7 @@
5757
"description": "Adds a file to the resource system\nAny request for this path will go through any existing mounts first.\nIf you wish to provide file overrides, please use the LiveUpdate feature for that.\nThe file isn't persisted between sessions.",
5858
"error": "",
5959
"examples": "",
60-
"language": "C++",
60+
"language": "",
6161
"members": [],
6262
"name": "AddFile",
6363
"notes": [],
@@ -66,7 +66,7 @@
6666
"doc": "Factory handle",
6767
"name": "factory",
6868
"types": [
69-
"HResourceFactory"
69+
"dmResource::HFactory"
7070
]
7171
},
7272
{
@@ -94,10 +94,10 @@
9494
"replaces": "",
9595
"returnvalues": [
9696
{
97-
"doc": "RESULT_OK on success",
98-
"name": "result",
97+
"doc": "on success.",
98+
"name": "RESULT_OK",
9999
"types": [
100-
"ResourceResult"
100+
"dmResource::Result"
101101
]
102102
}
103103
],
@@ -248,7 +248,7 @@
248248
"description": "Get a resource from factory",
249249
"error": "",
250250
"examples": "",
251-
"language": "",
251+
"language": "C++",
252252
"members": [],
253253
"name": "Get",
254254
"notes": [],
@@ -257,7 +257,7 @@
257257
"doc": "Factory handle",
258258
"name": "factory",
259259
"types": [
260-
"dmResource::HFactory"
260+
"HResourceFactory"
261261
]
262262
},
263263
{
@@ -281,7 +281,7 @@
281281
"doc": "RESULT_OK on success",
282282
"name": "result",
283283
"types": [
284-
"dmResource::Result"
284+
"ResourceResult"
285285
]
286286
}
287287
],
@@ -309,7 +309,7 @@
309309
"doc": "Resource name",
310310
"name": "name",
311311
"types": [
312-
"dmhash_t"
312+
"const char*"
313313
]
314314
},
315315
{
@@ -338,7 +338,7 @@
338338
"description": "Get a resource from factory",
339339
"error": "",
340340
"examples": "",
341-
"language": "C++",
341+
"language": "",
342342
"members": [],
343343
"name": "Get",
344344
"notes": [],
@@ -347,14 +347,14 @@
347347
"doc": "Factory handle",
348348
"name": "factory",
349349
"types": [
350-
"HResourceFactory"
350+
"dmResource::HFactory"
351351
]
352352
},
353353
{
354354
"doc": "Resource name",
355355
"name": "name",
356356
"types": [
357-
"const char*"
357+
"dmhash_t"
358358
]
359359
},
360360
{
@@ -371,7 +371,7 @@
371371
"doc": "RESULT_OK on success",
372372
"name": "result",
373373
"types": [
374-
"ResourceResult"
374+
"dmResource::Result"
375375
]
376376
}
377377
],
@@ -735,21 +735,21 @@
735735
"description": "Hint the preloader what to load before Create is called on the resource.\nThe resources are not guaranteed to be loaded before Create is called.\nThis function can be called from a worker thread.",
736736
"error": "",
737737
"examples": "",
738-
"language": "",
738+
"language": "C++",
739739
"members": [],
740740
"name": "PreloadHint",
741741
"notes": [],
742742
"parameters": [
743743
{
744744
"doc": "Preloader handle",
745-
"name": "factory",
745+
"name": "preloader",
746746
"types": [
747747
"dmResource::HResourcePreloadHintInfo"
748748
]
749749
},
750750
{
751-
"doc": "Resource name",
752-
"name": "name",
751+
"doc": "Resource path",
752+
"name": "path",
753753
"types": [
754754
"const char*"
755755
]
@@ -773,21 +773,21 @@
773773
"description": "Hint the preloader what to load before Create is called on the resource.\nThe resources are not guaranteed to be loaded before Create is called.\nThis function can be called from a worker thread.",
774774
"error": "",
775775
"examples": "",
776-
"language": "C++",
776+
"language": "",
777777
"members": [],
778778
"name": "PreloadHint",
779779
"notes": [],
780780
"parameters": [
781781
{
782782
"doc": "Preloader handle",
783-
"name": "preloader",
783+
"name": "factory",
784784
"types": [
785785
"dmResource::HResourcePreloadHintInfo"
786786
]
787787
},
788788
{
789-
"doc": "Resource path",
790-
"name": "path",
789+
"doc": "Resource name",
790+
"name": "name",
791791
"types": [
792792
"const char*"
793793
]
@@ -851,16 +851,18 @@
851851
"description": "Release resource",
852852
"error": "",
853853
"examples": "",
854-
"language": "",
854+
"language": "C++",
855855
"members": [],
856856
"name": "Release",
857-
"notes": [],
857+
"notes": [
858+
"Decreases ref count by 1. If it reaches 0, the resource destroy function is called."
859+
],
858860
"parameters": [
859861
{
860862
"doc": "Factory handle",
861863
"name": "factory",
862864
"types": [
863-
"dmResource::HFactory"
865+
"HResourceFactory"
864866
]
865867
},
866868
{
@@ -881,18 +883,16 @@
881883
"description": "Release resource",
882884
"error": "",
883885
"examples": "",
884-
"language": "C++",
886+
"language": "",
885887
"members": [],
886888
"name": "Release",
887-
"notes": [
888-
"Decreases ref count by 1. If it reaches 0, the resource destroy function is called."
889-
],
889+
"notes": [],
890890
"parameters": [
891891
{
892892
"doc": "Factory handle",
893893
"name": "factory",
894894
"types": [
895-
"HResourceFactory"
895+
"dmResource::HFactory"
896896
]
897897
},
898898
{
@@ -913,7 +913,7 @@
913913
"description": "Removes a previously registered file from the resource system",
914914
"error": "",
915915
"examples": "",
916-
"language": "",
916+
"language": "C++",
917917
"members": [],
918918
"name": "RemoveFile",
919919
"notes": [],
@@ -922,7 +922,7 @@
922922
"doc": "Factory handle",
923923
"name": "factory",
924924
"types": [
925-
"dmResource::HFactory"
925+
"HResourceFactory"
926926
]
927927
},
928928
{
@@ -936,10 +936,10 @@
936936
"replaces": "",
937937
"returnvalues": [
938938
{
939-
"doc": "on success.",
940-
"name": "RESULT_OK",
939+
"doc": "RESULT_OK on success",
940+
"name": "result",
941941
"types": [
942-
"dmResource::Result"
942+
"ResourceResult"
943943
]
944944
}
945945
],
@@ -951,7 +951,7 @@
951951
"description": "Removes a previously registered file from the resource system",
952952
"error": "",
953953
"examples": "",
954-
"language": "C++",
954+
"language": "",
955955
"members": [],
956956
"name": "RemoveFile",
957957
"notes": [],
@@ -960,7 +960,7 @@
960960
"doc": "Factory handle",
961961
"name": "factory",
962962
"types": [
963-
"HResourceFactory"
963+
"dmResource::HFactory"
964964
]
965965
},
966966
{
@@ -974,10 +974,10 @@
974974
"replaces": "",
975975
"returnvalues": [
976976
{
977-
"doc": "RESULT_OK on success",
978-
"name": "result",
977+
"doc": "on success.",
978+
"name": "RESULT_OK",
979979
"types": [
980-
"ResourceResult"
980+
"dmResource::Result"
981981
]
982982
}
983983
],
@@ -1747,12 +1747,12 @@
17471747
"info": {
17481748
"brief": "Resource",
17491749
"description": "Functions for managing resource types.",
1750-
"file": "dmsdk/resource/resource_gen.hpp",
1750+
"file": "dmsdk/resource/resource.hpp",
17511751
"group": "DEFOLD SDK",
1752-
"language": "C++",
1752+
"language": "",
17531753
"name": "Resource",
17541754
"namespace": "dmResource",
17551755
"notes": [],
1756-
"path": "engine/resource/src/dmsdk/resource/resource_gen.hpp"
1756+
"path": "engine/resource/src/dmsdk/resource/resource.hpp"
17571757
}
17581758
}

‎_data/ref/alpha/dmScript.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -2115,12 +2115,12 @@
21152115
"info": {
21162116
"brief": "SDK Script API documentation",
21172117
"description": "Built-in scripting functions.",
2118-
"file": "dmsdk/script/script.h",
2118+
"file": "dmsdk/gamesys/script.h",
21192119
"group": "DEFOLD SDK",
21202120
"language": "",
21212121
"name": "Script",
21222122
"namespace": "dmScript",
21232123
"notes": [],
2124-
"path": "engine/dlib/src/dmsdk/script/script.h"
2124+
"path": "engine/gamesys/src/dmsdk/gamesys/script.h"
21252125
}
21262126
}

‎_data/ref/alpha/gui.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -5509,7 +5509,7 @@
55095509
],
55105510
"info": {
55115511
"brief": "GUI API documentation",
5512-
"description": "GUI API documentation",
5512+
"description": "GUI core hooks, functions, messages, properties and constants for\ncreation and manipulation of GUI nodes. The \"gui\" namespace is\naccessible only from gui scripts.",
55135513
"file": "",
55145514
"group": "SYSTEM",
55155515
"language": "",

0 commit comments

Comments
 (0)