obsproject / obs-websocket

Remote-control of OBS Studio through WebSocket
GNU General Public License v2.0
3.89k stars 707 forks source link

Add CustomEvent docs entry #1032

Closed mattrossman closed 1 year ago

mattrossman commented 2 years ago

Description

Adds docstring for CustomEvent.

I wasn't sure where to add this (I'm new to the codebase and not fluent in C++). It looks like all other doc entries correspond 1:1 with a method, however I couldn't find any method that uses CustomEvent except for RequestHandler::BroadcastCustomEvent which already has a docstring.

So, I just put another docstring above that and it seems to generate the docs correctly.

Motivation and Context

Resolves #1031

How Has This Been Tested?

Tested OS(s): MacOS 12.6

I ran build_docs.sh to visually test the changed docs

Types of changes

Checklist:

tt2468 commented 1 year ago

Ah crap, forgot to check the commit format. I'll just have to leave it. Please follow the contributing guidelines in the future: https://github.com/obsproject/obs-websocket/wiki/Contributing-Guidelines