-
Notifications
You must be signed in to change notification settings - Fork 181
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
[core-c] removed ecal_ prefix of public API header files #1939
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think, if we're renaming them, we should think about what is consistent.
Personally, I would prefer a completely new include directory, like ecal_c
and then ecal_c/publisher.h
etc.
This naming would emphasize that the c binding is a separate entity altogether.
Should I apply this as well? |
Let's hear what @FlorianReimold and @Peguen say... |
Made a second commit renaming the c language ecal folder to ecalc. Lets decide which way to go. |
I would prefer ecal_c (it separates ecal and c better and is more visible). Dropping the cimpl from the header files as well would be nice, too, so we have |
We decided If we do this, we should also
These are my remarks 😄 |
That makes fully sense! |
lang/c/core/include/ecal_c/core.h
Outdated
* @brief eCAL core function c interface | ||
**/ | ||
|
||
#ifndef ecal_core_cimpl_h_included | ||
#define ecal_core_cimpl_h_included | ||
#ifndef core_h_included |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's keep canonical names here (including e.g. the folder structure), to avoid name clashes with other libraries (e.g. type_h_included
might be something different libraries might define...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
alternatively, we could just do #pragma once
where the compiler will do the right thing.
not sure how well defined this is for C compilers.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added folder structure (next commit) ..
lang/c/core/include/ecal_c/export.h
Outdated
@@ -18,12 +18,12 @@ | |||
*/ | |||
|
|||
/** | |||
* @file ecalc_export.h | |||
* @file export.h |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in c++ we kept the folder structure here (or did we?), maybe it makes sense here, too. @file ecal_c/export
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Next commit ..
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The file structure looks really good, but please see my other two comments.
Description
Removed the
ecal_
prefix of all C language header.