Idea

dylan-1 avatar image
dylan-1 suggested

[Unreal] More documentation, examples

I noticed that each module is vastly different. Some uses dynamic delegates, some don't, some require Activate() while others don't -- it's quite the mess. You could improve the quality of lives for all your users for only a several hours worth of effort on PF's part:

1. Inline Docs. Every module was clearly coded by a different team with no mutual direction, so it's quite a mess. 1 uses dynamic delegates, another doesn't, another vaguely requires Activate() where the others don't. A prime example is CreateGroup(), where the inline doc was, redundantly, "Creates a Group". Not only was this (respectfully) low-effort, but it was not even true -- it prepared a Manager where you must Activate() to actually create the group. 10 more seconds of typing would have saved me hours of research, trial and error since auth and cloud script didn't use this and Activate() is completely undocumented. There are many examples like this. Tell us what it actually does without repeating the self-documented func name >> Tell us what calls back >> Tell us the "extra" steps we may have to do, if any. Pretend you're a developer, reminding yourself there is pretty much 0 Unreal sdk docs.

2. Online docs. For Unreal, minus perhaps 1 or 2 examples, there's practically none.

3. Online examples. For Unreal, there's practically none. Same issue as above ^.

unrealdocumentation
10 |1200

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

No Comments

·

Write a Comment

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Your Opinion Counts

Share your great idea, or help out by voting for other people's ideas.