Skip to content

Commit 9b27ddc

Browse files
committed
more header comments part 1
1 parent d38acee commit 9b27ddc

File tree

5 files changed

+414
-8
lines changed

5 files changed

+414
-8
lines changed

loader/include/Geode/utils/ColorProvider.hpp

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,21 @@
66
#include "../loader/Event.hpp"
77

88
namespace geode {
9+
/**
10+
* An event that gets posted whenever `ColorProvider` provides a color
11+
* for a specific id.
12+
*/
913
struct GEODE_DLL ColorProvidedEvent final : public Event {
1014
std::string id;
1115
cocos2d::ccColor4B color;
1216

1317
ColorProvidedEvent(std::string const& id, cocos2d::ccColor4B const& color);
1418
};
1519

20+
/**
21+
* An event filter to track whenever `ColorProvider` provides a color
22+
* for a specific id.
23+
*/
1624
class GEODE_DLL ColorProvidedFilter final : public EventFilter<ColorProvidedEvent> {
1725
public:
1826
using Callback = void(ColorProvidedEvent*);

loader/include/Geode/utils/addresser.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ namespace geode::addresser {
8888
}
8989

9090
/**
91-
* Specialized functionss
91+
* Specialized functions
9292
*/
9393
template <class Return, class Class, class... Parameters>
9494
static intptr_t addressOfVirtual(Return (Class::*func)(Parameters...)) {

loader/include/Geode/utils/async.hpp

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@
55
#include "Task.hpp"
66

77
namespace geode {
8+
/**
9+
* This is a geode utility that allows Tasks to be used with
10+
* C++'s own coroutine handling.
11+
*
12+
* @tparam T The task type it will finish to. See `Task` for
13+
* more information.
14+
* @tparam P The progress type the task posts. See `Task` for
15+
* more information.
16+
*/
817
template <is_task_type T = void, typename P = std::monostate>
918
class CoTask final {
1019
using Type = Task<T, P>::Type;

0 commit comments

Comments
 (0)