diff --git a/doc/xternal.c b/doc/xternal.c index 78f605cc20..551d291d54 100644 --- a/doc/xternal.c +++ b/doc/xternal.c @@ -7868,7 +7868,9 @@ * These functions should follow the naming style `SCIP...`, e.g., SCIPcreateVar() or SCIPaddVarLocks. * - To ensure functions of the public API being reachable in shared libraries, their declaration needs to contain the SCIP_EXPORT attribute. * - Public types (typedef's, enumerations) are defined in file type_.h. - * Type names follow the style SCIP_.... + * Type names follow the style SCIP_.... For every struct, we have a typedef that shortens the name + * (so one could for instance use SCIP_PARAM instead of struct SCIP_Param). + * The convention is to have the mixed-casing for the struct name, and then all-capital for the typedef's type. Similar for enums. * - Structs that need to be accessed by several source files are defined in struct_.h. * struct_.h is usually included only by .c and maybe scip_.c. * Exceptions are due to manual inlining of functions via macros when compiling for optimized mode.