Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add include paths with capitalised paths #46

Open
seanharmer opened this issue Dec 13, 2023 · 4 comments
Open

Add include paths with capitalised paths #46

seanharmer opened this issue Dec 13, 2023 · 4 comments

Comments

@seanharmer
Copy link
Contributor

It would be nice to be able to do:

#include <KDBindings/signal.h>

on systems with case-sensitive filesystems so that it matches the other KD libraries that we have.

@winterz
Copy link
Member

winterz commented Dec 14, 2023

would "camelcase" forwarding headers be ok?
i.e
#include <KDBindings/ClassName>

@LeonMatthesKDAB
Copy link
Contributor

If the goal is to conform to what the other KD libraries are doing, we should stick to whatever header naming scheme is used there most often.
From a cursory glance at KDDockWidgets, KDReports and KDChart, the general style we'd want to mimic is:

#include <KDBindings/Signal.h>

Probably best implemented using forwarding headers as @winterz noted.

I'd stick with the .h file ending though. It's not all that common to leave this out, unless we want to mimic the standard library style...

@seanharmer
Copy link
Contributor Author

In KDUtils, KDGpu we have

#include <KDGpu/command_recorder.h>

for example. So camel cased lib name (to match the cmake target) and snake case header name with .h suffix mainly to make it easier to read.

@LeonMatthesKDAB
Copy link
Contributor

@seanharmer So the point is to only have the KDBindings folder name be capitalized? Not the individual files themselves?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants