search

Ttibsi / rawterm

C++20 library for building TUI applications
MIT License
4 stars 4 forks source link

Add doc comments to each function/method #40

Open Ttibsi opened 3 months ago

Ttibsi commented 3 months ago

Mostly so it can be read with an LSP - in neovim, doing shift+k will show you the documentation around a function (at least with my config). We should add something like this to rawterm.

renu-123-pixel commented 3 months ago

hello @Ttibsi can i work on this issue?

Ttibsi commented 3 months ago

@renu-123-pixel Go ahead - please make a PR with your changes in a separate branch. Thanks. :)

Ttibsi commented 2 months ago

Yea, above each function in the source code, please add information that might be useful to know alongside the function signature. If there are any parameters, explain what those should be. (Same for the return types). It shouldn't be more than a few lines, and should intend to make using the library easier instead of just repeating information that's already there.

Not every function will need this, I think the big hotspots are going to be in rawterm/core.cpp and rawterm/extras/pane.h, although those won't be the only places